@salesforce/plugin-templates 55.3.1 → 55.4.2

package/lib/utils/templateCommand.d.ts

@@ -1,15 +1,59 @@
-import { SfdxCommand } from '@salesforce/command';
+import { Ux } from '@salesforce/sf-plugins-core';
+import { ConfigAggregator } from '@salesforce/core';
+import { CreateOutput } from '@salesforce/templates';
 import { ForceGeneratorAdapter } from '@salesforce/templates/lib/utils';
-import { CreateOutput } from '@salesforce/templates/lib/utils/types';
-import { AnyJson } from '@salesforce/ts-types';
-import * as yeomanGenerator from 'yeoman-generator';
-export declare abstract class TemplateCommand extends SfdxCommand {
-    private static aggregator?;
-    static buildJson(adapter: ForceGeneratorAdapter, targetDir: string): CreateOutput;
-    static getDefaultApiVersion(): string;
-    static getApiVersion(): Promise<string>;
-    static getCustomTemplates(): Promise<string | undefined>;
-    private static getConfigAggregator;
-    runGenerator(generator: yeomanGenerator.GeneratorConstructor): Promise<{}>;
-    abstract run(): Promise<AnyJson>;
-}
+import VisualforceComponentGenerator from '@salesforce/templates/lib/generators/visualforceComponentGenerator';
+import VisualforcePageGenerator from '@salesforce/templates/lib/generators/visualforcePageGenerator';
+import ApexClassGenerator from '@salesforce/templates/lib/generators/apexClassGenerator';
+import LightningTestGenerator from '@salesforce/templates/lib/generators/lightningTestGenerator';
+import StaticResourceGenerator from '@salesforce/templates/lib/generators/staticResourceGenerator';
+import ProjectGenerator from '@salesforce/templates/lib/generators/projectGenerator';
+import LightningInterfaceGenerator from '@salesforce/templates/lib/generators/lightningInterfaceGenerator';
+import LightningAppGenerator from '@salesforce/templates/lib/generators/lightningAppGenerator';
+import LightningEventGenerator from '@salesforce/templates/lib/generators/lightningEventGenerator';
+import AnalyticsTemplateGenerator from '@salesforce/templates/lib/generators/analyticsTemplateGenerator';
+import LightningComponentGenerator from '@salesforce/templates/lib/generators/lightningComponentGenerator';
+import ApexTriggerGenerator from '@salesforce/templates/lib/generators/apexTriggerGenerator';
+export type generatorInputs = {
+    ux: Ux;
+    templates?: string;
+} & ({
+    generator: typeof VisualforcePageGenerator;
+    opts: typeof VisualforcePageGenerator.prototype.options;
+} | {
+    generator: typeof ApexClassGenerator;
+    opts: typeof ApexClassGenerator.prototype.options;
+} | {
+    generator: typeof ApexTriggerGenerator;
+    opts: typeof ApexTriggerGenerator.prototype.options;
+} | {
+    generator: typeof VisualforceComponentGenerator;
+    opts: typeof VisualforceComponentGenerator.prototype.options;
+} | {
+    generator: typeof LightningTestGenerator;
+    opts: typeof LightningTestGenerator.prototype.options;
+} | {
+    generator: typeof StaticResourceGenerator;
+    opts: typeof StaticResourceGenerator.prototype.options;
+} | {
+    generator: typeof ProjectGenerator;
+    opts: typeof ProjectGenerator.prototype.options;
+} | {
+    generator: typeof LightningInterfaceGenerator;
+    opts: typeof LightningInterfaceGenerator.prototype.options;
+} | {
+    generator: typeof LightningAppGenerator;
+    opts: typeof LightningAppGenerator.prototype.options;
+} | {
+    generator: typeof LightningEventGenerator;
+    opts: typeof LightningEventGenerator.prototype.options;
+} | {
+    generator: typeof AnalyticsTemplateGenerator;
+    opts: typeof AnalyticsTemplateGenerator.prototype.options;
+} | {
+    generator: typeof LightningComponentGenerator;
+    opts: typeof LightningComponentGenerator.prototype.options;
+});
+export declare function runGenerator({ ux, templates, generator, opts }: generatorInputs): Promise<CreateOutput>;
+export declare const getCustomTemplates: (configAggregator: ConfigAggregator) => string | undefined;
+export declare const buildJson: (adapter: ForceGeneratorAdapter, targetDir: string) => CreateOutput;

