@salesforce/plugin-command-reference 3.1.107 → 3.1.108

package/lib/generator-factory.js

@@ -0,0 +1,89 @@
+/*
+ * 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 { BaseDitamap } from './ditamap/base-ditamap.js';
+import { CLIReference } from './ditamap/cli-reference.js';
+import { Command as DitaCommand } from './ditamap/command.js';
+import { Ditamap } from './ditamap/ditamap.js';
+import { HelpReference } from './ditamap/help-reference.js';
+import { TopicCommands } from './ditamap/topic-commands.js';
+import { TopicDitamap } from './ditamap/topic-ditamap.js';
+import { MarkdownCliReference } from './markdown/cli-reference.js';
+import { MarkdownCommand } from './markdown/command.js';
+import { MarkdownTopicIndex } from './markdown/topic-index.js';
+import { MarkdownToc } from './markdown/toc.js';
+export class DitaGeneratorFactory {
+    // eslint-disable-next-line class-methods-use-this, @typescript-eslint/no-unused-vars
+    createCliReference(_topics) {
+        return new CLIReference();
+    }
+    // eslint-disable-next-line class-methods-use-this
+    createHelpReference() {
+        return new HelpReference();
+    }
+    // eslint-disable-next-line class-methods-use-this
+    createRootIndex(topics) {
+        return new BaseDitamap(topics);
+    }
+    // eslint-disable-next-line class-methods-use-this, @typescript-eslint/no-unused-vars
+    createToc(_topicEntries) {
+        return null;
+    }
+    // eslint-disable-next-line class-methods-use-this
+    createTopicCommands(topic, topicMeta) {
+        return new TopicCommands(topic, topicMeta);
+    }
+    // eslint-disable-next-line class-methods-use-this, @typescript-eslint/no-unused-vars
+    createTopicIndex(topic, commands, _topicMeta) {
+        const commandIds = commands.map((cmd) => cmd.id);
+        return new TopicDitamap(topic, commandIds);
+    }
+    // eslint-disable-next-line class-methods-use-this
+    createCommand(topic, subtopic, command, commandMeta) {
+        return new DitaCommand(topic, subtopic, command, commandMeta);
+    }
+}
+export class MarkdownGeneratorFactory {
+    outputDir;
+    constructor(outputDir) {
+        this.outputDir = outputDir;
+    }
+    // eslint-disable-next-line class-methods-use-this, @typescript-eslint/no-unused-vars
+    createCliReference(_topics) {
+        return new MarkdownCliReference(Ditamap.cliVersion, Ditamap.pluginVersions, this.outputDir);
+    }
+    // eslint-disable-next-line class-methods-use-this
+    createHelpReference() {
+        return null;
+    }
+    // eslint-disable-next-line class-methods-use-this, @typescript-eslint/no-unused-vars
+    createRootIndex(_topics) {
+        return null;
+    }
+    createToc(topicEntries) {
+        return new MarkdownToc(topicEntries, this.outputDir);
+    }
+    // eslint-disable-next-line class-methods-use-this, @typescript-eslint/no-unused-vars
+    createTopicCommands(_topic, _topicMeta) {
+        return null;
+    }
+    createTopicIndex(topic, commands, topicMeta) {
+        return new MarkdownTopicIndex(topic, commands, topicMeta, this.outputDir);
+    }
+    createCommand(topic, subtopic, command, commandMeta) {
+        return new MarkdownCommand(topic, subtopic, command, commandMeta, this.outputDir);
+    }
+}
+//# sourceMappingURL=generator-factory.js.map

package/lib/generator-factory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generator-factory.js","sourceRoot":"","sources":["../src/generator-factory.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AA4BhD,MAAM,OAAO,oBAAoB;IAC/B,qFAAqF;IAC9E,kBAAkB,CAAC,OAAiB;QACzC,OAAO,IAAI,YAAY,EAAE,CAAC;IAC5B,CAAC;IAED,kDAAkD;IAC3C,mBAAmB;QACxB,OAAO,IAAI,aAAa,EAAE,CAAC;IAC7B,CAAC;IAED,kDAAkD;IAC3C,eAAe,CAAC,MAAgB;QACrC,OAAO,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;IAED,qFAAqF;IAC9E,SAAS,CAAC,aAA8B;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,kDAAkD;IAC3C,mBAAmB,CAAC,KAAa,EAAE,SAAkB;QAC1D,OAAO,IAAI,aAAa,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;IAC7C,CAAC;IAED,qFAAqF;IAC9E,gBAAgB,CAAC,KAAa,EAAE,QAAwB,EAAE,UAAmB;QAClF,MAAM,UAAU,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACjD,OAAO,IAAI,YAAY,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;IAC7C,CAAC;IAED,kDAAkD;IAC3C,aAAa,CAClB,KAAa,EACb,QAAuB,EACvB,OAAqB,EACrB,WAAoC;QAEpC,OAAO,IAAI,WAAW,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;IAChE,CAAC;CACF;AAED,MAAM,OAAO,wBAAwB;IACR;IAA3B,YAA2B,SAAiB;QAAjB,cAAS,GAAT,SAAS,CAAQ;IAAG,CAAC;IAEhD,qFAAqF;IAC9E,kBAAkB,CAAC,OAAiB;QACzC,OAAO,IAAI,oBAAoB,CAAC,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,cAAc,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IAC9F,CAAC;IAED,kDAAkD;IAC3C,mBAAmB;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,qFAAqF;IAC9E,eAAe,CAAC,OAAiB;QACtC,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,SAAS,CAAC,YAA6B;QAC5C,OAAO,IAAI,WAAW,CAAC,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IACvD,CAAC;IAED,qFAAqF;IAC9E,mBAAmB,CAAC,MAAc,EAAE,UAAmB;QAC5D,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,gBAAgB,CAAC,KAAa,EAAE,QAAwB,EAAE,SAAkB;QACjF,OAAO,IAAI,kBAAkB,CAAC,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IAC5E,CAAC;IAEM,aAAa,CAClB,KAAa,EACb,QAAuB,EACvB,OAAqB,EACrB,WAAoC;QAEpC,OAAO,IAAI,eAAe,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IACpF,CAAC;CACF"}

package/lib/markdown/cli-reference.d.ts

@@ -0,0 +1,10 @@
+import { MarkdownBase } from './markdown-base.js';
+export declare class MarkdownCliReference extends MarkdownBase {
+    private cliVersion;
+    private pluginVersions;
+    constructor(cliVersion: string, pluginVersions: Array<{
+        name: string;
+        version: string;
+    }>, outputDir: string);
+    protected generate(): Promise<string>;
+}

package/lib/markdown/cli-reference.js

@@ -0,0 +1,50 @@
+/*
+ * 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';
+export class MarkdownCliReference extends MarkdownBase {
+    cliVersion;
+    pluginVersions;
+    constructor(cliVersion, pluginVersions, outputDir) {
+        super(MarkdownBase.file('cli_reference'), outputDir);
+        this.cliVersion = cliVersion;
+        this.pluginVersions = pluginVersions;
+    }
+    generate() {
+        const lines = [];
+        lines.push('<!-- prettier-ignore-start -->');
+        lines.push('');
+        lines.push('# Salesforce CLI Command Reference');
+        lines.push('');
+        lines.push('This command reference contains information about the Salesforce CLI commands and their flags. Use these commands to build Agentforce agents, manage Salesforce DX projects, create and manage scratch orgs and sandboxes, synchronize source to and from orgs, create and install packages, and more.');
+        lines.push('');
+        lines.push(`Salesforce CLI version: \`${this.cliVersion}\``);
+        lines.push('');
+        if (this.pluginVersions.length > 0) {
+            lines.push('## Plugin Versions');
+            lines.push('');
+            lines.push('| Plugin | Version |');
+            lines.push('|--------|---------|');
+            for (const { name, version } of this.pluginVersions) {
+                lines.push(`| \`${name}\` | \`${version}\` |`);
+            }
+            lines.push('');
+        }
+        lines.push('<!-- prettier-ignore-end -->');
+        lines.push('');
+        return Promise.resolve(lines.join('\n'));
+    }
+}
+//# sourceMappingURL=cli-reference.js.map

package/lib/markdown/cli-reference.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli-reference.js","sourceRoot":"","sources":["../../src/markdown/cli-reference.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD,MAAM,OAAO,oBAAqB,SAAQ,YAAY;IAE1C;IACA;IAFV,YACU,UAAkB,EAClB,cAAwD,EAChE,SAAiB;QAEjB,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,SAAS,CAAC,CAAC;QAJ7C,eAAU,GAAV,UAAU,CAAQ;QAClB,mBAAc,GAAd,cAAc,CAA0C;IAIlE,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,oCAAoC,CAAC,CAAC;QACjD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,CAAC,IAAI,CACR,wSAAwS,CACzS,CAAC;QACF,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,CAAC,IAAI,CAAC,6BAA6B,IAAI,CAAC,UAAU,IAAI,CAAC,CAAC;QAC7D,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACnC,KAAK,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;YACjC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACf,KAAK,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;YACnC,KAAK,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;YACnC,KAAK,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;gBACpD,KAAK,CAAC,IAAI,CAAC,OAAO,IAAI,UAAU,OAAO,MAAM,CAAC,CAAC;YACjD,CAAC;YACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACjB,CAAC;QACD,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/markdown/command.d.ts

@@ -0,0 +1,17 @@
+import { CommandClass } from '../utils.js';
+import { MarkdownBase } from './markdown-base.js';
+export declare class MarkdownCommand extends MarkdownBase {
+    private flags;
+    private commandMeta;
+    private binary;
+    private commandName;
+    private summary;
+    private help;
+    private examples;
+    private state;
+    private deprecated;
+    private deprecationDetails;
+    private aliases;
+    constructor(topic: string, subtopic: string | null, command: CommandClass, commandMeta: Record<string, unknown> | undefined, outputDir: string);
+    protected generate(): Promise<string>;
+}

package/lib/markdown/command.js

@@ -0,0 +1,257 @@
+/*
+ * 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 { asString, ensureObject, ensureString } from '@salesforce/ts-types';
+import { punctuate, replaceConfigVariables } from '../utils.js';
+import { buildCommandParameters, formatParagraphs, readBinary } from '../ditamap/command-helpers.js';
+import { MarkdownBase } from './markdown-base.js';
+export class MarkdownCommand extends MarkdownBase {
+    flags;
+    commandMeta;
+    binary;
+    commandName;
+    summary;
+    help;
+    examples;
+    state;
+    deprecated;
+    deprecationDetails;
+    aliases;
+    constructor(topic, subtopic, command, commandMeta = {}, outputDir) {
+        const commandWithUnderscores = ensureString(command.id).replace(/:/g, '_');
+        // If the command ID has no subtopic (e.g. "doctor"), its filename would collide with the topic
+        // index file (cli_reference_doctor.md), so append _command to disambiguate.
+        const isTopicLevelCommand = !ensureString(command.id).includes(':');
+        const baseName = isTopicLevelCommand
+            ? `cli_reference_${commandWithUnderscores}_command`
+            : `cli_reference_${commandWithUnderscores}`;
+        const filename = MarkdownBase.file(baseName);
+        super(filename, outputDir);
+        this.destination = join(outputDir, topic, filename);
+        this.flags = ensureObject(command.flags);
+        this.commandMeta = commandMeta;
+        this.binary = readBinary(this.commandMeta);
+        this.summary = punctuate(command.summary);
+        // commandName is the bare command ID with colons replaced by the topic separator (e.g. "agent activate")
+        this.commandName = command.id.replace(/:/g, asString(this.commandMeta.topicSeparator, ' '));
+        const description = command.description
+            ? replaceConfigVariables(command.description, this.binary, this.commandName)
+            : undefined;
+        this.help = formatParagraphs(description);
+        this.examples = (command.examples ?? []).map((example) => {
+            let desc;
+            let commands;
+            if (typeof example === 'string') {
+                const parts = example.split('\n');
+                desc = parts.length > 1 ? parts[0] : null;
+                commands = parts.length > 1 ? parts.slice(1) : [parts[0]];
+            }
+            else {
+                desc = example.description;
+                commands = [example.command];
+            }
+            return {
+                description: replaceConfigVariables(desc ?? '', this.binary, this.commandName),
+                commands: commands.map((cmd) => replaceConfigVariables(cmd, this.binary, this.commandName)),
+            };
+        });
+        this.state = command.state ?? this.commandMeta.state;
+        this.deprecated = Boolean(command.deprecated) || this.state === 'deprecated';
+        const dep = command.deprecated;
+        this.deprecationDetails = dep && typeof dep === 'object' ? dep : null;
+        this.aliases = command.aliases ?? [];
+    }
+    async generate() {
+        const parameters = await buildCommandParameters(this.commandName, this.binary, this.flags);
+        const lines = [];
+        lines.push('<!-- prettier-ignore-start -->');
+        lines.push('');
+        const stateLabel = resolveStateLabel(this.state, this.deprecated);
+        lines.push(`# ${this.commandName}${stateLabel ? ` (${stateLabel})` : ''}`);
+        lines.push('');
+        if (this.summary) {
+            lines.push(this.summary);
+            lines.push('');
+        }
+        const disclaimer = resolveDisclaimer(this.commandName, this.state, this.deprecated, this.deprecationDetails);
+        if (disclaimer) {
+            lines.push(':::note');
+            lines.push(disclaimer);
+            lines.push(':::');
+            lines.push('');
+        }
+        if (this.help.length > 0) {
+            lines.push(`## Description for ${this.commandName}`);
+            lines.push('');
+            for (const paragraph of convertBulletListsToHtml(this.help.map((p) => escapeForMarkdown(p)))) {
+                lines.push(paragraph);
+                lines.push('');
+            }
+        }
+        if (this.aliases.length > 0) {
+            lines.push(`## Aliases for ${this.commandName}`);
+            lines.push('');
+            for (const alias of this.aliases) {
+                lines.push(`\`${alias}\``);
+                lines.push('');
+            }
+        }
+        if (parameters.length > 0) {
+            lines.push('## Flags');
+            lines.push('');
+            lines.push('| Flag Name (Long) | Flag Name (Short) | Description |');
+            lines.push('|------------------|-------------------|-------------|');
+            // Sort parameters alphabetically by flag name
+            const sortedParams = [...parameters].sort((a, b) => a.name.localeCompare(b.name));
+            for (const param of sortedParams) {
+                lines.push(renderFlagRow(param));
+            }
+            lines.push('');
+        }
+        if (this.examples.length > 0) {
+            lines.push(`## Examples for ${this.commandName}`);
+            lines.push('');
+            for (const example of this.examples) {
+                if (example.description) {
+                    lines.push(example.description);
+                    lines.push('');
+                }
+                for (const cmd of example.commands) {
+                    lines.push('```shell');
+                    lines.push(cmd.trim().replace(/^\$\s*/, ''));
+                    lines.push('```');
+                    lines.push('');
+                }
+            }
+            // Remove the trailing empty line after the last example
+            if (lines[lines.length - 1] === '') {
+                lines.pop();
+            }
+        }
+        lines.push('<!-- prettier-ignore-end -->');
+        lines.push('');
+        return lines.join('\n');
+    }
+}
+function escapeForMarkdown(text) {
+    // Escape HTML entities for markdown safety
+    let result = text.replace(/</g, '&lt;').replace(/>/g, '&gt;');
+    // Normalize whitespace: collapse multiple spaces/tabs/newlines to single space
+    result = result.replace(/\s+/g, ' ');
+    // Trim leading/trailing whitespace
+    result = result.trim();
+    return result;
+}
+/**
+ * Converts bullet list paragraphs to HTML <ul>/<li> tags for compact rendering in markdown.
+ * Strips leading whitespace from bullets to prevent code block rendering.
+ *
+ * @param paragraphs - Array of paragraph strings, some may be bullet items
+ * @returns Array where consecutive bullets are converted to a single HTML <ul> string
+ */
+function convertBulletListsToHtml(paragraphs) {
+    const result = [];
+    let i = 0;
+    while (i < paragraphs.length) {
+        const trimmed = paragraphs[i].trimStart();
+        if (trimmed.startsWith('- ') || trimmed.startsWith('* ')) {
+            // Collect consecutive list items and render as HTML bullet list
+            const items = [];
+            while (i < paragraphs.length) {
+                const itemTrimmed = paragraphs[i].trimStart();
+                if (itemTrimmed.startsWith('- ') || itemTrimmed.startsWith('* ')) {
+                    // Remove the bullet marker (- or *) and wrap in <li>
+                    items.push(`<li>${itemTrimmed.substring(2)}</li>`);
+                    i++;
+                }
+                else {
+                    break;
+                }
+            }
+            // Wrap all items in <ul> tags
+            result.push(`<ul>${items.join('')}</ul>`);
+        }
+        else {
+            result.push(paragraphs[i]);
+            i++;
+        }
+    }
+    return result;
+}
+function resolveStateLabel(state, deprecated) {
+    if (deprecated)
+        return 'Deprecated';
+    if (state === 'beta')
+        return 'Beta';
+    if (state === 'preview')
+        return 'Developer Preview';
+    if (state === 'closedPilot' || state === 'openPilot')
+        return 'Pilot';
+    return null;
+}
+function resolveDisclaimer(commandName, state, deprecated, deprecationDetails) {
+    if (deprecated) {
+        const versionNote = deprecationDetails?.version
+            ? ` and will be removed in v${deprecationDetails.version} or later`
+            : '';
+        const toNote = deprecationDetails?.to ? ` Use \`${deprecationDetails.to}\` instead.` : '';
+        return `The command \`${commandName}\` has been deprecated${versionNote}.${toNote}`;
+    }
+    if (state === 'closedPilot') {
+        // prettier-ignore
+        return `We provide the \`${commandName}\` command to selected customers through an invitation-only pilot program that requires agreement to specific terms and conditions. Pilot programs are subject to change, and we can\x27t guarantee acceptance. The \`${commandName}\` command isn\x27t generally available unless or until Salesforce announces its general availability in documentation or in press releases or public statements. We can\x27t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.`;
+    }
+    if (state === 'openPilot') {
+        // prettier-ignore
+        return `We provide the \`${commandName}\` command to selected customers through a pilot program that requires agreement to specific terms and conditions. To be nominated to participate in the program, contact Salesforce. Pilot programs are subject to change, and we can\x27t guarantee acceptance. The \`${commandName}\` command isn\x27t generally available unless or until Salesforce announces its general availability in documentation or in press releases or public statements. We can\x27t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.`;
+    }
+    if (state === 'beta') {
+        return 'This feature is a Beta Service. Customers may opt to try such Beta Service in its sole discretion. Any use of the Beta Service is subject to the applicable Beta Services Terms provided at [Agreements and Terms](https://www.salesforce.com/company/legal/agreements/).';
+    }
+    if (state === 'preview') {
+        // prettier-ignore
+        return 'This command is available as a developer preview. The command isn\'t generally available unless or until Salesforce announces its general availability in documentation or in press releases or public statements. All commands, parameters, and other features are subject to change or deprecation at any time, with or without notice. Don\'t implement functionality developed with these commands or tools.';
+    }
+    return null;
+}
+function renderFlagRow(param) {
+    const longFlag = `<code>&#8209;&#8209;${param.name.replace(/-/g, '&#8209;')}</code>`;
+    const shortFlag = param.char ? `<code>&#8209;${param.char}</code>` : 'N/A';
+    const desc = renderFlagDescription(param);
+    return `| ${longFlag} | ${shortFlag} | ${desc} |`;
+}
+function renderFlagDescription(param) {
+    const metadataParts = [];
+    if (param.deprecated) {
+        const toNote = param.deprecated.to ? ` Use \`--${param.deprecated.to}\` instead.` : '';
+        metadataParts.push(`**This flag is deprecated.${toNote}**`);
+    }
+    const flagType = param.hasValue ? 'Value' : 'Boolean';
+    metadataParts.push(`**Type:** ${flagType}`);
+    if (!param.optional)
+        metadataParts.push('**Required**');
+    if (param.options?.length) {
+        metadataParts.push(`**Valid Values:** ${param.options.map((o) => `\`${o}\``).join(', ')}`);
+    }
+    if (param.defaultFlagValue)
+        metadataParts.push(`**Default value:** \`${param.defaultFlagValue}\``);
+    const desc = convertBulletListsToHtml(param.description.map((p) => escapeForMarkdown(p.replace(/\|/g, '&#124;')))).join('<br><br>');
+    const parts = [metadataParts.join('<br>')];
+    if (desc)
+        parts.push(desc);
+    return parts.join('<br><br>').replace(/\n/g, ' ');
+}
+//# sourceMappingURL=command.js.map

