@salesforce/plugin-lightning-dev 3.1.1 → 3.2.0

package/README.md

@@ -140,6 +140,7 @@ yarn update-snapshots
 <!-- commands -->
 
 - [`sf lightning dev app`](#sf-lightning-dev-app)
+- [`sf lightning dev component`](#sf-lightning-dev-component)
 - [`sf lightning dev site`](#sf-lightning-dev-site)
 
 ## `sf lightning dev app`
@@ -200,7 +201,41 @@ EXAMPLES
     $ sf lightning dev app --target-org myOrg --device-type ios --device-id "iPhone 15 Pro Max"
 ```
 
-_See code: [src/commands/lightning/dev/app.ts](https://github.com/salesforcecli/plugin-lightning-dev/blob/3.1.1/src/commands/lightning/dev/app.ts)_
+_See code: [src/commands/lightning/dev/app.ts](https://github.com/salesforcecli/plugin-lightning-dev/blob/3.2.0/src/commands/lightning/dev/app.ts)_
+
+## `sf lightning dev component`
+
+Preview LWC components in isolation.
+
+```
+USAGE
+  $ sf lightning dev component -o <value> [--json] [--flags-dir <value>] [-n <value>]
+
+FLAGS
+  -n, --name=<value>        Description of a flag.
+  -o, --target-org=<value>  (required) Username or alias of the target org. Not required if the `target-org`
+                            configuration variable is already set.
+
+GLOBAL FLAGS
+  --flags-dir=<value>  Import flag values from a directory.
+  --json               Format output as json.
+
+DESCRIPTION
+  Preview LWC components in isolation.
+
+  Preview LWC components in isolation. Replacement for:
+  https://developer.salesforce.com/docs/platform/sfvscode-extensions/guide/lwclocaldev.html
+
+EXAMPLES
+  $ sf lightning dev component
+
+FLAG DESCRIPTIONS
+  -n, --name=<value>  Description of a flag.
+
+    More information about a flag. Don't repeat the summary.
+```
+
+_See code: [src/commands/lightning/dev/component.ts](https://github.com/salesforcecli/plugin-lightning-dev/blob/3.2.0/src/commands/lightning/dev/component.ts)_
 
 ## `sf lightning dev site`
 
@@ -254,6 +289,6 @@ EXAMPLES
     $ sf lightning dev site --name "Partner Central" --target-org myOrg --get-latest
 ```
 
-_See code: [src/commands/lightning/dev/site.ts](https://github.com/salesforcecli/plugin-lightning-dev/blob/3.1.1/src/commands/lightning/dev/site.ts)_
+_See code: [src/commands/lightning/dev/site.ts](https://github.com/salesforcecli/plugin-lightning-dev/blob/3.2.0/src/commands/lightning/dev/site.ts)_
 
 <!-- commandsstop -->

package/lib/commands/lightning/dev/component.d.ts

@@ -0,0 +1,14 @@
+import { SfCommand } from '@salesforce/sf-plugins-core';
+export type LightningDevComponentResult = {
+    path: string;
+};
+export default class LightningDevComponent extends SfCommand<LightningDevComponentResult> {
+    static readonly summary: string;
+    static readonly description: string;
+    static readonly examples: string[];
+    static readonly flags: {
+        name: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'target-org': import("@oclif/core/interfaces").OptionFlag<import("@salesforce/core").Org, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<LightningDevComponentResult>;
+}

package/lib/commands/lightning/dev/component.js

@@ -0,0 +1,41 @@
+/*
+ * 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 default class LightningDevComponent extends SfCommand {
+    static summary = messages.getMessage('summary');
+    static description = messages.getMessage('description');
+    static examples = messages.getMessages('examples');
+    static 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(),
+    };
+    async run() {
+        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: '',
+        };
+    }
+}
+//# sourceMappingURL=component.js.map

package/lib/commands/lightning/dev/component.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"component.js","sourceRoot":"","sources":["../../../../src/commands/lightning/dev/component.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEpC,QAAQ,CAAC,kCAAkC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,kCAAkC,EAAE,yBAAyB,CAAC,CAAC;AAMtG,MAAM,CAAC,OAAO,OAAO,qBAAsB,SAAQ,SAAsC;IAChF,MAAM,CAAU,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACzD,MAAM,CAAU,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IACjE,MAAM,CAAU,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAE5D,MAAM,CAAU,KAAK,GAAG;QAC7B,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC;YACjB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,oBAAoB,CAAC;YAClD,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,wBAAwB,CAAC;YAC1D,IAAI,EAAE,GAAG;YACT,QAAQ,EAAE,KAAK;SAChB,CAAC;QACF,4CAA4C;QAC5C,mGAAmG;QACnG,YAAY,EAAE,KAAK,CAAC,WAAW,EAAE;KAClC,CAAC;IAEK,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;QAE1D,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,IAAI,OAAO,CAAC;QACnC,IAAI,CAAC,GAAG,CAAC,sBAAsB,IAAI,EAAE,CAAC,CAAC;QAEvC,oBAAoB;QACpB,6DAA6D;QAC7D,MAAM,MAAM,CAAC;YACX,aAAa,EAAE,IAAI;SACpB,CAAC,CAAC;QAEH,OAAO;YACL,IAAI,EAAE,EAAE;SACT,CAAC;IACJ,CAAC"}

package/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 %>