package/lib/utils/templateCommand.js

@@ -6,94 +6,54 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TemplateCommand = void 0;
+exports.buildJson = exports.getCustomTemplates = exports.runGenerator = void 0;
 const tslib_1 = require("tslib");
 const path = require("path");
-const command_1 = require("@salesforce/command");
 const core_1 = require("@salesforce/core");
 const templates_1 = require("@salesforce/templates");
 const utils_1 = require("@salesforce/templates/lib/utils");
 const yeoman = require("yeoman-environment");
-const messageUtil_1 = require("./messageUtil");
-class TemplateCommand extends command_1.SfdxCommand {
-    static buildJson(adapter, targetDir) {
-        const cleanOutput = adapter.log.getCleanOutput();
-        const rawOutput = `target dir = ${targetDir}\n${adapter.log.getOutput()}`;
-        const output = {
-            outputDir: targetDir,
-            created: cleanOutput,
-            rawOutput,
-        };
-        return output;
-    }
-    static getDefaultApiVersion() {
-        const packageJsonPath = path.join('..', '..', 'package.json');
-        // eslint-disable-next-line
-        const versionTrimmed = require(packageJsonPath).version.trim();
-        return `${versionTrimmed.split('.')[0]}.0`;
-    }
-    static getApiVersion() {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
-            try {
-                const aggregator = yield TemplateCommand.getConfigAggregator();
-                const apiVersionFromConfig = aggregator.getPropertyValue(core_1.SfdxPropertyKeys.API_VERSION);
-                return apiVersionFromConfig || TemplateCommand.getDefaultApiVersion();
-            }
-            catch (err) {
-                return TemplateCommand.getDefaultApiVersion();
-            }
-        });
-    }
-    static getCustomTemplates() {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
-            try {
-                const aggregator = yield TemplateCommand.getConfigAggregator();
-                // we're still accessing the old `customOrgMetadataTemplates` key, but this is deprecated and we'll use the new key to access the value
-                const customTemplatesFromConfig = aggregator.getPropertyValue(core_1.OrgConfigProperties.ORG_CUSTOM_METADATA_TEMPLATES);
-                return customTemplatesFromConfig;
-            }
-            catch (err) {
-                return undefined;
-            }
-        });
-    }
-    static getConfigAggregator() {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
-            if (!TemplateCommand.aggregator) {
-                TemplateCommand.aggregator = yield core_1.ConfigAggregator.create();
-            }
-            return TemplateCommand.aggregator;
-        });
+core_1.Messages.importMessagesDirectory(__dirname);
+const messages = core_1.Messages.loadMessages('@salesforce/plugin-templates', 'messages');
+function runGenerator({ ux, templates, generator, opts }) {
+    var _a;
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        if (templates) {
+            yield templates_1.TemplateService.getInstance().setCustomTemplatesRootPathOrGitRepo(templates);
+        }
+        const adapter = new utils_1.ForceGeneratorAdapter();
+        // @ts-expect-error the adapter doesn't fully implement the yeoman adapter interface
+        const env = yeoman.createEnv(undefined, undefined, adapter);
+        env.registerStub(generator, 'generator');
+        yield env.run('generator', opts);
+        const targetDir = path.resolve((_a = opts.outputdir) !== null && _a !== void 0 ? _a : '.');
+        ux.log(messages.getMessage('TargetDirOutput', [targetDir]));
+        ux.log(adapter.log.getOutput());
+        return (0, exports.buildJson)(adapter, targetDir);
+    });
+}
+exports.runGenerator = runGenerator;
+const getCustomTemplates = (configAggregator) => {
+    try {
+        // we're still accessing the old `customOrgMetadataTemplates` key, but this is deprecated and we'll use the new key to access the value
+        const customTemplatesFromConfig = configAggregator.getPropertyValue(core_1.OrgConfigProperties.ORG_CUSTOM_METADATA_TEMPLATES);
+        return customTemplatesFromConfig;
     }
-    // eslint-disable-next-line
-    runGenerator(generator) {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
-            // Can't specify a default value the normal way for apiversion, so set it here
-            if (!this.flags.apiversion) {
-                this.flags.apiversion = yield TemplateCommand.getApiVersion();
-            }
-            const customTemplates = yield TemplateCommand.getCustomTemplates();
-            if (customTemplates) {
-                yield templates_1.TemplateService.getInstance().setCustomTemplatesRootPathOrGitRepo(customTemplates);
-            }
-            const adapter = new utils_1.ForceGeneratorAdapter();
-            // @ts-ignore
-            const env = yeoman.createEnv(undefined, undefined, adapter);
-            env.registerStub(generator, 'generator');
-            // @ts-ignore env.run should have a callback param. This should all go away if switched to lib implementation
-            const result = yield env.run('generator', this.flags);
-            // eslint-disable-next-line
-            const targetDir = path.resolve(this.flags.outputdir);
-            if (this.flags.json) {
-                return TemplateCommand.buildJson(adapter, targetDir);
-            }
-            else {
-                this.log(messageUtil_1.MessageUtil.get('TargetDirOutput', [targetDir]));
-                this.log(adapter.log.getOutput());
-                return {};
-            }
-        });
+    catch (err) {
+        return undefined;
     }
