chore: rename preview to dev (#127)

nrkruk · web-flow · commit 23cc45de5362 · 2024-08-08T17:02:19.000-04:00
diff --git a/README.md b/README.md
@@ -23,13 +23,13 @@ sf org login web --instance-url ${orgfarmUrl}
 Then run the following for your environment:
 
 ```bash
-./bin/dev.js lightning preview site
+./bin/dev.js lightning dev site
 ```
 
 or for debugging:
 
 ```bash
-NODE_OPTIONS='--inspect-brk' ./bin/dev.js lightning preview site
+NODE_OPTIONS='--inspect-brk' ./bin/dev.js lightning dev site
 ```
 
 No need to recompile or watch typescript files as this happens automagically.
diff --git a/command-snapshot.json b/command-snapshot.json
@@ -1,15 +1,15 @@
 [
   {
     "alias": [],
-    "command": "lightning:preview:app",
+    "command": "lightning:dev:app",
     "flagAliases": [],
     "flagChars": ["i", "n", "o", "t"],
     "flags": ["device-id", "device-type", "flags-dir", "json", "name", "target-org"],
     "plugin": "@salesforce/plugin-lightning-dev"
   },
   {
     "alias": [],
-    "command": "lightning:preview:site",
+    "command": "lightning:dev:site",
     "flagAliases": [],
     "flagChars": ["n", "o"],
     "flags": ["debug", "flags-dir", "json", "name", "target-org"],
diff --git a/messages/lightning.dev.app.md b/messages/lightning.dev.app.md
diff --git a/messages/lightning.dev.site.md b/messages/lightning.dev.site.md
diff --git a/package.json b/package.json
@@ -69,7 +69,7 @@
       "lightning": {
         "external": true,
         "subtopics": {
-          "preview": {
+          "dev": {
             "description": "Preview applications and sites locally and in real-time, without deploying them."
           }
         }
diff --git a/schemas/lightning-dev-site.json b/schemas/lightning-dev-site.json
@@ -1,8 +1,8 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$ref": "#/definitions/LightningPreviewSiteResult",
+  "$ref": "#/definitions/LightningDevSiteResult",
   "definitions": {
-    "LightningPreviewSiteResult": {
+    "LightningDevSiteResult": {
       "type": "object",
       "properties": {
         "path": {
diff --git a/src/commands/lightning/dev/app.ts b/src/commands/lightning/dev/app.ts
@@ -24,7 +24,7 @@ import { PreviewUtils } from '../../../shared/previewUtils.js';
 import { ConfigUtils, IdentityTokenService } from '../../../shared/configUtils.js';
 
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
-const messages = Messages.loadMessages('@salesforce/plugin-lightning-dev', 'lightning.preview.app');
+const messages = Messages.loadMessages('@salesforce/plugin-lightning-dev', 'lightning.dev.app');
 
 export const iOSSalesforceAppPreviewConfig = {
   name: 'Salesforce Mobile App',
@@ -55,7 +55,7 @@ class AppServerIdentityTokenService implements IdentityTokenService {
   }
 }
 
-export default class LightningPreviewApp extends SfCommand<void> {
+export default class LightningDevApp extends SfCommand<void> {
   public static readonly summary = messages.getMessage('summary');
   public static readonly description = messages.getMessage('description');
   public static readonly examples = messages.getMessages('examples');
@@ -155,11 +155,11 @@ export default class LightningPreviewApp extends SfCommand<void> {
     // eslint-disable-next-line no-console
     console.log(message);
 
-    return LightningPreviewApp.waitForKeyPress();
+    return LightningDevApp.waitForKeyPress();
   }
 
   public async run(): Promise<void> {
-    const { flags } = await this.parse(LightningPreviewApp);
+    const { flags } = await this.parse(LightningDevApp);
     const logger = await Logger.child(this.ctor.name);
 
     const appName = flags['name'];
diff --git a/src/commands/lightning/dev/site.ts b/src/commands/lightning/dev/site.ts
@@ -13,13 +13,13 @@ import { PromptUtils } from '../../../shared/prompt.js';
 import { OrgUtils } from '../../../shared/orgUtils.js';
 
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
-const messages = Messages.loadMessages('@salesforce/plugin-lightning-dev', 'lightning.preview.site');
+const messages = Messages.loadMessages('@salesforce/plugin-lightning-dev', 'lightning.dev.site');
 
-export type LightningPreviewSiteResult = {
+export type LightningDevSiteResult = {
   path: string;
 };
 
-export default class LightningPreviewSite extends SfCommand<LightningPreviewSiteResult> {
+export default class LightningDevSite extends SfCommand<LightningDevSiteResult> {
   public static readonly summary = messages.getMessage('summary');
   public static readonly description = messages.getMessage('description');
   public static readonly examples = messages.getMessages('examples');
@@ -36,8 +36,8 @@ export default class LightningPreviewSite extends SfCommand<LightningPreviewSite
     'target-org': Flags.optionalOrg({ summary: messages.getMessage('flags.target-org.summary') }),
   };
 
-  public async run(): Promise<LightningPreviewSiteResult> {
-    const { flags } = await this.parse(LightningPreviewSite);
+  public async run(): Promise<LightningDevSiteResult> {
+    const { flags } = await this.parse(LightningDevSite);
     // Connect to Org
     const connection = flags['target-org'].getConnection();
 
@@ -112,9 +112,9 @@ export default class LightningPreviewSite extends SfCommand<LightningPreviewSite
       mrtBundleRoot: siteDir,
     });
     // const name = flags.name ?? 'world';
-    // this.log(`hello ${name} from /Users/nkruk/git/plugin-lightning-dev/src/commands/lightning/preview/site.ts`);
+    // this.log(`hello ${name} from /Users/nkruk/git/plugin-lightning-dev/src/commands/lightning/dev/site.ts`);
     return {
-      path: '/Users/nkruk/git/plugin-lightning-dev/src/commands/lightning/preview/site.ts',
+      path: '/Users/nkruk/git/plugin-lightning-dev/src/commands/lightning/dev/site.ts',
     };
   }
 }
diff --git a/src/shared/previewUtils.ts b/src/shared/previewUtils.ts
@@ -6,7 +6,7 @@
  */
 
 // **********************************************************************************************
-// * TODO: When we finalize the implementation for the preview commands and things settle down, *
+// * TODO: When we finalize the implementation for the dev commands and things settle down, *
 // *       consider moving most of these into PreviewUtils of lwc-dev-mobile-core instead.      *
 // **********************************************************************************************
 
@@ -34,7 +34,7 @@ import fetch from 'node-fetch';
 import { ConfigUtils, LOCAL_DEV_SERVER_DEFAULT_HTTP_PORT } from './configUtils.js';
 
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
-const messages = Messages.loadMessages('@salesforce/plugin-lightning-dev', 'lightning.preview.app');
+const messages = Messages.loadMessages('@salesforce/plugin-lightning-dev', 'lightning.dev.app');
 const DevPreviewAuraMode = 'DEVPREVIEW';
 
 export class PreviewUtils {
diff --git a/test/commands/lightning/dev/app.nut.ts b/test/commands/lightning/dev/app.nut.ts
@@ -9,7 +9,7 @@
 import { execCmd, TestSession } from '@salesforce/cli-plugins-testkit';
 import { expect } from 'chai';
 
-describe('lightning preview org NUTs', () => {
+describe('lightning dev org NUTs', () => {
   let session: TestSession;
 
   before(async () => {
@@ -22,7 +22,7 @@ describe('lightning preview org NUTs', () => {
 
   it('should display provided name', () => {
     const name = 'World';
-    const command = `lightning preview org --name ${name}`;
+    const command = `lightning dev org --name ${name}`;
     const output = execCmd(command, { ensureExitCode: 0 }).shellOutput.stdout;
     expect(output).to.contain(name);
   });
diff --git a/test/commands/lightning/dev/app.test.ts b/test/commands/lightning/dev/app.test.ts
@@ -19,18 +19,18 @@ import { stubSpinner, stubUx } from '@salesforce/sf-plugins-core';
 import { expect } from 'chai';
 import esmock from 'esmock';
 import sinon from 'sinon';
-import LightningPreviewApp, {
+import LightningDevApp, {
   androidSalesforceAppPreviewConfig,
   iOSSalesforceAppPreviewConfig,
-} from '../../../../src/commands/lightning/preview/app.js';
+} from '../../../../src/commands/lightning/dev/app.js';
 import { OrgUtils } from '../../../../src/shared/orgUtils.js';
 import { PreviewUtils } from '../../../../src/shared/previewUtils.js';
 import { ConfigUtils, LocalWebServerIdentityData } from '../../../../src/shared/configUtils.js';
 
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 
-describe('lightning preview app', () => {
-  const messages = Messages.loadMessages('@salesforce/plugin-lightning-dev', 'lightning.preview.app');
+describe('lightning dev app', () => {
+  const messages = Messages.loadMessages('@salesforce/plugin-lightning-dev', 'lightning.dev.app');
   const $$ = new TestContext();
   const testOrgData = new MockTestOrgData();
   const testAppId = '06m8b000002vpFSAAY';
@@ -51,7 +51,7 @@ describe('lightning preview app', () => {
     '34'
   );
   const testEmulatorPort = 1234;
-  let MockedLightningPreviewApp: typeof LightningPreviewApp;
+  let MockedLightningPreviewApp: typeof LightningDevApp;
 
   const fakeIdentityToken = 'PFT1vw8v65aXd2b9HFvZ3Zu4OcKZwjI60bq7BEjj5k4=';
   const fakeEntityId = '1I9xx0000004ClkCAE';
@@ -73,14 +73,11 @@ describe('lightning preview app', () => {
     $$.SANDBOX.stub(SfConfig.prototype, 'write').resolves();
     $$.SANDBOX.stub(ConfigUtils, 'getOrCreateIdentityToken').resolves(fakeIdentityToken);
 
-    MockedLightningPreviewApp = await esmock<typeof LightningPreviewApp>(
-      '../../../../src/commands/lightning/preview/app.js',
-      {
-        '../../../../src/lwc-dev-server/index.js': {
-          startLWCServer: async () => ({ stopServer: () => {} }),
-        },
-      }
-    );
+    MockedLightningPreviewApp = await esmock<typeof LightningDevApp>('../../../../src/commands/lightning/dev/app.js', {
+      '../../../../src/lwc-dev-server/index.js': {
+        startLWCServer: async () => ({ stopServer: () => {} }),
+      },
+    });
   });
 
   afterEach(() => {
@@ -120,7 +117,7 @@ describe('lightning preview app', () => {
     }
   });
 
-  describe('desktop preview', () => {
+  describe('desktop dev', () => {
     it('runs org:open with proper flags when app name provided', async () => {
       await verifyOrgOpen(`lightning/app/${testAppId}`, 'Sales');
     });
@@ -154,7 +151,7 @@ describe('lightning preview app', () => {
     }
   });
 
-  describe('mobile preview', () => {
+  describe('mobile dev', () => {
     it('throws when environment setup requirements are not met', async () => {
       $$.SANDBOX.stub(OrgUtils, 'getAppId').resolves(testAppId);
       $$.SANDBOX.stub(PreviewUtils, 'generateWebSocketUrlForLocalDevServer').returns(testServerUrl);
diff --git a/test/commands/lightning/dev/site.nut.ts b/test/commands/lightning/dev/site.nut.ts
@@ -9,7 +9,7 @@
 import { TestSession } from '@salesforce/cli-plugins-testkit';
 import { expect } from 'chai';
 
-describe('lightning preview site NUTs', () => {
+describe('lightning dev site NUTs', () => {
   let session: TestSession;
 
   before(async () => {
@@ -22,7 +22,7 @@ describe('lightning preview site NUTs', () => {
 
   it('should display provided name', () => {
     const name = 'World';
-    const command = `lightning preview site --name ${name}`;
+    const command = `lightning dev site --name ${name}`;
     const output = execCmd(command, { ensureExitCode: 0 }).shellOutput.stdout;
     expect(output).to.contain(name);
   });
diff --git a/test/commands/lightning/dev/site.test.ts b/test/commands/lightning/dev/site.test.ts
@@ -7,10 +7,10 @@
 import { TestContext } from '@salesforce/core/testSetup';
 // import { expect } from 'chai';
 // import { stubSfCommandUx } from '@salesforce/sf-plugins-core';
-// import LightningPreviewSite from '../../../../src/commands/lightning/preview/site.js';
+// import LightningDevSite from '../../../../src/commands/lightning/dev/site.js';
 
 // TODO fix me once we have a fully working command
-describe('lightning preview site', () => {
+describe('lightning dev site', () => {
   const $$ = new TestContext();
   // let sfCommandStubs: ReturnType<typeof stubSfCommandUx>;
 
@@ -23,7 +23,7 @@ describe('lightning preview site', () => {
   });
 
   it('runs hello', async () => {
-    // await LightningPreviewSite.run([]);
+    // await LightningDevSite.run([]);
     // const output = sfCommandStubs.log
     //   .getCalls()
     //   .flatMap((c) => c.args)
@@ -32,12 +32,12 @@ describe('lightning preview site', () => {
   });
 
   it('runs hello with --json and no provided name', async () => {
-    // const result = await LightningPreviewSite.run([]);
-    // expect(result.path).to.equal('/Users/nkruk/git/plugin-lightning-dev/src/commands/lightning/preview/site.ts');
+    // const result = await LightningDevSite.run([]);
+    // expect(result.path).to.equal('/Users/nkruk/git/plugin-lightning-dev/src/commands/lightning/dev/site.ts');
   });
 
   it('runs hello world --name Astro', async () => {
-    // await LightningPreviewSite.run(['--name', 'Astro']);
+    // await LightningDevSite.run(['--name', 'Astro']);
     // const output = sfCommandStubs.log
     //   .getCalls()
     //   .flatMap((c) => c.args)
diff --git a/test/shared/previewUtils.test.ts b/test/shared/previewUtils.test.ts
@@ -28,10 +28,10 @@ import { PreviewUtils } from '../../src/shared/previewUtils.js';
 import {
   iOSSalesforceAppPreviewConfig,
   androidSalesforceAppPreviewConfig,
-} from '../../src/commands/lightning/preview/app.js';
+} from '../../src/commands/lightning/dev/app.js';
 
 describe('previewUtils', () => {
-  const messages = Messages.loadMessages('@salesforce/plugin-lightning-dev', 'lightning.preview.app');
+  const messages = Messages.loadMessages('@salesforce/plugin-lightning-dev', 'lightning.dev.app');
   const $$ = new TestContext();
 
   const testIOSDevice = new IOSSimulatorDevice(

Original file line number	Diff line number	Diff line change
`@@ -1,15 +1,15 @@`
`1`	`1`	`[`
`2`	`2`	`{`
`3`	`3`	`"alias": [],`
`4`		`- "command": "lightning:preview:app",`
	`4`	`+ "command": "lightning:dev:app",`
`5`	`5`	`"flagAliases": [],`
`6`	`6`	`"flagChars": ["i", "n", "o", "t"],`
`7`	`7`	`"flags": ["device-id", "device-type", "flags-dir", "json", "name", "target-org"],`
`8`	`8`	`"plugin": "@salesforce/plugin-lightning-dev"`
`9`	`9`	`},`
`10`	`10`	`{`
`11`	`11`	`"alias": [],`
`12`		`- "command": "lightning:preview:site",`
	`12`	`+ "command": "lightning:dev:site",`
`13`	`13`	`"flagAliases": [],`
`14`	`14`	`"flagChars": ["n", "o"],`
`15`	`15`	`"flags": ["debug", "flags-dir", "json", "name", "target-org"],`
Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,7 @@`
`69`	`69`	`"lightning": {`
`70`	`70`	`"external": true,`
`71`	`71`	`"subtopics": {`
`72`		`- "preview": {`
	`72`	`+ "dev": {`
`73`	`73`	`"description": "Preview applications and sites locally and in real-time, without deploying them."`
`74`	`74`	`}`
`75`	`75`	`}`