diff --git a/.gitignore b/.gitignore index 9d6ea2ca..8055e12b 100644 --- a/.gitignore +++ b/.gitignore @@ -6,3 +6,4 @@ /package-lock.json /tmp node_modules +oclif.manifest.json diff --git a/README.md b/README.md index c8de585e..6c13d9c1 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,6 @@ Generate the [Salesforce CLI command reference guide](https://developer.salesfor [![Downloads/week](https://img.shields.io/npm/dw/@salesforce/plugin-command-reference.svg)](https://npmjs.org/package/@salesforce/plugin-command-reference) [![License](https://img.shields.io/npm/l/@salesforce/plugin-command-reference.svg)](https://github.com/salesforcecli/plugin-command-reference/blob/master/package.json) - - First install the plugin. ```sh-session @@ -46,43 +44,36 @@ Then you can run this in your plugin's CI. ./bin/run commandreference --plugins --error-on-warnings ``` - -* [`sfdx hello:org [-n ] [-f] [-v ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-helloorg--n-string--f--v-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx commandreference:generate -p [-d ] [--hidden] [--erroronwarnings] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-commandreferencegenerate--p-array--d-string---hidden---erroronwarnings---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) -## `sfdx hello:org [-n ] [-f] [-v ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` +## `sfdx commandreference:generate -p [-d ] [--hidden] [--erroronwarnings] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` -print a greeting and your org IDs +generate the command reference guide located ``` USAGE - $ sfdx hello:org [-n ] [-f] [-v ] [-u ] [--apiversion ] [--json] [--loglevel + $ sfdx commandreference:generate -p [-d ] [--hidden] [--erroronwarnings] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] OPTIONS - -f, --force example boolean flag - -n, --name=name name to print + -d, --outputdir=outputdir [default: ./tmp/root] output + directory to put generated files - -u, --targetusername=targetusername username or alias for the target - org; overrides default target org + -p, --plugins=plugins (required) comma separated list of + plugin names to be part of the + generation - -v, --targetdevhubusername=targetdevhubusername username or alias for the dev hub - org; overrides default dev hub org + --erroronwarnings fail the command if there are any + warnings - --apiversion=apiversion override the api version used for - api requests made by this command + --hidden show hidden commands --json format output as json --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for this command invocation - -EXAMPLES - $ sfdx hello:org --targetusername myOrg@example.com --targetdevhubusername devhub@org.com - Hello world! This is org: MyOrg and I will be around until Tue Mar 20 2018! - My hub org id is: 00Dxx000000001234 - - $ sfdx hello:org --name myname --targetusername myOrg@example.com - Hello myname! This is org: MyOrg and I will be around until Tue Mar 20 2018! ``` + +_See code: [lib/commands/commandreference/generate.js](https://github.com/salesforcecli/plugin-command-reference/blob/v0.0.0/lib/commands/commandreference/generate.js)_ diff --git a/src/ditamap/command.ts b/src/ditamap/command.ts index 8db6b45e..3a2bb1c2 100644 --- a/src/ditamap/command.ts +++ b/src/ditamap/command.ts @@ -65,7 +65,7 @@ export class Command extends Ditamap { isBetaCommand: commandMeta.state === 'beta', trailblazerCommunityUrl, trailblazerCommunityName - }); + }) as JsonMap; // Override destination to include topic and subtopic if (subtopic) {