-}
-exports.TemplateCommand = TemplateCommand;
+};
+exports.getCustomTemplates = getCustomTemplates;
+// exported for test
+const buildJson = (adapter, targetDir) => {
+    const cleanOutput = adapter.log.getCleanOutput();
+    const rawOutput = `target dir = ${targetDir}\n${adapter.log.getOutput()}`;
+    const output = {
+        outputDir: targetDir,
+        created: cleanOutput,
+        rawOutput,
+    };
+    return output;
+};
+exports.buildJson = buildJson;
 //# sourceMappingURL=templateCommand.js.map

package/lib/utils/templateCommand.js.map

@@ -1 +1 @@
-{"version":3,"file":"templateCommand.js","sourceRoot":"","sources":["../../src/utils/templateCommand.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;AAEH,6BAA6B;AAC7B,iDAAkD;AAClD,2CAA2F;AAC3F,qDAAwD;AACxD,2DAAwE;AAGxE,6CAA6C;AAG7C,+CAA4C;AAC5C,MAAsB,eAAgB,SAAQ,qBAAW;IAGhD,MAAM,CAAC,SAAS,CAAC,OAA8B,EAAE,SAAiB;QACvE,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC;QACjD,MAAM,SAAS,GAAG,gBAAgB,SAAS,KAAK,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,CAAC;QAC1E,MAAM,MAAM,GAAG;YACb,SAAS,EAAE,SAAS;YACpB,OAAO,EAAE,WAAW;YACpB,SAAS;SACV,CAAC;QACF,OAAO,MAAM,CAAC;IAChB,CAAC;IAEM,MAAM,CAAC,oBAAoB;QAChC,MAAM,eAAe,GAAW,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC;QACtE,2BAA2B;QAC3B,MAAM,cAAc,GAAW,OAAO,CAAC,eAAe,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QACvE,OAAO,GAAG,cAAc,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC7C,CAAC;IAEM,MAAM,CAAO,aAAa;;YAC/B,IAAI;gBACF,MAAM,UAAU,GAAG,MAAM,eAAe,CAAC,mBAAmB,EAAE,CAAC;gBAC/D,MAAM,oBAAoB,GAAG,UAAU,CAAC,gBAAgB,CAAC,uBAAgB,CAAC,WAAW,CAAW,CAAC;gBACjG,OAAO,oBAAoB,IAAI,eAAe,CAAC,oBAAoB,EAAE,CAAC;aACvE;YAAC,OAAO,GAAG,EAAE;gBACZ,OAAO,eAAe,CAAC,oBAAoB,EAAE,CAAC;aAC/C;QACH,CAAC;KAAA;IAEM,MAAM,CAAO,kBAAkB;;YACpC,IAAI;gBACF,MAAM,UAAU,GAAG,MAAM,eAAe,CAAC,mBAAmB,EAAE,CAAC;gBAC/D,uIAAuI;gBACvI,MAAM,yBAAyB,GAAG,UAAU,CAAC,gBAAgB,CAC3D,0BAAmB,CAAC,6BAA6B,CACxC,CAAC;gBACZ,OAAO,yBAAyB,CAAC;aAClC;YAAC,OAAO,GAAG,EAAE;gBACZ,OAAO,SAAS,CAAC;aAClB;QACH,CAAC;KAAA;IAEO,MAAM,CAAO,mBAAmB;;YACtC,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE;gBAC/B,eAAe,CAAC,UAAU,GAAG,MAAM,uBAAgB,CAAC,MAAM,EAAE,CAAC;aAC9D;YACD,OAAO,eAAe,CAAC,UAAU,CAAC;QACpC,CAAC;KAAA;IAED,2BAA2B;IACd,YAAY,CAAC,SAA+C;;YACvE,8EAA8E;YAC9E,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE;gBAC1B,IAAI,CAAC,KAAK,CAAC,UAAU,GAAG,MAAM,eAAe,CAAC,aAAa,EAAE,CAAC;aAC/D;YAED,MAAM,eAAe,GAAG,MAAM,eAAe,CAAC,kBAAkB,EAAE,CAAC;YACnE,IAAI,eAAe,EAAE;gBACnB,MAAM,2BAAe,CAAC,WAAW,EAAE,CAAC,mCAAmC,CAAC,eAAe,CAAC,CAAC;aAC1F;YAED,MAAM,OAAO,GAAG,IAAI,6BAAqB,EAAE,CAAC;YAC5C,aAAa;YACb,MAAM,GAAG,GAAG,MAAM,CAAC,SAAS,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;YAC5D,GAAG,CAAC,YAAY,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;YAEzC,6GAA6G;YAC7G,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;YACtD,2BAA2B;YAC3B,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YACrD,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE;gBACnB,OAAO,eAAe,CAAC,SAAS,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;aACtD;iBAAM;gBACL,IAAI,CAAC,GAAG,CAAC,yBAAW,CAAC,GAAG,CAAC,iBAAiB,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;gBAC1D,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC;gBAClC,OAAO,EAAE,CAAC;aACX;QACH,CAAC;KAAA;CAGF;AAlFD,0CAkFC"}
+{"version":3,"file":"templateCommand.js","sourceRoot":"","sources":["../../src/utils/templateCommand.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;AAEH,6BAA6B;AAE7B,2CAAmF;AACnF,qDAAsE;AACtE,2DAAwE;AACxE,6CAA6C;AAe7C,eAAQ,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;AAC5C,MAAM,QAAQ,GAAG,eAAQ,CAAC,YAAY,CAAC,8BAA8B,EAAE,UAAU,CAAC,CAAC;AAwDnF,SAAsB,YAAY,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,EAAmB;;;QACpF,IAAI,SAAS,EAAE;YACb,MAAM,2BAAe,CAAC,WAAW,EAAE,CAAC,mCAAmC,CAAC,SAAS,CAAC,CAAC;SACpF;QAED,MAAM,OAAO,GAAG,IAAI,6BAAqB,EAAE,CAAC;QAC5C,oFAAoF;QACpF,MAAM,GAAG,GAAG,MAAM,CAAC,SAAS,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QAC5D,GAAG,CAAC,YAAY,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;QAEzC,MAAM,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QACjC,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,MAAA,IAAI,CAAC,SAAS,mCAAI,GAAG,CAAC,CAAC;QAEtD,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAC5D,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC;QAChC,OAAO,IAAA,iBAAS,EAAC,OAAO,EAAE,SAAS,CAAC,CAAC;;CACtC;AAhBD,oCAgBC;AAEM,MAAM,kBAAkB,GAAG,CAAC,gBAAkC,EAAsB,EAAE;IAC3F,IAAI;QACF,uIAAuI;QACvI,MAAM,yBAAyB,GAAG,gBAAgB,CAAC,gBAAgB,CACjE,0BAAmB,CAAC,6BAA6B,CACxC,CAAC;QACZ,OAAO,yBAAyB,CAAC;KAClC;IAAC,OAAO,GAAG,EAAE;QACZ,OAAO,SAAS,CAAC;KAClB;AACH,CAAC,CAAC;AAVW,QAAA,kBAAkB,sBAU7B;AAEF,oBAAoB;AACb,MAAM,SAAS,GAAG,CAAC,OAA8B,EAAE,SAAiB,EAAgB,EAAE;IAC3F,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC;IACjD,MAAM,SAAS,GAAG,gBAAgB,SAAS,KAAK,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,CAAC;IAC1E,MAAM,MAAM,GAAG;QACb,SAAS,EAAE,SAAS;QACpB,OAAO,EAAE,WAAW;QACpB,SAAS;KACV,CAAC;IACF,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AATW,QAAA,SAAS,aASpB"}

package/messages/analyticsTemplate.md

@@ -0,0 +1,17 @@
+# summary
+
+Generate a simple Analytics template. 
+
+# description
+
+The metadata files associated with the Analytics template must be contained in a parent directory called "waveTemplates" in your package directory. Either run this command from an existing directory of this name, or use the --output-dir flag to generate one or point to an existing one. 
+
+# flags.name.summary
+
+Name of the Analytics template.
+
+# examples
+
+- Generate the metadata files for a simple Analytics template file called myTemplate in the force-app/main/default/waveTemplates directory:
+
+  <%= config.bin %> <%= command.id %> --name myTemplate --output-dir force-app/main/default/waveTemplates

package/messages/apexClass.md

@@ -0,0 +1,25 @@
+# summary
+
+Generate an Apex class.
+
+# description
+
+Generates the Apex *.cls file and associated metadata file. These files must be contained in a parent directory called "classes" in your package directory. Either run this command from an existing directory of this name, or use the --output-dir flag to generate one or point to an existing one. 
+
+# flags.name.summary
+
+Name of the generated Apex class.
+
+# flags.name.description
+
+The name can be up to 40 characters and must start with a letter.
+
+# examples
+
+- Generate two metadata files associated with the MyClass Apex class (MyClass.cls and MyClass.cls-meta.xml) in the current directory:
+
+  <%= config.bin %> <%= command.id %> --name MyClass
+
+- Similar to previous example, but generates the files in the "force-app/main/default/classes" directory:
+
+  <%= config.bin %> <%= command.id %> --name MyClass --output-dir force-app/main/default/classes

package/messages/apexTrigger.md

@@ -0,0 +1,40 @@
+# summary
+
+Generate an Apex trigger.
+
+# description
+
+Generates the Apex trigger *.trigger file and associated metadata file. These files must be contained in a parent directory called "triggers" in your package directory. Either run this command from an existing directory of this name, or use the --output-dir flag to generate one or point to an existing one. 
+
+If you don't specify the --sobject flag, the .trigger file contains the generic placeholder SOBJECT; replace it with the Salesforce object you want to generate a trigger for. If you don't specify --event, "before insert" is used. 
+
+# flags.event
+
+Events that fire the trigger.
+
+# flags.name
+
+Name of the generated Apex trigger
+
+# flags.name.description
+
+The name can be up to 40 characters and must start with a letter.
+
+# flags.sobject
+
+Salesforce object to generate a trigger on.
+
+# examples
+
+- Generate two files associated with the MyTrigger Apex trigger (MyTrigger.trigger and MyTrigger.trigger-meta.xml) in the current directory:
+
+  <%= config.bin %> <%= command.id %> --name MyTrigger
+
+- Similar to the previous example, but generate the files in the "force-app/main/default/triggers" directory:
+
+  <%= config.bin %> <%= command.id %> --name MyTrigger --output-dir force-app/main/default/triggers
+
+- Generate files for a trigger that fires on the Account object before and after an insert:
+
+  <%= config.bin %> <%= command.id %> --name MyTrigger --sobject Account --event "before insert,after insert"
+

package/messages/lightning.md

@@ -0,0 +1,27 @@
+# summary
+
+Generate a Lightning %s.
+
+# description
+
+Generates a Lightning %s bundle in the specified directory or the current working directory. The bundle consists of multiple files in a folder with the designated name.
+
+# flags.name
+
+Name of the generated Lightning %s.
+
+# flags.name.description
+
+The name can be up to 40 characters and must start with a letter.
+
+# flags.internal
+
+Generate lightning bundles without creating a -meta.xml file.
+
+# flags.template
+
+Template to use for file creation.
+
+# flags.template.description
+
+Supplied parameter values or default values are filled into a copy of the template.

package/messages/lightningApp.md

@@ -0,0 +1,9 @@
+# examples
+
+- Generate the metadata files for a Lightning app bundle called "myapp" in the current directory:
+
+  <%= config.bin %> <%= command.id %> --name myapp
+
+- Similar to the previous example, but generate the files in the "force-app/main/default/aura" directory:
+
+  <%= config.bin %> <%= command.id %> --name myapp --output-dir force-app/main/default/aura

package/messages/lightningCmp.md

@@ -0,0 +1,31 @@
+# examples
+
+- Generate the metadata files for an Aura component bundle in the current directory:
+
+  <%= config.bin %> <%= command.id %> --name mycomponent
+
+- Generate a Lightning web component bundle in the current directory:
+
+  <%= config.bin %> <%= command.id %> --name mycomponent --type lwc
+
+- Generate an Aura component bundle in the "force-app/main/default/aura" directory:
+
+  <%= config.bin %> <%= command.id %> --name mycomponent --output-dir force-app/main/default/aura
+
+- Generate a Lightning web component bundle in the "force-app/main/default/lwc" directory:
+
+  <%= config.bin %> <%= command.id %> --name mycomponent --type lwc --output-dir force-app/main/default/lwc
+
+# summary
+
+Generate a bundle for an Aura component or a Lightning web component.
+
+# description
+
+Generates the bundle in the specified directory or the current working directory. The bundle consists of multiple files in a directory with the designated name.  Lightning web components are contained in the directory with name "lwc", Aura components in "aura".
+
+To generate a Lightning web component, pass "--type lwc" to the command. If you don’t specify --type, Salesforce CLI generates an Aura component by default.
+
+# flags.type
+
+Type of the component bundle.

package/messages/lightningEvent.md

@@ -0,0 +1,9 @@
+# examples
+
+- Generate the metadata files for a Lightning event bundle called "myevent" in the current directory:
+
+  <%= config.bin %> <%= command.id %> --name myevent
+ 
+- Similar to previous example, but generate the files in the "force-app/main/default/aura" directory:
+
+  <%= config.bin %> <%= command.id %> --name myevent --output-dir force-app/main/default/aura

package/messages/lightningInterface.md

@@ -0,0 +1,9 @@
+# examples
+
+- Generate the metadata files for a Lightning interface bundle called "myinterface" in the current directory:
+
+  <%= config.bin %> <%= command.id %> --name myinterface
+
+- Similar to the previous example but generate the files in the "force-app/main/default/aura" directory:
+
+  <%= config.bin %> <%= command.id %> --name myinterface --output-dir force-app/main/default/aura

package/messages/lightningTest.md

@@ -0,0 +1,21 @@
+# examples
+
+- Generate the metadata files for the Lightning test called MyLightningTest in the current directory:
+
+  <%= config.bin %> <%= command.id %> --name MyLightningTest
+
+- Similar to the previous example but generate the files in the "force-app/main/default/lightningTests" directory:
+
+  <%= config.bin %> <%= command.id %> --name MyLightningTest --output-dir force-app/main/default/lightningTests
+
+# summary
+
+Generate a Lightning test.
+
+# description
+
+Generates the test in the specified directory or the current working directory. The .resource file and associated metadata file are generated.
+
+# flags.name.description
+
+Name of the new Lightning test; can be up to 40 characters and must start with a letter.

package/messages/messages.md

@@ -0,0 +1,43 @@
+# flags.outputdir
+
+Directory for saving the created files.
+
+# flags.outputdir.description
+
+The location can be an absolute path or relative to the current working directory. The default is the current directory.
+
+# flags.outputdirLighting.description
+
+If you don’t specify an outputdir, we create a subfolder in your current working directory with the name of your bundle. For example, if the current working directory is force-app and your Lightning bundle is called myBundle, we create force-app/myBundle/ to store the files in the bundle.
+
+# flags.template
+
+Template to use for file creation.
+
+# flags.template.description
+
+Supplied parameter values or default values are filled into a copy of the template.
+
+# TargetDirOutput
+
+target dir = %s
+
+# MissingAuraFolder
+
+Lightning bundles must have a parent folder named 'aura'.
+
+# MissingLightningComponentTemplate
+
+Template %s not available for component type %s.
+
+# MissingLWCFolder
+
+Lightning bundles must have a parent folder named 'lwc'.
+
+# InvalidTemplate
+
+Expected --template=foo to be one of:
+
+# StandardReadMe
+
+Now that you’ve created a Salesforce DX project, what’s next?

package/messages/project.md

@@ -0,0 +1,87 @@
+# summary
+
+Generate a Salesforce DX project.
+
+# description
+
+A Salesforce DX project has a specific structure and a configuration file (sfdx-project.json) that identifies the directory as a Salesforce DX project. This command generates the necessary configuration files and directories to get you started.
+
+By default, the generated sfdx-project.json file sets the sourceApiVersion property to the default API version currently used by Salesforce CLI. To specify a different version, set the apiVersion configuration variable. For example: "sf config set apiVersion=57.0 --global".
+
+# examples
+
+- Generate a project called "mywork":
+
+  <%= config.bin %> <%= command.id %> --name mywork
+
+- Similar to previous example, but generate the files in a directory called "myapp":
+
+  <%= config.bin %> <%= command.id %> --name mywork --default-package-dir myapp
+
+- Similar to prevoius example, but also generate a default package.xml manifest file:
+
+  <%= config.bin %> <%= command.id %> --name mywork --default-package-dir myapp --manifest
+
+- Generate a project with the minimum files and directories:
+
+  <%= config.bin %> <%= command.id %> --name mywork --template empty
+
+# flags.name
+
+Name of the generated project.
+
+# flags.name.description
+
+Generates a project directory with this name; any valid directory name is accepted. Also sets the "name" property in the sfdx-project.json file to this name.
+
+# flags.template
+
+Template to use for project creation.
+
+# flags.template.description
+
+The template determines the sample configuration files and directories that this command generates. For example, the empty template provides these files and directory to get you started.
+
+- .forceignore
+- config/project-scratch-def.json
+- sfdx-project.json
+- package.json
+- force-app (basic source directory structure)
+
+The standard template provides a complete force-app directory structure so you know where to put your source. It also provides additional files and scripts, especially useful when using Salesforce Extensions for VS Code. For example:
+
+- .gitignore: Use Git for version control.
+- .prettierrc and .prettierignore: Use Prettier to format your Aura components.
+- .vscode/extensions.json: When launched, Visual Studio Code, prompts you to install the recommended extensions for your project.
+- .vscode/launch.json: Configures Replay Debugger.
+- .vscode/settings.json: Additional configuration settings.
+
+The analytics template provides similar files and the force-app/main/default/waveTemplates directory.
+
+# flags.namespace
+
+Namespace associated with this project and any connected scratch orgs.
+
+# flags.packagedir
+
+Default package directory name.
+
+# flags.packagedir.description
+
+Metadata items such as classes and Lightning bundles are placed inside this folder.
+
+# flags.manifest
+
+Generate a manifest (package.xml) for change-set based development.
+
+# flags.manifest.description
+
+Generates a default manifest (package.xml) for fetching Apex, Visualforce, Lightning components, and static resources.
+
+# flags.loginurl
+
+Salesforce instance login URL.
+
+# flags.loginurl.description
+
+Normally defaults to https://login.salesforce.com.

package/messages/staticResource.md

@@ -0,0 +1,37 @@
+# summary
+
+Generate a static resource.
+
+# description
+
+Generates the metadata resource file in the specified directory or the current working directory. Static resource files must be contained in a parent directory called "staticresources" in your package directory. Either run this command from an existing directory of this name, or use the --output-dir flag to create one or point to an existing one.
+
+# examples
+
+- Generate the metadata file for a static resource called MyResource in the current directory:
+
+  <%= config.bin %> <%= command.id %> --name MyResource
+
+- Similar to previous example, but specifies a MIME type of application/json:
+
+  <%= config.bin %> <%= command.id %> --name MyResource --type application/json
+
+- Generate the resource file in the "force-app/main/default/staticresources" directory:
+
+  <%= config.bin %> <%= command.id %> --name MyResource --output-dir force-app/main/default/staticresources
+
+# flags.name.summary
+
+Name of the generated static resource.
+
+# flags.name.description
+
+This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.
+
+# flags.type.summary
+
+Content type (mime type) of the generated static resource.
+
+# flags.type.description
+
+Must be a valid MIME type such as application/json, application/javascript, application/zip, text/plain, text/css, etc.

package/messages/vf.md

@@ -0,0 +1,39 @@
+# summary
+
+Generate a Visualforce %s.
+
+# description
+
+The command generates the .%s file and associated metadata file in the specified directory or the current working directory by default.
+
+# flags.name
+
+Name of the generated Visualforce %s.
+
+# flags.name.description
+
+The name can be up to 40 characters and must start with a letter.
+
+# flags.label
+
+Visualforce %s label.
+
+# examples.component
+
+- Generate the metadata files for a Visualforce component in the current directory:
+
+  <%= config.bin %> <%= command.id %> --name mycomponent --label mylabel
+
+- Similar to previous example, but generate the files in the directory "force-app/main/default/components":
+
+  <%= config.bin %> <%= command.id %> --name mycomponent --label mylabel --output-dir components
+
+# examples.page
+
+- Generate the metadata files for a Visualforce page in the current directory:
+
+  <%= config.bin %> <%= command.id %> --name mypage --label mylabel
+
+- Similar to previous example, but generate the files in the directory "force-app/main/default/pages":
+
+  <%= config.bin %> <%= command.id %> --name mypage --label mylabel --output-dir pages