package/lib/markdown/command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"command.js","sourceRoot":"","sources":["../../src/markdown/command.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,QAAQ,EAAc,YAAY,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACxF,OAAO,EAAsC,SAAS,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AACpG,OAAO,EAAE,sBAAsB,EAAY,gBAAgB,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC/G,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAOlD,MAAM,OAAO,eAAgB,SAAQ,YAAY;IACvC,KAAK,CAAuB;IAC5B,WAAW,CAA0B;IACrC,MAAM,CAAS;IACf,WAAW,CAAS;IACpB,OAAO,CAAqB;IAC5B,IAAI,CAAW;IACf,QAAQ,CAAkB;IAC1B,KAAK,CAAU;IACf,UAAU,CAAU;IACpB,kBAAkB,CAA2C;IAC7D,OAAO,CAAW;IAE1B,YACE,KAAa,EACb,QAAuB,EACvB,OAAqB,EACrB,cAAuC,EAAE,EACzC,SAAiB;QAEjB,MAAM,sBAAsB,GAAG,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAC3E,+FAA+F;QAC/F,4EAA4E;QAC5E,MAAM,mBAAmB,GAAG,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACpE,MAAM,QAAQ,GAAG,mBAAmB;YAClC,CAAC,CAAC,iBAAiB,sBAAsB,UAAU;YACnD,CAAC,CAAC,iBAAiB,sBAAsB,EAAE,CAAC;QAC9C,MAAM,QAAQ,GAAG,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC7C,KAAK,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QAC3B,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;QAEpD,IAAI,CAAC,KAAK,GAAG,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACzC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAE3C,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAC1C,yGAAyG;QACzG,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC,CAAC;QAE5F,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW;YACrC,CAAC,CAAC,sBAAsB,CAAC,OAAO,CAAC,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC;YAC5E,CAAC,CAAC,SAAS,CAAC;QAEd,IAAI,CAAC,IAAI,GAAG,gBAAgB,CAAC,WAAW,CAAC,CAAC;QAE1C,IAAI,CAAC,QAAQ,GAAG,CAAC,OAAO,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;YACvD,IAAI,IAAmB,CAAC;YACxB,IAAI,QAAkB,CAAC;YACvB,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;gBAChC,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBAClC,IAAI,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;gBAC1C,QAAQ,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YAC5D,CAAC;iBAAM,CAAC;gBACN,IAAI,GAAG,OAAO,CAAC,WAAW,CAAC;gBAC3B,QAAQ,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAC/B,CAAC;YACD,OAAO;gBACL,WAAW,EAAE,sBAAsB,CAAC,IAAI,IAAI,EAAE,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC;gBAC9E,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,sBAAsB,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;aAC5F,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC;QACrD,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,KAAK,KAAK,YAAY,CAAC;QAC7E,MAAM,GAAG,GAAG,OAAO,CAAC,UAAU,CAAC;QAC/B,IAAI,CAAC,kBAAkB,GAAG,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAE,GAAyC,CAAC,CAAC,CAAC,IAAI,CAAC;QAC7G,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC;IACvC,CAAC;IAES,KAAK,CAAC,QAAQ;QACtB,MAAM,UAAU,GAAG,MAAM,sBAAsB,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;QAE3F,MAAM,KAAK,GAAa,EAAE,CAAC;QAE3B,KAAK,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAC;QAC7C,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAEf,MAAM,UAAU,GAAG,iBAAiB,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAClE,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC,CAAC,CAAC,KAAK,UAAU,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QAC3E,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAEf,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACzB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACjB,CAAC;QAED,MAAM,UAAU,GAAG,iBAAiB,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAC7G,IAAI,UAAU,EAAE,CAAC;YACf,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACtB,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YACvB,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAClB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACjB,CAAC;QAED,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACzB,KAAK,CAAC,IAAI,CAAC,sBAAsB,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;YACrD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACf,KAAK,MAAM,SAAS,IAAI,wBAAwB,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC7F,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBACtB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACjB,CAAC;QACH,CAAC;QAED,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC5B,KAAK,CAAC,IAAI,CAAC,kBAAkB,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;YACjD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACf,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBACjC,KAAK,CAAC,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC;gBAC3B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACjB,CAAC;QACH,CAAC;QAED,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1B,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YACvB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACf,KAAK,CAAC,IAAI,CAAC,wDAAwD,CAAC,CAAC;YACrE,KAAK,CAAC,IAAI,CAAC,wDAAwD,CAAC,CAAC;YACrE,8CAA8C;YAC9C,MAAM,YAAY,GAAG,CAAC,GAAG,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;YAClF,KAAK,MAAM,KAAK,IAAI,YAAY,EAAE,CAAC;gBACjC,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;YACnC,CAAC;YACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACjB,CAAC;QAED,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC7B,KAAK,CAAC,IAAI,CAAC,mBAAmB,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;YAClD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACf,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACpC,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;oBACxB,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;oBAChC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACjB,CAAC;gBACD,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;oBACnC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;oBACvB,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC;oBAC7C,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;oBAClB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACjB,CAAC;YACH,CAAC;YACD,wDAAwD;YACxD,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC;gBACnC,KAAK,CAAC,GAAG,EAAE,CAAC;YACd,CAAC;QACH,CAAC;QAED,KAAK,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;QAC3C,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAEf,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;CACF;AAED,SAAS,iBAAiB,CAAC,IAAY;IACrC,2CAA2C;IAC3C,IAAI,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAE9D,+EAA+E;IAC/E,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAErC,mCAAmC;IACnC,MAAM,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC;IAEvB,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;GAMG;AACH,SAAS,wBAAwB,CAAC,UAAoB;IACpD,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,OAAO,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC;QAC7B,MAAM,OAAO,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;QAC1C,IAAI,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YACzD,gEAAgE;YAChE,MAAM,KAAK,GAAa,EAAE,CAAC;YAC3B,OAAO,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC;gBAC7B,MAAM,WAAW,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;gBAC9C,IAAI,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;oBACjE,qDAAqD;oBACrD,KAAK,CAAC,IAAI,CAAC,OAAO,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;oBACnD,CAAC,EAAE,CAAC;gBACN,CAAC;qBAAM,CAAC;oBACN,MAAM;gBACR,CAAC;YACH,CAAC;YACD,8BAA8B;YAC9B,MAAM,CAAC,IAAI,CAAC,OAAO,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC;QAC5C,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;YAC3B,CAAC,EAAE,CAAC;QACN,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,iBAAiB,CAAC,KAAc,EAAE,UAAmB;IAC5D,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,SAAS,iBAAiB,CACxB,WAAmB,EACnB,KAAc,EACd,UAAmB,EACnB,kBAA4D;IAE5D,IAAI,UAAU,EAAE,CAAC;QACf,MAAM,WAAW,GAAG,kBAAkB,EAAE,OAAO;YAC7C,CAAC,CAAC,4BAA4B,kBAAkB,CAAC,OAAO,WAAW;YACnE,CAAC,CAAC,EAAE,CAAC;QACP,MAAM,MAAM,GAAG,kBAAkB,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,kBAAkB,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC;QAC1F,OAAO,iBAAiB,WAAW,yBAAyB,WAAW,IAAI,MAAM,EAAE,CAAC;IACtF,CAAC;IACD,IAAI,KAAK,KAAK,aAAa,EAAE,CAAC;QAC5B,kBAAkB;QAClB,OAAO,oBAAoB,WAAW,yNAAyN,WAAW,uVAAuV,CAAC;IACpmB,CAAC;IACD,IAAI,KAAK,KAAK,WAAW,EAAE,CAAC;QAC1B,kBAAkB;QAClB,OAAO,oBAAoB,WAAW,2QAA2Q,WAAW,uVAAuV,CAAC;IACtpB,CAAC;IACD,IAAI,KAAK,KAAK,MAAM,EAAE,CAAC;QACrB,OAAO,2QAA2Q,CAAC;IACrR,CAAC;IACD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,kBAAkB;QAClB,OAAO,kZAAkZ,CAAC;IAC5Z,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,aAAa,CAAC,KAA2B;IAChD,MAAM,QAAQ,GAAG,uBAAuB,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,SAAS,CAAC,SAAS,CAAC;IACrF,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,gBAAgB,KAAK,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC;IAC3E,MAAM,IAAI,GAAG,qBAAqB,CAAC,KAAK,CAAC,CAAC;IAC1C,OAAO,KAAK,QAAQ,MAAM,SAAS,MAAM,IAAI,IAAI,CAAC;AACpD,CAAC;AAED,SAAS,qBAAqB,CAAC,KAA2B;IACxD,MAAM,aAAa,GAAa,EAAE,CAAC;IACnC,IAAI,KAAK,CAAC,UAAU,EAAE,CAAC;QACrB,MAAM,MAAM,GAAG,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,YAAY,KAAK,CAAC,UAAU,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC;QACvF,aAAa,CAAC,IAAI,CAAC,6BAA6B,MAAM,IAAI,CAAC,CAAC;IAC9D,CAAC;IACD,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;IACtD,aAAa,CAAC,IAAI,CAAC,aAAa,QAAQ,EAAE,CAAC,CAAC;IAC5C,IAAI,CAAC,KAAK,CAAC,QAAQ;QAAE,aAAa,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACxD,IAAI,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC;QAC1B,aAAa,CAAC,IAAI,CAAC,qBAAqB,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC7F,CAAC;IACD,IAAI,KAAK,CAAC,gBAAgB;QAAE,aAAa,CAAC,IAAI,CAAC,wBAAwB,KAAK,CAAC,gBAAgB,IAAI,CAAC,CAAC;IAEnG,MAAM,IAAI,GAAG,wBAAwB,CACnC,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,CAC5E,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAEnB,MAAM,KAAK,GAAa,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IACrD,IAAI,IAAI;QAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAE3B,OAAO,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;AACpD,CAAC"}

