Skip to content

Commit 53f4ee1

Browse files
committed
chore(release): 3.0.34 [skip ci]
1 parent fc7b59a commit 53f4ee1

File tree

3 files changed

+54
-4
lines changed

3 files changed

+54
-4
lines changed

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
## [3.0.34](https://github.com/salesforcecli/plugin-command-reference/compare/3.0.33...3.0.34) (2023-09-24)
2+
3+
### Bug Fixes
4+
5+
- **deps:** bump @salesforce/core from 5.2.9 to 5.2.10 ([e973fe7](https://github.com/salesforcecli/plugin-command-reference/commit/e973fe71404b46e7dd2d9d25eada1bfe20256523))
6+
17
## [3.0.33](https://github.com/salesforcecli/plugin-command-reference/compare/3.0.32...3.0.33) (2023-09-17)
28

39
### Bug Fixes

README.md

Lines changed: 47 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,29 +82,73 @@ Now diff the output. Changes should be intentional!
8282
<!-- commands -->
8383

8484
- [`sf commandreference generate`](#sf-commandreference-generate)
85+
- [`sf jit install`](#sf-jit-install)
8586

8687
## `sf commandreference generate`
8788

8889
generate the command reference guide located
8990

9091
```
9192
USAGE
92-
$ sf commandreference generate [--json] [-d <value>] [-p <value> | -a] [-s <value>] [--hidden] [--erroronwarnings]
93+
$ sf commandreference generate [--json] [-d <value>] [-p <value> | -a] [-s <value>] [--hidden] [--error-on-warnings] [-c
94+
<value>]
9395
9496
FLAGS
9597
-a, --all include all relevant plugins in the generation
96-
-d, --outputdir=<value> [default: ./tmp/root] output directory to put generated files
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
97100
-p, --plugins=<value>... comma separated list of plugin names to be part of the generation. Defaults to the oclif
98101
plugin in the current working directory
99102
-s, --ditamap-suffix=<value> [default: unified] unique suffix to append to generated ditamap
100-
--erroronwarnings fail the command if there are any warnings
103+
--error-on-warnings fail the command if there are any warnings
101104
--hidden show hidden commands
102105
103106
GLOBAL FLAGS
104107
--json Format output as json.
105108
106109
DESCRIPTION
107110
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
108150
```
109151

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+
110154
<!-- commandsstop -->

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@salesforce/plugin-command-reference",
33
"description": "Generate the Salesforce CLI command reference guide",
4-
"version": "3.0.33",
4+
"version": "3.0.34",
55
"author": "Salesforce",
66
"bugs": "https://github.com/salesforcecli/plugin-command-reference/issues",
77
"dependencies": {

0 commit comments

Comments
 (0)