Removes 'spo folder rename' alias. Closes #5911

pnp · Aug 14, 2024 · e8cee2e · e8cee2e
1 parent b31b905
commit e8cee2e
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 31 deletions.
diff --git a/docs/docs/cmd/spo/folder/folder-set.mdx b/docs/docs/cmd/spo/folder/folder-set.mdx
@@ -10,12 +10,6 @@ Updates a folder
 m365 spo folder set [options]
 ```
 
-## Alias
-
-```sh
-m365 spo folder rename [options]
-```
-
 ## Options
 
 ```md definition-list

diff --git a/docs/docs/v9-upgrade-guidance.mdx b/docs/docs/v9-upgrade-guidance.mdx
@@ -149,6 +149,14 @@ In the past versions of CLI for Microsoft 365, the command had no output. When u
 
 When using the [spo file copy](./cmd/spo/file/file-copy.mdx) command, please use the new command input. This means that you'll have to remove option `--resetAuthorAndCreated` from your scripts and automation tools.
 
+### Removed 'spo folder rename' alias
+
+The `spo folder rename` command was removed and replaced by the [spo folder set](./cmd/spo/folder/folder-set.mdx) command.
+
+#### What action do I need to take?
+
+Please, update your scripts to use the `spo folder set` command instead of `spo folder rename`.
+
 ## SharePoint Framework
 
 ### Removed overwrite option from `spfx project github workflow add` command

diff --git a/src/m365/spo/commands.ts b/src/m365/spo/commands.ts
@@ -93,7 +93,6 @@ export default {
   FOLDER_LIST: `${prefix} folder list`,
   FOLDER_MOVE: `${prefix} folder move`,
   FOLDER_REMOVE: `${prefix} folder remove`,
-  FOLDER_RENAME: `${prefix} folder rename`,
   FOLDER_SET: `${prefix} folder set`,
   FOLDER_RETENTIONLABEL_ENSURE: `${prefix} folder retentionlabel ensure`,
   FOLDER_RETENTIONLABEL_REMOVE: `${prefix} folder retentionlabel remove`,

diff --git a/src/m365/spo/commands/folder/folder-set.spec.ts b/src/m365/spo/commands/folder/folder-set.spec.ts
@@ -12,7 +12,6 @@ import { pid } from '../../../../utils/pid.js';
 import { session } from '../../../../utils/session.js';
 import { sinonUtil } from '../../../../utils/sinonUtil.js';
 import commands from '../../commands.js';
-
 import command from './folder-set.js';
 
 describe(commands.FOLDER_SET, () => {
@@ -72,23 +71,6 @@ describe(commands.FOLDER_SET, () => {
     assert.notStrictEqual(command.description, null);
   });
 
-  it('defines correct alias', () => {
-    const alias = command.alias();
-    assert.deepStrictEqual(alias, [commands.FOLDER_RENAME]);
-  });
-
-  it('correctly logs deprecation warning for yammer command', async () => {
-    const chalk = (await import('chalk')).default;
-    const loggerErrSpy = sinon.spy(logger, 'logToStderr');
-    const commandNameStub = sinon.stub(cli, 'currentCommandName').value(commands.FOLDER_RENAME);
-    sinon.stub(request, 'patch').resolves();
-
-    await command.action(logger, { options: { webUrl: webUrl, url: folderRelServerUrl, name: newFolderName } });
-    assert.deepStrictEqual(loggerErrSpy.firstCall.firstArg, chalk.yellow(`Command '${commands.FOLDER_RENAME}' is deprecated. Please use '${commands.FOLDER_SET}' instead.`));
-
-    sinonUtil.restore([loggerErrSpy, commandNameStub]);
-  });
-
   it('renames folder correctly by using server relative URL', async () => {
     const patchStub = sinon.stub(request, 'patch').callsFake(async (opts) => {
       if (opts.url === `${webUrl}/_api/Web/GetFolderByServerRelativePath(DecodedUrl='${formatting.encodeQueryParameter(folderRelServerUrl)}')/ListItemAllFields`) {

diff --git a/src/m365/spo/commands/folder/folder-set.ts b/src/m365/spo/commands/folder/folder-set.ts
@@ -29,10 +29,6 @@ class SpoFolderSetCommand extends SpoCommand {
     return 'Updates a folder';
   }
 
-  public alias(): string[] | undefined {
-    return [commands.FOLDER_RENAME];
-  }
-
   constructor() {
     super();
 
@@ -99,8 +95,6 @@ class SpoFolderSetCommand extends SpoCommand {
 
   public async commandAction(logger: Logger, args: CommandArgs): Promise<void> {
     try {
-      await this.showDeprecationWarning(logger, this.alias()![0], this.name);
-
       if (this.verbose) {
         await logger.logToStderr(`Updating folder '${args.options.name}'...`);
       }