package/lib/markdown/index.d.ts

@@ -0,0 +1,7 @@
+export { MarkdownBase } from './markdown-base.js';
+export { MarkdownCommand } from './command.js';
+export { MarkdownCliReference } from './cli-reference.js';
+export { MarkdownRootIndex } from './root-index.js';
+export { MarkdownTopicCommands } from './topic-commands.js';
+export { MarkdownTopicIndex } from './topic-index.js';
+export { MarkdownToc } from './toc.js';

package/lib/markdown/index.js

@@ -0,0 +1,23 @@
+/*
+ * 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.
+ */
+export { MarkdownBase } from './markdown-base.js';
+export { MarkdownCommand } from './command.js';
+export { MarkdownCliReference } from './cli-reference.js';
+export { MarkdownRootIndex } from './root-index.js';
+export { MarkdownTopicCommands } from './topic-commands.js';
+export { MarkdownTopicIndex } from './topic-index.js';
+export { MarkdownToc } from './toc.js';
+//# sourceMappingURL=index.js.map

package/lib/markdown/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/markdown/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC"}

package/lib/markdown/markdown-base.d.ts

@@ -0,0 +1,10 @@
+export declare abstract class MarkdownBase {
+    private filename;
+    protected outputDir: string;
+    protected destination: string;
+    protected constructor(filename: string, outputDir: string);
+    static file(name: string): string;
+    getFilename(): string;
+    write(): Promise<void>;
+    protected abstract generate(): Promise<string>;
+}

