feat: rename lightning component bundles

packages/salesforcedx-vscode-core/package.json

@@ -304,6 +304,10 @@
         {
           "command": "sfdx.create.manifest",
           "when": "sfdx:project_opened"
+        },
+        {
+          "command": "sfdx.lightning.rename",
+          "when": "sfdx:project_opened && resource =~ /.*/(lwc|aura)/[^/]+(/[^/]+\\.(html|css|js|xml|svg|cmp|app|design|auradoc))?$/"
         }
       ],
       "commandPalette": [
@@ -447,6 +451,10 @@
           "command": "sfdx.create.manifest",
           "when": "false"
         },
+        {
+          "command": "sfdx.lightning.rename",
+          "when": "false"
+        },
         {
           "command": "sfdx.force.apex.trigger.create",
           "when": "sfdx:project_opened"
@@ -937,6 +945,10 @@
       {
         "command": "sfdx.force.launch.apex.replay.debugger.with.current.file",
         "title": "%force_launch_apex_replay_debugger_with_current_file%"
+      },
+      {
+        "command": "sfdx.lightning.rename",
+        "title": "%force_lightning_rename_component_text%"
       }
     ],
     "configuration": {

packages/salesforcedx-vscode-core/package.nls.json

@@ -27,6 +27,7 @@
   "force_lightning_interface_create_text": "SFDX: Create Aura Interface",
   "force_lightning_lwc_create_text": "SFDX: Create Lightning Web Component",
   "force_lightning_lwc_test_create_text": "SFDX: Create Lightning Web Component Test",
+  "force_lightning_rename_component_text": "SFDX: Rename Component (Files Only)",
   "force_source_status_local_text": "SFDX: View Local Changes",
   "force_source_status_remote_text": "SFDX: View Changes in Default Scratch Org",
   "force_debugger_stop_text": "SFDX: Stop Apex Debugger Session",

packages/salesforcedx-vscode-core/src/commands/forceRenameLightningComponent.ts

@@ -0,0 +1,140 @@
+/*
+ * Copyright (c) 2022, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+import { LibraryCommandletExecutor } from '@salesforce/salesforcedx-utils-vscode/out/src';
+import { notificationService } from '@salesforce/salesforcedx-utils-vscode/out/src/commands';
+import { ContinueResponse } from '@salesforce/salesforcedx-utils-vscode/src/types';
+import * as fs from 'fs';
+import * as path from 'path';
+import { format } from 'util';
+import * as vscode from 'vscode';
+import { OUTPUT_CHANNEL } from '../channels';
+import { nls } from '../messages';
+import { FilePathGatherer, SfdxCommandlet, SfdxWorkspaceChecker } from './util';
+
+const RENAME_LIGHTNING_COMPONENT_EXECUTOR = 'force_rename_lightning_component';
+const RENAME_INPUT_PLACEHOLDER = 'rename_component_input_placeholder';
+const RENAME_INPUT_PROMPT = 'rename_component_input_prompt';
+const RENAME_INPUT_DUP_ERROR = 'rename_component_input_dup_error';
+const RENAME_WARNING = 'rename_component_warning';
+
+export class RenameLwcComponentExecutor extends LibraryCommandletExecutor<string> {
+  private sourceFsPath: string;
+  private responseText: string | undefined;
+  constructor(sourceFsPath: string, responseText: string | undefined) {
+    super(
+      nls.localize(RENAME_LIGHTNING_COMPONENT_EXECUTOR),
+      RENAME_LIGHTNING_COMPONENT_EXECUTOR,
+      OUTPUT_CHANNEL
+    );
+    this.sourceFsPath = sourceFsPath;
+    this.responseText = responseText;
+  }
+
+  public async run(
+    response: ContinueResponse<string>,
+    progress?: vscode.Progress<{ message?: string | undefined; increment?: number | undefined; }>,
+    token?: vscode.CancellationToken
+    ): Promise<boolean> {
+      if (this.sourceFsPath) {
+        if (this.responseText) {
+          renameComponent(this.sourceFsPath, this.responseText);
+          return true;
+        }
+      }
+      return false;
+  }
+}
+
+export async function forceRenameLightningComponent(sourceUri: vscode.Uri) {
+  const sourceFsPath = sourceUri.fsPath;
+  const inputOptions = {
+    placeHolder: nls.localize(RENAME_INPUT_PLACEHOLDER),
+    promopt: nls.localize(RENAME_INPUT_PROMPT)
+  } as vscode.InputBoxOptions;
+
+  const responseText = await vscode.window.showInputBox(inputOptions);
+  if (sourceFsPath) {
+    const commandlet = new SfdxCommandlet(
+      new SfdxWorkspaceChecker(),
+      new FilePathGatherer(sourceUri),
+      new RenameLwcComponentExecutor(sourceFsPath, responseText)
+    );
+    await commandlet.run();
+  }
+}
+
+function renameComponent(sourceFsPath: string, newName: string) {
+  const componentPath = getComponentPath(sourceFsPath);
+  const componentName = path.basename(componentPath);
+  checkForDuplicateName(componentPath, newName);
+  const items = fs.readdirSync(componentPath);
+  for (const item of items) {
+    // only rename the file that has same name with component
+    if (isNameMatch(item, componentName, componentPath)) {
+      const newItem = item.replace(componentName, newName);
+      fs.renameSync(
+        path.join(componentPath, item),
+        path.join(componentPath, newItem)
+      );
+    }
+  }
+  const newComponentPath = path.join(path.dirname(componentPath), newName);
+  fs.renameSync(
+    componentPath,
+    newComponentPath
+  );
+  notificationService.showWarningMessage(nls.localize(RENAME_WARNING));
+}
+
+function getComponentPath(sourceFsPath: string): string {
+  const stats = fs.statSync(sourceFsPath);
+  return stats.isFile() ? path.dirname(sourceFsPath) : sourceFsPath;
+}
+
+function checkForDuplicateName(componentPath: string, newName: string) {
+  if (isDuplicate(componentPath, newName)) {
+    const errorMessage = nls.localize(RENAME_INPUT_DUP_ERROR);
+    notificationService.showErrorMessage(errorMessage);
+    throw new Error(format(errorMessage));
+  }
+}
+
+function isDuplicate(componentPath: string, newName: string): boolean {
+  // A LWC component can't share the same name as a Aura component
+  const componentPathDirName = path.dirname(componentPath);
+  let lwcPath: string;
+  let auraPath: string;
+  if (isLwcComponent(componentPath)) {
+    lwcPath = componentPathDirName;
+    auraPath = path.join(path.dirname(componentPathDirName), 'aura');
+  } else {
+    lwcPath = path.join(path.dirname(componentPathDirName), 'lwc');
+    auraPath = componentPathDirName;
+  }
+  const allLwcComponents = fs.readdirSync(lwcPath);
+  const allAuraComponents = fs.readdirSync(auraPath);
+  if (allLwcComponents.includes(newName) || allAuraComponents.includes(newName)) {
+    return true;
+  }
+  return false;
+}
+
+function isNameMatch(item: string, componentName: string, componentPath: string) {
+  const isLwc = isLwcComponent(componentPath);
+  let regularExp: RegExp;
+  if (isLwc) {
+    regularExp = new RegExp(`${componentName}\.(html|js|js-meta.xml|css|svg)`);
+  } else {
+    regularExp = new RegExp(`${componentName}(((Controller|Renderer|Helper)?\.js)|(\.(cmp|app|css|design|auradoc|svg)))`);
+  }
+  return item.match(regularExp) ? true : false;
+}
+
+function isLwcComponent(componentPath: string): boolean {
+  return path.basename(path.dirname(componentPath)) === 'lwc' ? true : false;
+}

packages/salesforcedx-vscode-core/src/commands/index.ts

@@ -170,3 +170,6 @@ export {
   forceRefreshSObjects,
   initSObjectDefinitions
 } from './forceRefreshSObjects';
+export {
+  forceRenameLightningComponent
+} from './forceRenameLightningComponent';

packages/salesforcedx-vscode-core/src/index.ts

@@ -47,6 +47,7 @@ import {
   forcePackageInstall,
   forceProjectWithManifestCreate,
   forceRefreshSObjects,
+  forceRenameLightningComponent,
   forceSfdxProjectCreate,
   forceSourceDelete,
   forceSourceDeployManifest,
@@ -426,6 +427,11 @@ function registerCommands(
     forceRefreshSObjects
   );
 
+  const forceRenameComponentCmd = vscode.commands.registerCommand(
+    'sfdx.lightning.rename',
+    forceRenameLightningComponent
+  );
+
   return vscode.Disposable.from(
     forceAuthAccessTokenCmd,
     forceAuthWebLoginCmd,

packages/salesforcedx-vscode-core/src/messages/i18n.ts

@@ -621,5 +621,10 @@ export const messages = {
   force_sobjects_refresh: 'SFDX: Refresh SObject Definitions',
   sobject_refresh_all: 'All SObjects',
   sobject_refresh_custom: 'Custom SObjects',
-  sobject_refresh_standard: 'Standard SObjects'
+  sobject_refresh_standard: 'Standard SObjects',
+  force_rename_lightning_component: 'SFDX: Rename Component (Files Only)',
+  rename_component_input_dup_error: 'Component name is already in use in LWC or Aura',
+  rename_component_input_placeholder: 'Enter a unique component name',
+  rename_component_input_prompt: 'Press Enter to confirm your input or Escape to cancel',
+  rename_component_warning: 'Warning: References to the old name will not be updated. Update manually and redeploy once all changes have been made.'
 };

packages/salesforcedx-vscode-core/test/vscode-integration/commands/forceRenameLightningComponent.test.ts

@@ -0,0 +1,160 @@
+import { notificationService } from '@salesforce/salesforcedx-utils-vscode/out/src/commands';
+import { expect } from 'chai';
+import * as fs from 'fs';
+import * as path from 'path';
+import * as sinon from 'sinon';
+import * as vscode from 'vscode';
+import {RenameLwcComponentExecutor} from '../../../src/commands/forceRenameLightningComponent';
+
+const lwcPath = vscode.Uri.parse('/force-app/main/default/lwc');
+const auraPath = vscode.Uri.parse('/force-app/main/default/aura/');
+const lwcComponent = 'hero';
+const auraComponent = 'page';
+const itemsInHero = ['_test_', 'hero.css', 'hero.html', 'hero.js', 'hero.js-meta.xml', 'templateOne.html'];
+const itemsInPage = ['_test_', 'page.auradoc', 'page.cmp', 'page.cmp-meta.xml', 'page.css', 'page.design', 'page.svg', 'pageController.js', 'pageHelper.js', 'pageRenderer.js', 'templateOne.css'];
+
+const env = sinon.createSandbox();
+let renameStub: sinon.SinonStub;
+let statStub: sinon.SinonStub;
+
+describe('Force Rename Lightning Component', () => {
+  describe('Happy Path Unit Test', () => {
+    beforeEach(() => {
+      renameStub = env.stub(fs, 'renameSync').returns(undefined);
+      statStub = env.stub(fs, 'statSync').returns({
+        isFile: () => {
+          return false;
+        }
+      });
+    });
+
+    afterEach(() => {
+      env.restore();
+    });
+
+    it('should rename the files and folder with new name under the same path', async () => {
+      const sourceUri = vscode.Uri.joinPath(lwcPath, lwcComponent);
+      env.stub(fs, 'readdirSync')
+        .onFirstCall().returns([])
+        .onSecondCall().returns([])
+        .onThirdCall().returns([itemsInHero[1]]);
+      const executor = new RenameLwcComponentExecutor(sourceUri.fsPath, 'hero1');
+      await executor.run({
+        type: 'CONTINUE',
+        data: ''
+      });
+      const oldFilePath = path.join(sourceUri.fsPath, 'hero.css');
+      const newFilePath = path.join(sourceUri.fsPath, 'hero1.css');
+      const newFolderPath = path.join(lwcPath.fsPath, 'hero1');
+      expect(renameStub.callCount).to.equal(2);
+      expect(renameStub.calledWith(oldFilePath, newFilePath)).to.equal(true);
+      expect(renameStub.calledWith(sourceUri.fsPath, newFolderPath)).to.equal(true);
+    });
+
+    it('should only rename the files and folder that have same name with LWC component', async () => {
+      const sourceUri = vscode.Uri.joinPath(lwcPath, lwcComponent);
+      env.stub(fs, 'readdirSync')
+      .onFirstCall().returns([])
+      .onSecondCall().returns([])
+      .onThirdCall().returns(itemsInHero);
+      const executor = new RenameLwcComponentExecutor(sourceUri.fsPath, 'hero1');
+      await executor.run({
+        type: 'CONTINUE',
+        data: ''
+      });
+      expect(renameStub.callCount).to.equal(5);
+    });
+
+    it('should only rename the files and folder that have same name with Aura component', async () => {
+      const sourceUri = vscode.Uri.joinPath(auraPath, auraComponent);
+      env.stub(fs, 'readdirSync')
+      .onFirstCall().returns([])
+      .onSecondCall().returns([])
+      .onThirdCall().returns(itemsInPage);
+      const executor = new RenameLwcComponentExecutor(sourceUri.fsPath, 'page1');
+      await executor.run({
+        type: 'CONTINUE',
+        data: ''
+      });
+      expect(renameStub.callCount).to.equal(10);
+    });
+
+    it('should show the warning message once rename is done', async () => {
+      const sourceUri = vscode.Uri.joinPath(lwcPath, lwcComponent);
+      env.stub(fs, 'readdirSync')
+      .onFirstCall().returns([])
+      .onSecondCall().returns([])
+      .onThirdCall().returns([itemsInHero[1]]);
+      const warningSpy = env.spy(notificationService, 'showWarningMessage');
+      const executor = new RenameLwcComponentExecutor(sourceUri.fsPath, 'hero1');
+      await executor.run({
+        type: 'CONTINUE',
+        data: ''
+      });
+      expect(warningSpy.callCount).to.equal(1);
+    });
+  });
+
+  describe('Exception handling', () => {
+    beforeEach(() => {
+      renameStub = env.stub(fs, 'renameSync').returns(undefined);
+      statStub = env.stub(fs, 'statSync').returns({
+        isFile: () => {
+          return false;
+        }
+      });
+    });
+
+    afterEach(() => {
+      env.restore();
+    });
+
+    it('should not rename when input text is empty', async () => {
+      const sourceUri = vscode.Uri.joinPath(lwcPath, lwcComponent);
+      env.stub(fs, 'readdirSync')
+        .onFirstCall().returns([])
+        .onSecondCall().returns([])
+        .onThirdCall().returns([itemsInHero[1]]);
+      const executor = new RenameLwcComponentExecutor(sourceUri.fsPath, undefined);
+      await executor.run({
+        type: 'CONTINUE',
+        data: ''
+      });
+      expect(renameStub.callCount).to.equal(0);
+    });
+
+    it('should not show warning message when input text is empty', async () => {
+      const sourceUri = vscode.Uri.joinPath(lwcPath, lwcComponent);
+      env.stub(fs, 'readdirSync')
+      .onFirstCall().returns([])
+      .onSecondCall().returns([])
+      .onThirdCall().returns([itemsInHero[1]]);
+      const warningSpy = env.spy(notificationService, 'showWarningMessage');
+      const executor = new RenameLwcComponentExecutor(sourceUri.fsPath, undefined);
+      await executor.run({
+        type: 'CONTINUE',
+        data: ''
+      });
+      expect(warningSpy.callCount).to.equal(0);
+    });
+
+    it('should enforce unique component name under LWC and Aura and show error message for duplicate name', async () => {
+      const sourceUri = vscode.Uri.joinPath(lwcPath, lwcComponent);
+      env.stub(fs, 'readdirSync')
+       .onFirstCall().returns([lwcComponent])
+       .onSecondCall().returns([]);
+      let exceptionThrown = false;
+      try {
+        const executor = new RenameLwcComponentExecutor(sourceUri.fsPath, 'hero');
+        await executor.run({
+          type: 'CONTINUE',
+          data: ''
+        });
+      } catch (e) {
+        exceptionThrown = true;
+      }
+      expect(exceptionThrown).to.equal(true);
+      expect(renameStub.callCount).to.equal(0);
+    });
+  });
+});