@salesforce/plugin-command-reference 2.0.7 → 2.0.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +8 -0
- package/README.md +1 -1
- package/oclif.manifest.json +1 -1
- package/package.json +1 -1
- package/templates/base_ditamap.hbs +0 -4
- package/templates/cli_reference_help.hbs +38 -51
- package/templates/cli_reference_xml.hbs +4 -5
- package/templates/command.hbs +4 -3
- package/templates/topic_ditamap.hbs +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,14 @@
|
|
|
2
2
|
|
|
3
3
|
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
|
|
4
4
|
|
|
5
|
+
### [2.0.8](https://github.com/salesforcecli/plugin-command-reference/compare/v2.0.7...v2.0.8) (2021-09-15)
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
### Bug Fixes
|
|
9
|
+
|
|
10
|
+
* update template files for sf ([2a0ca0a](https://github.com/salesforcecli/plugin-command-reference/commit/2a0ca0acc1744b2b090d5c7b3d3a196d127061c9))
|
|
11
|
+
* update test with new title in command XML file ([b9b14ea](https://github.com/salesforcecli/plugin-command-reference/commit/b9b14ea2a8505d153a244ebc0d1e7759e2803a40))
|
|
12
|
+
|
|
5
13
|
### [2.0.7](https://github.com/salesforcecli/plugin-command-reference/compare/v2.0.6...v2.0.7) (2021-09-14)
|
|
6
14
|
|
|
7
15
|
|
package/README.md
CHANGED
|
@@ -93,5 +93,5 @@ OPTIONS
|
|
|
93
93
|
--json Format output as json.
|
|
94
94
|
```
|
|
95
95
|
|
|
96
|
-
_See code: [src/commands/commandreference/generate.ts](https://github.com/salesforcecli/plugin-command-reference/blob/v2.0.
|
|
96
|
+
_See code: [src/commands/commandreference/generate.ts](https://github.com/salesforcecli/plugin-command-reference/blob/v2.0.7/src/commands/commandreference/generate.ts)_
|
|
97
97
|
<!-- commandsstop -->
|
package/oclif.manifest.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":"2.0.
|
|
1
|
+
{"version":"2.0.8","commands":{"commandreference:generate":{"id":"commandreference:generate","description":"generate the command reference guide located","pluginName":"@salesforce/plugin-command-reference","pluginType":"core","aliases":[],"flags":{"json":{"name":"json","type":"boolean","description":"Format output as json.","allowNo":false},"outputdir":{"name":"outputdir","type":"option","char":"d","description":"output directory to put generated files","default":"./tmp/root"},"plugins":{"name":"plugins","type":"option","char":"p","description":"comma separated list of plugin names to be part of the generation. Defaults to the oclif plugin in the current working directory"},"ditamap-suffix":{"name":"ditamap-suffix","type":"option","char":"s","description":"unique suffix to append to generated ditamap","default":"unified"},"hidden":{"name":"hidden","type":"boolean","description":"show hidden commands","allowNo":false},"erroronwarnings":{"name":"erroronwarnings","type":"boolean","description":"fail the command if there are any warnings","allowNo":false}},"args":[]}}}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@salesforce/plugin-command-reference",
|
|
3
3
|
"description": "Generate the Salesforce CLI command reference guide",
|
|
4
|
-
"version": "2.0.
|
|
4
|
+
"version": "2.0.8",
|
|
5
5
|
"author": "Thomas @amphro",
|
|
6
6
|
"bugs": "https://github.com/salesforcecli/plugin-command-reference/issues",
|
|
7
7
|
"dependencies": {
|
|
@@ -19,9 +19,5 @@ IF YOU WANT TO CHANGE THIS CONTENT, CONTACT juliet.shackell@salesforce.com FOR D
|
|
|
19
19
|
{{#if []}}<topicref href="{{[]}}" format="ditamap" scope="local"/>{{/if}}
|
|
20
20
|
{{/each}}
|
|
21
21
|
<topicref href="{{xmlFile 'cli_reference_help'}}" type="concept" format="dita" scope="local"/>
|
|
22
|
-
<topicref href="../../sfdx_dev/workspace_setup/sfdx_dev_cli_deprecation.xml" type="concept"
|
|
23
|
-
format="dita" scope="local"/>
|
|
24
|
-
<topicref href="../../sfdx_setup/sfdx_setup_other_plugins.xml" type="concept"
|
|
25
|
-
format="dita" scope="local"/>
|
|
26
22
|
</topicref>
|
|
27
23
|
</map>
|
|
@@ -9,10 +9,10 @@ THIS FILE IS AUTOGENERATED. DON’T MAKE CHANGES TO THIS FILE IN PERFORCE! YOUR
|
|
|
9
9
|
IF YOU WANT TO CHANGE THIS CONTENT, CONTACT juliet.shackell@salesforce.com FOR DETAILS.
|
|
10
10
|
|
|
11
11
|
-->
|
|
12
|
-
|
|
13
|
-
<shortdesc>The <codeph otherprops="nolang">-h</codeph>
|
|
14
|
-
|
|
15
|
-
|
|
12
|
+
<title>Help for <codeph otherprops="nolang">sf</codeph> Commands</title>
|
|
13
|
+
<shortdesc>The <codeph otherprops="nolang">-h</codeph> and <codeph otherprops="nolang"
|
|
14
|
+
>--help</codeph> flags show details about <codeph otherprops="nolang">sf</codeph> topics and
|
|
15
|
+
their commands.</shortdesc>
|
|
16
16
|
<prolog>
|
|
17
17
|
<metadata>
|
|
18
18
|
<othermeta content="concept" name="topic_type"/>
|
|
@@ -23,56 +23,43 @@ IF YOU WANT TO CHANGE THIS CONTENT, CONTACT juliet.shackell@salesforce.com FOR D
|
|
|
23
23
|
</metadata>
|
|
24
24
|
</prolog>
|
|
25
25
|
<conbody>
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
<p>For topics, the <codeph otherprops="nolang">-h</codeph> | <codeph otherprops="nolang"
|
|
31
|
-
>--help</codeph> parameter lists the commands and their descriptions. For example, to see
|
|
32
|
-
all commands in the <codeph otherprops="nolang">org</codeph> topic, run <codeph
|
|
33
|
-
otherprops="nolang">sfdx force:org -h</codeph>.</p>
|
|
34
|
-
<p>For commands, adding the <codeph otherprops="nolang">-h</codeph> | <codeph otherprops="nolang"
|
|
35
|
-
>--help</codeph> parameter shows parameters and usage information. For example, to see help for
|
|
36
|
-
the <codeph otherprops="nolang">org:create</codeph> command, run <codeph otherprops="nolang">sfdx
|
|
37
|
-
force:org:create -h</codeph>.</p>
|
|
38
|
-
<p>Help for commands has four parts.<ol>
|
|
26
|
+
<p>The short <codeph otherprops="nolang">-h</codeph> flag shows a subset of the command-line
|
|
27
|
+
help and is meant for quick reference. The long <codeph otherprops="nolang">--help</codeph>
|
|
28
|
+
flag shows the complete command-line help. </p>
|
|
29
|
+
<p>The short help (<codeph otherprops="nolang">-h</codeph>) for commands has these parts.<ol>
|
|
39
30
|
<li><b>Short Description of Command</b><p>At the top of the <codeph otherprops="nolang"
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
Reference</cite>.</p></li>
|
|
31
|
+
>-h</codeph> output (with no heading), a short description of the command is shown.
|
|
32
|
+
</p></li>
|
|
43
33
|
<li><b>Usage</b><p>The command signature on the Usage line uses the docopt format.<ul>
|
|
44
|
-
<li>All available
|
|
45
|
-
|
|
46
|
-
<li>
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
<li>
|
|
52
|
-
|
|
53
|
-
parameter name, separated by pipes (<codeph otherprops="nolang">--parametername
|
|
34
|
+
<li>All available flags are listed. Flags that have short names are listed using their
|
|
35
|
+
short names.</li>
|
|
36
|
+
<li>Flags that take a value show <codeph otherprops="nolang"><value></codeph>
|
|
37
|
+
immediately after the flag’s name.</li>
|
|
38
|
+
<li>Optional flags are in square brackets (<codeph otherprops="nolang">[ …
|
|
39
|
+
]</codeph>).</li>
|
|
40
|
+
<li>Required flags have no annotation.</li>
|
|
41
|
+
<li>For flags that accept a limited set of values, the values are shown after the flag
|
|
42
|
+
name, separated by pipes (<codeph otherprops="nolang">--flagname
|
|
54
43
|
value1|value2|value3</codeph>).</li>
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
<li><b>
|
|
74
|
-
Description section. This information is also available in the <cite>Salesforce CLI
|
|
75
|
-
Command Reference</cite>.</p></li>
|
|
44
|
+
</ul></p></li>
|
|
45
|
+
<li><b>Flags</b><p>The Flags section lists all the command’s flags, including their short
|
|
46
|
+
name, long name, and purpose. Flags are grouped for easier reading, such as global flags
|
|
47
|
+
and other groups relevant to a specific command. </p><p>For flags that take multiple
|
|
48
|
+
values, you have two ways to specify the values:<ul>
|
|
49
|
+
<li>Specify the flag multiple times, where each flag takes a different single
|
|
50
|
+
value.</li>
|
|
51
|
+
<li>Specify the flag one time, but separate all the values with a space.</li>
|
|
52
|
+
</ul></p><p>For example, the following commands are
|
|
53
|
+
equivalent:<codeblock otherprops="nolang">sf deploy metadata --metadata ApexClass --metadata CustomObject --metadata AnotherCustomObject
|
|
54
|
+
sf deploy metadata --metadata ApexClass CustomObject AnotherCustomObject</codeblock></p><p>Flags
|
|
55
|
+
that accept a limited list of values include the values in parentheses, with the default
|
|
56
|
+
value specified with the <codeph otherprops="nolang">default</codeph> keyword. </p></li>
|
|
57
|
+
</ol></p>
|
|
58
|
+
<p>The long help (<codeph otherprops="nolang">--help</codeph>) for commands has the same parts
|
|
59
|
+
as the preceding short help <codeph otherprops="nolang">-h</codeph>) and these additional parts.<ol>
|
|
60
|
+
<li><b>Description</b><p>Usage notes. </p></li>
|
|
61
|
+
<li><b>Examples</b><p>All examples include a brief description.</p></li>
|
|
62
|
+
<li><b>Flag Descriptions</b><p>Some flags have optional additional usage notes.</p></li>
|
|
76
63
|
</ol></p>
|
|
77
64
|
</conbody>
|
|
78
65
|
</concept>
|
|
@@ -10,9 +10,8 @@ IF YOU WANT TO CHANGE THIS CONTENT, CONTACT juliet.shackell@salesforce.com FOR D
|
|
|
10
10
|
|
|
11
11
|
-->
|
|
12
12
|
<!--This is a static file that should be passed as-is through the autogen process.-->
|
|
13
|
-
<title>
|
|
14
|
-
|
|
15
|
-
their parameters. </shortdesc>
|
|
13
|
+
<title>sf</title>
|
|
14
|
+
<shortdesc>This section contains information about the <codeph otherprops="nolang">sf</codeph> commands and their parameters. </shortdesc>
|
|
16
15
|
<prolog>
|
|
17
16
|
<metadata>
|
|
18
17
|
<othermeta content="reference" name="topic_type"/>
|
|
@@ -24,8 +23,8 @@ IF YOU WANT TO CHANGE THIS CONTENT, CONTACT juliet.shackell@salesforce.com FOR D
|
|
|
24
23
|
</prolog>
|
|
25
24
|
<refbody>
|
|
26
25
|
<section>
|
|
27
|
-
<p>This version of the command reference includes details about version
|
|
28
|
-
{{cliVersion}} of Salesforce CLI and the following plug-in versions:</p>
|
|
26
|
+
<p>This version of the <codeph otherprops="nolang">sf</codeph> command reference includes details about version
|
|
27
|
+
{{cliVersion}} of the <codeph otherprops="nolang">sf</codeph> executable of Salesforce CLI and the following plug-in versions:</p>
|
|
29
28
|
<ul>
|
|
30
29
|
{{#each pluginVersions}}
|
|
31
30
|
<li><codeph otherprops="nolang">{{name}}</codeph> version {{version}}</li>
|
package/templates/command.hbs
CHANGED
|
@@ -39,6 +39,7 @@ IF YOU WANT TO CHANGE THIS CONTENT, CONTACT juliet.shackell@salesforce.com FOR D
|
|
|
39
39
|
format="html" scope="external" type="new-window:HTML">{{trailblazerCommunityName}}</xref> group in the
|
|
40
40
|
Trailblazer Community.</note>
|
|
41
41
|
</section>{{/if}}{{#if isOpenPilotCommand}}
|
|
42
|
+
</section>{{/if}}{{#if isOpenPilotCommand}}
|
|
42
43
|
<section>
|
|
43
44
|
<note>We provide the <codeph otherprops="nolang">{{name}}</codeph> command to selected customers through a pilot program
|
|
44
45
|
that requires agreement to specific terms and conditions. To be nominated to participate
|
|
@@ -58,7 +59,7 @@ IF YOU WANT TO CHANGE THIS CONTENT, CONTACT juliet.shackell@salesforce.com FOR D
|
|
|
58
59
|
</section>{{/if}}
|
|
59
60
|
{{#if help}}
|
|
60
61
|
<section>
|
|
61
|
-
<title><ph>
|
|
62
|
+
<title><ph>Description for <codeph otherprops="nolang">{{name}}</codeph></ph></title>
|
|
62
63
|
{{#each help}}
|
|
63
64
|
{{#isCodeBlock this}}<codeblock otherprops="nolang">{{this}}</codeblock>{{else}}<p>{{this}}</p>{{/isCodeBlock}}
|
|
64
65
|
{{/each}}
|
|
@@ -78,7 +79,7 @@ IF YOU WANT TO CHANGE THIS CONTENT, CONTACT juliet.shackell@salesforce.com FOR D
|
|
|
78
79
|
</section>
|
|
79
80
|
{{/if}}
|
|
80
81
|
<section>
|
|
81
|
-
<title><ph>
|
|
82
|
+
<title><ph>Usage</ph></title>
|
|
82
83
|
<dl>
|
|
83
84
|
<dlentry>
|
|
84
85
|
<dt><codeph otherprops="nolang">{{binary}} {{name}}</codeph></dt>
|
|
@@ -90,7 +91,7 @@ IF YOU WANT TO CHANGE THIS CONTENT, CONTACT juliet.shackell@salesforce.com FOR D
|
|
|
90
91
|
</section>
|
|
91
92
|
{{#if parameters}}
|
|
92
93
|
<section>
|
|
93
|
-
<title><ph>
|
|
94
|
+
<title><ph>Flags</ph></title>
|
|
94
95
|
<dl>
|
|
95
96
|
{{#each parameters}}
|
|
96
97
|
<dlentry>
|
|
@@ -8,7 +8,7 @@ THIS FILE IS AUTOGENERATED. DON’T MAKE CHANGES TO THIS FILE IN PERFORCE! YOUR
|
|
|
8
8
|
IF YOU WANT TO CHANGE THIS CONTENT, CONTACT juliet.shackell@salesforce.com FOR DETAILS.
|
|
9
9
|
|
|
10
10
|
-->
|
|
11
|
-
<title><codeph otherprops="nolang">{{topic}}</codeph>
|
|
11
|
+
<title><codeph otherprops="nolang">{{topic}}</codeph> Commands</title>
|
|
12
12
|
<topicref href="{{xmlFile 'cli_reference' topic 'commands'}}" type="concept" format="dita" scope="local" chunk="to-content" collection-type="unordered">
|
|
13
13
|
{{#each commands}}
|
|
14
14
|
<topicref href="{{xmlFile 'cli_reference' command}}" type="reference" format="dita" scope="local"/>
|