package/lib/markdown/markdown-base.js

@@ -0,0 +1,39 @@
+/*
+ * 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 { dirname, join } from 'node:path';
+import fs from 'node:fs/promises';
+export class MarkdownBase {
+    filename;
+    outputDir;
+    destination;
+    constructor(filename, outputDir) {
+        this.filename = filename;
+        this.outputDir = outputDir;
+        this.destination = join(outputDir, filename);
+    }
+    static file(name) {
+        return `${name}.md`;
+    }
+    getFilename() {
+        return this.filename;
+    }
+    async write() {
+        await fs.mkdir(dirname(this.destination), { recursive: true });
+        const output = await this.generate();
+        await fs.writeFile(this.destination, output);
+    }
+}
+//# sourceMappingURL=markdown-base.js.map

package/lib/markdown/markdown-base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown-base.js","sourceRoot":"","sources":["../../src/markdown/markdown-base.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAElC,MAAM,OAAgB,YAAY;IAGF;IAA4B;IAFhD,WAAW,CAAS;IAE9B,YAA8B,QAAgB,EAAY,SAAiB;QAA7C,aAAQ,GAAR,QAAQ,CAAQ;QAAY,cAAS,GAAT,SAAS,CAAQ;QACzE,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAEM,MAAM,CAAC,IAAI,CAAC,IAAY;QAC7B,OAAO,GAAG,IAAI,KAAK,CAAC;IACtB,CAAC;IAEM,WAAW;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAEM,KAAK,CAAC,KAAK;QAChB,MAAM,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC/D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;QACrC,MAAM,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IAC/C,CAAC;CAGF"}

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

@@ -0,0 +1,6 @@
+import { MarkdownBase } from './markdown-base.js';
+export declare class MarkdownRootIndex extends MarkdownBase {
+    private topics;
+    constructor(topics: string[], outputDir: string);
+    protected generate(): Promise<string>;
+}

package/lib/markdown/root-index.js

@@ -0,0 +1,37 @@
+/*
+ * 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';
+export class MarkdownRootIndex extends MarkdownBase {
+    topics;
+    constructor(topics, outputDir) {
+        super(MarkdownBase.file('cli_reference_index'), outputDir);
+        this.topics = topics;
+    }
+    generate() {
+        const lines = [];
+        lines.push('<!-- prettier-ignore-start -->');
+        lines.push('');
+        lines.push('# sf CLI Reference — Topic Index');
+        lines.push('');
+        for (const topic of this.topics.sort()) {
+            lines.push(`- [${topic}](./${topic}/cli_reference_${topic}.md)`);
+        }
+        lines.push('<!-- prettier-ignore-end -->');
+        lines.push('');
+        return Promise.resolve(lines.join('\n'));
+    }
+}
+//# sourceMappingURL=root-index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"root-index.js","sourceRoot":"","sources":["../../src/markdown/root-index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD,MAAM,OAAO,iBAAkB,SAAQ,YAAY;IACtB;IAA3B,YAA2B,MAAgB,EAAE,SAAiB;QAC5D,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,qBAAqB,CAAC,EAAE,SAAS,CAAC,CAAC;QADlC,WAAM,GAAN,MAAM,CAAU;IAE3C,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,kCAAkC,CAAC,CAAC;QAC/C,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC;YACvC,KAAK,CAAC,IAAI,CAAC,MAAM,KAAK,OAAO,KAAK,kBAAkB,KAAK,MAAM,CAAC,CAAC;QACnE,CAAC;QACD,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/markdown/toc.d.ts

@@ -0,0 +1,8 @@
+import { TocTopicEntry } from '../generator-factory.js';
+import { MarkdownBase } from './markdown-base.js';
+export declare class MarkdownToc extends MarkdownBase {
+    private topicEntries;
+    constructor(topicEntries: TocTopicEntry[], outputDir: string);
+    static file(): string;
+    protected generate(): Promise<string>;
+}