feat: scaffolding for single component preview command @W-17803218 (#336)

Author: nrkruk

command-snapshot.json

@@ -7,6 +7,14 @@
     "flags": ["device-id", "device-type", "flags-dir", "name", "target-org"],
     "plugin": "@salesforce/plugin-lightning-dev"
   },
+  {
+    "alias": [],
+    "command": "lightning:dev:component",
+    "flagAliases": [],
+    "flagChars": ["n", "o"],
+    "flags": ["flags-dir", "json", "name", "target-org"],
+    "plugin": "@salesforce/plugin-lightning-dev"
+  },
   {
     "alias": [],
     "command": "lightning:dev:site",

messages/lightning.dev.component.md

@@ -0,0 +1,19 @@
+# summary
+
+Preview LWC components in isolation.
+
+# description
+
+Preview LWC components in isolation. Replacement for: https://developer.salesforce.com/docs/platform/sfvscode-extensions/guide/lwclocaldev.html
+
+# flags.name.summary
+
+Description of a flag.
+
+# flags.name.description
+
+More information about a flag. Don't repeat the summary.
+
+# examples
+
+- <%= config.bin %> <%= command.id %>

package.json

@@ -9,7 +9,7 @@
     "@inquirer/select": "^2.4.7",
     "@lwc/lwc-dev-server": "~11.5.0",
     "@lwc/sfdc-lwc-compiler": "~11.5.0",
-    "@lwrjs/api": "0.16.4",
+    "@lwrjs/api": "0.16.6",
     "@oclif/core": "^4.1.0",
     "@salesforce/core": "^8.6.2",
     "@salesforce/kit": "^3.1.6",

src/commands/lightning/dev/component.ts

@@ -0,0 +1,52 @@
+/*
+ * Copyright (c) 2023, 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 { SfCommand, Flags } from '@salesforce/sf-plugins-core';
+import { Messages } from '@salesforce/core';
+import { cmpDev } from '@lwrjs/api';
+
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
+const messages = Messages.loadMessages('@salesforce/plugin-lightning-dev', 'lightning.dev.component');
+
+export type LightningDevComponentResult = {
+  path: string;
+};
+
+export default class LightningDevComponent extends SfCommand<LightningDevComponentResult> {
+  public static readonly summary = messages.getMessage('summary');
+  public static readonly description = messages.getMessage('description');
+  public static readonly examples = messages.getMessages('examples');
+
+  public static readonly flags = {
+    name: Flags.string({
+      summary: messages.getMessage('flags.name.summary'),
+      description: messages.getMessage('flags.name.description'),
+      char: 'n',
+      required: false,
+    }),
+    // TODO should this be required or optional?
+    // We don't technically need this if your components are simple / don't need any data from your org
+    'target-org': Flags.requiredOrg(),
+  };
+
+  public async run(): Promise<LightningDevComponentResult> {
+    const { flags } = await this.parse(LightningDevComponent);
+
+    const name = flags.name ?? 'world';
+    this.log(`preview component: ${name}`);
+
+    // TODO implement me
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-call
+    await cmpDev({
+      componentName: name,
+    });
+
+    return {
+      path: '',
+    };
+  }
+}

test/commands/lightning/dev/component.nut.ts

@@ -0,0 +1,30 @@
+/*
+ * Copyright (c) 2023, 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
+ */
+// TODO - add proper NUT tests
+/*
+import { execCmd, TestSession } from '@salesforce/cli-plugins-testkit';
+import { expect } from 'chai';
+
+describe('lightning preview component NUTs', () => {
+  let session: TestSession;
+
+  before(async () => {
+    session = await TestSession.create({ devhubAuthStrategy: 'NONE' });
+  });
+
+  after(async () => {
+    await session?.clean();
+  });
+
+  it('should display provided name', () => {
+    const name = 'World';
+    const command = `lightning preview component --name ${name}`;
+    const output = execCmd(command, { ensureExitCode: 0 }).shellOutput.stdout;
+    expect(output).to.contain(name);
+  });
+});
+*/

test/commands/lightning/dev/component.test.ts

@@ -0,0 +1,24 @@
+/*
+ * Copyright (c) 2023, 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 { TestContext } from '@salesforce/core/testSetup';
+// import { expect } from 'chai';
+// import { stubSfCommandUx } from '@salesforce/sf-plugins-core';
+
+describe('lightning single component preview', () => {
+  const $$ = new TestContext();
+  // let sfCommandStubs: ReturnType<typeof stubSfCommandUx>;
+
+  beforeEach(() => {
+    // sfCommandStubs = stubSfCommandUx($$.SANDBOX);
+  });
+
+  afterEach(() => {
+    $$.restore();
+  });
+
+  it('todo add unit tests', async () => {});
+});