@salesforce/plugin-command-reference 3.0.33 → 3.0.34
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/README.md +47 -3
- package/oclif.manifest.json +1 -1
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -82,6 +82,7 @@ Now diff the output. Changes should be intentional!
|
|
|
82
82
|
<!-- commands -->
|
|
83
83
|
|
|
84
84
|
- [`sf commandreference generate`](#sf-commandreference-generate)
|
|
85
|
+
- [`sf jit install`](#sf-jit-install)
|
|
85
86
|
|
|
86
87
|
## `sf commandreference generate`
|
|
87
88
|
|
|
@@ -89,15 +90,17 @@ generate the command reference guide located
|
|
|
89
90
|
|
|
90
91
|
```
|
|
91
92
|
USAGE
|
|
92
|
-
$ sf commandreference generate [--json] [-d <value>] [-p <value> | -a] [-s <value>] [--hidden] [--
|
|
93
|
+
$ sf commandreference generate [--json] [-d <value>] [-p <value> | -a] [-s <value>] [--hidden] [--error-on-warnings] [-c
|
|
94
|
+
<value>]
|
|
93
95
|
|
|
94
96
|
FLAGS
|
|
95
97
|
-a, --all include all relevant plugins in the generation
|
|
96
|
-
-
|
|
98
|
+
-c, --config-path=<value> A path to the directory containing a plugin or cli
|
|
99
|
+
-d, --output-dir=<value> [default: ./tmp/root] output directory to put generated files
|
|
97
100
|
-p, --plugins=<value>... comma separated list of plugin names to be part of the generation. Defaults to the oclif
|
|
98
101
|
plugin in the current working directory
|
|
99
102
|
-s, --ditamap-suffix=<value> [default: unified] unique suffix to append to generated ditamap
|
|
100
|
-
--
|
|
103
|
+
--error-on-warnings fail the command if there are any warnings
|
|
101
104
|
--hidden show hidden commands
|
|
102
105
|
|
|
103
106
|
GLOBAL FLAGS
|
|
@@ -105,6 +108,47 @@ GLOBAL FLAGS
|
|
|
105
108
|
|
|
106
109
|
DESCRIPTION
|
|
107
110
|
generate the command reference guide located
|
|
111
|
+
|
|
112
|
+
generate the command reference guide located
|
|
113
|
+
|
|
114
|
+
EXAMPLES
|
|
115
|
+
Generate the command reference guide
|
|
116
|
+
|
|
117
|
+
$ sf commandreference generate
|
|
118
|
+
|
|
119
|
+
Generate the command reference for a set of plugins
|
|
120
|
+
|
|
121
|
+
$ sf commandreference generate --plugins pluginA,pluginB
|
|
122
|
+
|
|
123
|
+
Generate the command reference for all plugins
|
|
124
|
+
|
|
125
|
+
$ sf commandreference generate --all --output-dir ./docs
|
|
126
|
+
|
|
127
|
+
Generate the command reference for all plugins in a directory
|
|
128
|
+
|
|
129
|
+
$ sf commandreference generate --all --config-path /path/to/plugin --output-dir ./docs
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
_See code: [src/commands/commandreference/generate.ts](https://github.com/salesforcecli/plugin-command-reference/blob/3.0.34/src/commands/commandreference/generate.ts)_
|
|
133
|
+
|
|
134
|
+
## `sf jit install`
|
|
135
|
+
|
|
136
|
+
Install all JIT plugins.
|
|
137
|
+
|
|
138
|
+
```
|
|
139
|
+
USAGE
|
|
140
|
+
$ sf jit install [--json] [-d]
|
|
141
|
+
|
|
142
|
+
FLAGS
|
|
143
|
+
-d, --dry-run List the plugins that would be installed.
|
|
144
|
+
|
|
145
|
+
GLOBAL FLAGS
|
|
146
|
+
--json Format output as json.
|
|
147
|
+
|
|
148
|
+
EXAMPLES
|
|
149
|
+
$ sf jit install
|
|
108
150
|
```
|
|
109
151
|
|
|
152
|
+
_See code: [src/commands/jit/install.ts](https://github.com/salesforcecli/plugin-command-reference/blob/3.0.34/src/commands/jit/install.ts)_
|
|
153
|
+
|
|
110
154
|
<!-- commandsstop -->
|
package/oclif.manifest.json
CHANGED
package/package.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@salesforce/plugin-command-reference",
|
|
3
3
|
"description": "Generate the Salesforce CLI command reference guide",
|
|
4
|
-
"version": "3.0.
|
|
4
|
+
"version": "3.0.34",
|
|
5
5
|
"author": "Salesforce",
|
|
6
6
|
"bugs": "https://github.com/salesforcecli/plugin-command-reference/issues",
|
|
7
7
|
"dependencies": {
|
|
8
8
|
"@oclif/core": "^2.15.0",
|
|
9
|
-
"@salesforce/core": "^5.2.
|
|
9
|
+
"@salesforce/core": "^5.2.10",
|
|
10
10
|
"@salesforce/kit": "^3.0.9",
|
|
11
11
|
"@salesforce/sf-plugins-core": "^3.1.22",
|
|
12
12
|
"@salesforce/ts-types": "^2.0.7",
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
"@oclif/plugin-help": "^5.2.19",
|
|
19
19
|
"@salesforce/dev-config": "^4.0.1",
|
|
20
20
|
"@salesforce/dev-scripts": "^5.10.0",
|
|
21
|
-
"@salesforce/plugin-auth": "^2.8.
|
|
21
|
+
"@salesforce/plugin-auth": "^2.8.17",
|
|
22
22
|
"@salesforce/prettier-config": "^0.0.3",
|
|
23
23
|
"@types/debug": "^4.1.8",
|
|
24
24
|
"@types/ejs": "^3.1.2",
|
|
@@ -37,14 +37,14 @@
|
|
|
37
37
|
"husky": "^8.0.3",
|
|
38
38
|
"mocha": "^10.2.0",
|
|
39
39
|
"nyc": "^15.1.0",
|
|
40
|
-
"oclif": "^3.
|
|
40
|
+
"oclif": "^3.16.0",
|
|
41
41
|
"prettier": "^2.8.8",
|
|
42
42
|
"pretty-quick": "^3.1.0",
|
|
43
43
|
"shx": "^0.3.3",
|
|
44
44
|
"sinon": "10.0.0",
|
|
45
45
|
"ts-node": "^10.0.0",
|
|
46
46
|
"typescript": "^4.9.5",
|
|
47
|
-
"wireit": "^0.
|
|
47
|
+
"wireit": "^0.14.0"
|
|
48
48
|
},
|
|
49
49
|
"engines": {
|
|
50
50
|
"node": ">=16.0.0"
|