@salesforce/plugin-command-reference 3.1.106 → 3.1.108

package/lib/markdown/toc.js

@@ -0,0 +1,68 @@
+/*
+ * Copyright 2026, Salesforce, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { MarkdownBase } from './markdown-base.js';
+const STATE_LABELS = {
+    beta: 'Beta',
+    preview: 'Developer Preview',
+    closedPilot: 'Closed Pilot',
+    openPilot: 'Open Pilot',
+    deprecated: 'Deprecated',
+};
+export class MarkdownToc extends MarkdownBase {
+    topicEntries;
+    constructor(topicEntries, outputDir) {
+        super('sfclireference-toc.yml', outputDir);
+        this.topicEntries = topicEntries;
+    }
+    static file() {
+        return 'sfclireference-toc.yml';
+    }
+    // eslint-disable-next-line class-methods-use-this
+    generate() {
+        const lines = [
+            '- title: Salesforce CLI Command Reference',
+            '  link: cli_reference.md',
+            '- title: Release Notes',
+            '  link: cli_reference_release_notes.md',
+            '- title: Deprecation Policy',
+            '  link: cli_reference_deprecation.md',
+        ];
+        const sorted = [...this.topicEntries].sort((a, b) => a.topic.localeCompare(b.topic));
+        for (const { topic, commandIds } of sorted) {
+            lines.push(`- title: ${topic} Commands`);
+            lines.push(`  link: ${topic}/cli_reference_${topic}.md`);
+            lines.push('  topics:');
+            for (const { id, state, deprecated } of [...commandIds].sort((a, b) => a.id.localeCompare(b.id))) {
+                const commandWithUnderscores = id.replace(/:/g, '_');
+                const commandWithSpaces = id.replace(/:/g, ' ');
+                const stateLabel = deprecated
+                    ? ' (Deprecated)'
+                    : state && STATE_LABELS[state]
+                        ? ` (${STATE_LABELS[state]})`
+                        : '';
+                const isTopicLevelCommand = !id.includes(':');
+                const linkTarget = isTopicLevelCommand
+                    ? `cli_reference_${commandWithUnderscores}_command.md`
+                    : `cli_reference_${commandWithUnderscores}.md`;
+                lines.push(`    - title: ${commandWithSpaces}${stateLabel}`);
+                lines.push(`      link: ${topic}/${linkTarget}`);
+            }
+        }
+        lines.push('');
+        return Promise.resolve(lines.join('\n'));
+    }
+}
+//# sourceMappingURL=toc.js.map

package/lib/markdown/toc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"toc.js","sourceRoot":"","sources":["../../src/markdown/toc.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAGH,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD,MAAM,YAAY,GAA2B;IAC3C,IAAI,EAAE,MAAM;IACZ,OAAO,EAAE,mBAAmB;IAC5B,WAAW,EAAE,cAAc;IAC3B,SAAS,EAAE,YAAY;IACvB,UAAU,EAAE,YAAY;CACzB,CAAC;AAEF,MAAM,OAAO,WAAY,SAAQ,YAAY;IAChB;IAA3B,YAA2B,YAA6B,EAAE,SAAiB;QACzE,KAAK,CAAC,wBAAwB,EAAE,SAAS,CAAC,CAAC;QADlB,iBAAY,GAAZ,YAAY,CAAiB;IAExD,CAAC;IAEM,MAAM,CAAU,IAAI;QACzB,OAAO,wBAAwB,CAAC;IAClC,CAAC;IAED,kDAAkD;IACxC,QAAQ;QAChB,MAAM,KAAK,GAAa;YACtB,2CAA2C;YAC3C,0BAA0B;YAC1B,wBAAwB;YACxB,wCAAwC;YACxC,6BAA6B;YAC7B,sCAAsC;SACvC,CAAC;QAEF,MAAM,MAAM,GAAG,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;QAErF,KAAK,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,MAAM,EAAE,CAAC;YAC3C,KAAK,CAAC,IAAI,CAAC,YAAY,KAAK,WAAW,CAAC,CAAC;YACzC,KAAK,CAAC,IAAI,CAAC,WAAW,KAAK,kBAAkB,KAAK,KAAK,CAAC,CAAC;YACzD,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACxB,KAAK,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,CAAC,GAAG,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;gBACjG,MAAM,sBAAsB,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;gBACrD,MAAM,iBAAiB,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;gBAChD,MAAM,UAAU,GAAG,UAAU;oBAC3B,CAAC,CAAC,eAAe;oBACjB,CAAC,CAAC,KAAK,IAAI,YAAY,CAAC,KAAK,CAAC;wBAC9B,CAAC,CAAC,KAAK,YAAY,CAAC,KAAK,CAAC,GAAG;wBAC7B,CAAC,CAAC,EAAE,CAAC;gBACP,MAAM,mBAAmB,GAAG,CAAC,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;gBAC9C,MAAM,UAAU,GAAG,mBAAmB;oBACpC,CAAC,CAAC,iBAAiB,sBAAsB,aAAa;oBACtD,CAAC,CAAC,iBAAiB,sBAAsB,KAAK,CAAC;gBACjD,KAAK,CAAC,IAAI,CAAC,gBAAgB,iBAAiB,GAAG,UAAU,EAAE,CAAC,CAAC;gBAC7D,KAAK,CAAC,IAAI,CAAC,eAAe,KAAK,IAAI,UAAU,EAAE,CAAC,CAAC;YACnD,CAAC;QACH,CAAC;QAED,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3C,CAAC;CACF"}

package/lib/markdown/topic-commands.d.ts

@@ -0,0 +1,8 @@
+import { SfTopic } from '../utils.js';
+import { MarkdownBase } from './markdown-base.js';
+export declare class MarkdownTopicCommands extends MarkdownBase {
+    private topic;
+    private topicMeta;
+    constructor(topic: string, topicMeta: SfTopic, outputDir: string);
+    protected generate(): Promise<string>;
+}

package/lib/markdown/topic-commands.js

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2026, Salesforce, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { join } from 'node:path';
+import { MarkdownBase } from './markdown-base.js';
+export class MarkdownTopicCommands extends MarkdownBase {
+    topic;
+    topicMeta;
+    constructor(topic, topicMeta, outputDir) {
+        const filename = MarkdownBase.file(`cli_reference_${topic}_commands`);
+        super(filename, outputDir);
+        this.topic = topic;
+        this.topicMeta = topicMeta;
+        this.destination = join(outputDir, topic, filename);
+    }
+    generate() {
+        const lines = [];
+        lines.push('');
+        lines.push(`# ${this.topic} Commands`);
+        lines.push('');
+        if (this.topicMeta.description) {
+            lines.push(this.topicMeta.description);
+            lines.push('');
+        }
+        return Promise.resolve(lines.join('\n'));
+    }
+}
+//# sourceMappingURL=topic-commands.js.map

package/lib/markdown/topic-commands.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"topic-commands.js","sourceRoot":"","sources":["../../src/markdown/topic-commands.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEjC,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD,MAAM,OAAO,qBAAsB,SAAQ,YAAY;IAC1B;IAAuB;IAAlD,YAA2B,KAAa,EAAU,SAAkB,EAAE,SAAiB;QACrF,MAAM,QAAQ,GAAG,YAAY,CAAC,IAAI,CAAC,iBAAiB,KAAK,WAAW,CAAC,CAAC;QACtE,KAAK,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QAFF,UAAK,GAAL,KAAK,CAAQ;QAAU,cAAS,GAAT,SAAS,CAAS;QAGlE,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;IACtD,CAAC;IAES,QAAQ;QAChB,MAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,WAAW,CAAC,CAAC;QACvC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,IAAI,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC;YAC/B,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;YACvC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACjB,CAAC;QACD,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3C,CAAC;CACF"}

package/lib/markdown/topic-index.d.ts

@@ -0,0 +1,9 @@
+import { CommandClass, SfTopic } from '../utils.js';
+import { MarkdownBase } from './markdown-base.js';
+export declare class MarkdownTopicIndex extends MarkdownBase {
+    private topic;
+    private commands;
+    private topicMeta;
+    constructor(topic: string, commands: CommandClass[], topicMeta: SfTopic, outputDir: string);
+    protected generate(): Promise<string>;
+}

package/lib/markdown/topic-index.js

@@ -0,0 +1,80 @@
+/*
+ * Copyright 2026, Salesforce, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { join } from 'node:path';
+import { punctuate } from '../utils.js';
+import { MarkdownBase } from './markdown-base.js';
+function resolveStateLabel(command) {
+    const deprecated = Boolean(command.deprecated);
+    const state = command.state;
+    if (deprecated)
+        return 'Deprecated';
+    if (state === 'beta')
+        return 'Beta';
+    if (state === 'preview')
+        return 'Developer Preview';
+    if (state === 'closedPilot' || state === 'openPilot')
+        return 'Pilot';
+    return null;
+}
+export class MarkdownTopicIndex extends MarkdownBase {
+    topic;
+    commands;
+    topicMeta;
+    constructor(topic, commands, topicMeta, outputDir) {
+        const filename = MarkdownBase.file(`cli_reference_${topic}`);
+        super(filename, outputDir);
+        this.topic = topic;
+        this.commands = commands;
+        this.topicMeta = topicMeta;
+        this.destination = join(outputDir, topic, filename);
+    }
+    generate() {
+        const lines = [];
+        lines.push('<!-- prettier-ignore-start -->');
+        lines.push('');
+        lines.push(`# ${this.topic} Commands`);
+        lines.push('');
+        if (this.topicMeta.description) {
+            lines.push(this.topicMeta.description);
+            lines.push('');
+        }
+        const sortedCommands = [...this.commands].sort((a, b) => a.id.localeCompare(b.id));
+        for (const command of sortedCommands) {
+            const id = command.id;
+            const commandWithUnderscores = id.replace(/:/g, '_');
+            const commandWithSpaces = id.replace(/:/g, ' ');
+            const isTopicLevelCommand = !id.includes(':');
+            const linkTarget = isTopicLevelCommand
+                ? `cli_reference_${commandWithUnderscores}_command.md`
+                : `cli_reference_${commandWithUnderscores}.md`;
+            const stateLabel = resolveStateLabel(command);
+            const commandDisplay = stateLabel ? `${commandWithSpaces} (${stateLabel})` : commandWithSpaces;
+            const summary = punctuate(command.summary);
+            if (summary) {
+                lines.push(`- **[${commandDisplay}](./${linkTarget})**<br>`);
+                lines.push(`  ${summary}`);
+            }
+            else {
+                lines.push(`- **[${commandDisplay}](./${linkTarget})**`);
+            }
+        }
+        lines.push('');
+        lines.push('<!-- prettier-ignore-end -->');
+        lines.push('');
+        return Promise.resolve(lines.join('\n'));
+    }
+}
+//# sourceMappingURL=topic-index.js.map

package/lib/markdown/topic-index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"topic-index.js","sourceRoot":"","sources":["../../src/markdown/topic-index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAgB,SAAS,EAAW,MAAM,aAAa,CAAC;AAC/D,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD,SAAS,iBAAiB,CAAC,OAAqB;IAC9C,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAC/C,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;IAE5B,IAAI,UAAU;QAAE,OAAO,YAAY,CAAC;IACpC,IAAI,KAAK,KAAK,MAAM;QAAE,OAAO,MAAM,CAAC;IACpC,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,mBAAmB,CAAC;IACpD,IAAI,KAAK,KAAK,aAAa,IAAI,KAAK,KAAK,WAAW;QAAE,OAAO,OAAO,CAAC;IACrE,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,OAAO,kBAAmB,SAAQ,YAAY;IAExC;IACA;IACA;IAHV,YACU,KAAa,EACb,QAAwB,EACxB,SAAkB,EAC1B,SAAiB;QAEjB,MAAM,QAAQ,GAAG,YAAY,CAAC,IAAI,CAAC,iBAAiB,KAAK,EAAE,CAAC,CAAC;QAC7D,KAAK,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QANnB,UAAK,GAAL,KAAK,CAAQ;QACb,aAAQ,GAAR,QAAQ,CAAgB;QACxB,cAAS,GAAT,SAAS,CAAS;QAK1B,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;IACtD,CAAC;IAES,QAAQ;QAChB,MAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,KAAK,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAC;QAC7C,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,WAAW,CAAC,CAAC;QACvC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,IAAI,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC;YAC/B,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;YACvC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACjB,CAAC;QACD,MAAM,cAAc,GAAG,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACnF,KAAK,MAAM,OAAO,IAAI,cAAc,EAAE,CAAC;YACrC,MAAM,EAAE,GAAG,OAAO,CAAC,EAAE,CAAC;YACtB,MAAM,sBAAsB,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;YACrD,MAAM,iBAAiB,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;YAChD,MAAM,mBAAmB,GAAG,CAAC,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;YAC9C,MAAM,UAAU,GAAG,mBAAmB;gBACpC,CAAC,CAAC,iBAAiB,sBAAsB,aAAa;gBACtD,CAAC,CAAC,iBAAiB,sBAAsB,KAAK,CAAC;YACjD,MAAM,UAAU,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;YAC9C,MAAM,cAAc,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,iBAAiB,KAAK,UAAU,GAAG,CAAC,CAAC,CAAC,iBAAiB,CAAC;YAC/F,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAC3C,IAAI,OAAO,EAAE,CAAC;gBACZ,KAAK,CAAC,IAAI,CAAC,QAAQ,cAAc,OAAO,UAAU,SAAS,CAAC,CAAC;gBAC7D,KAAK,CAAC,IAAI,CAAC,KAAK,OAAO,EAAE,CAAC,CAAC;YAC7B,CAAC;iBAAM,CAAC;gBACN,KAAK,CAAC,IAAI,CAAC,QAAQ,cAAc,OAAO,UAAU,KAAK,CAAC,CAAC;YAC3D,CAAC;QACH,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;QAC3C,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3C,CAAC;CACF"}

package/lib/utils.d.ts

@@ -1,7 +1,7 @@
 import { EventEmitter } from 'node:events';
 import { Command, Interfaces } from '@oclif/core';
 import { AnyJson } from '@salesforce/ts-types';
-export type CommandClass = Pick<Command.Class, 'id' | 'hidden' | 'description' | 'plugin' | 'state' | 'examples' | 'summary' | 'flags' | 'pluginName'> & {
+export type CommandClass = Pick<Command.Class, 'id' | 'hidden' | 'description' | 'plugin' | 'state' | 'examples' | 'summary' | 'flags' | 'pluginName' | 'aliases'> & {
     topic: string;
     subtopic: string;
     longDescription?: string;

package/messages/main.md

@@ -28,7 +28,11 @@ fail the command if there are any warnings
 
 # flags.ditamap-suffix.summary
 
-unique suffix to append to generated ditamap
+unique suffix to append to generated DITA files
+
+# flags.output-format.summary
+
+output format for generated documentation; 'dita' (default) generates DITA XML files, 'markdown' generates Markdown files
 
 # flags.config-path.summary