@salesforce/plugin-command-reference 2.1.1 → 2.2.2
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 +85 -105
- package/LICENSE.txt +1 -1
- package/lib/commands/commandreference/generate.js +8 -8
- package/lib/commands/commandreference/generate.js.map +1 -1
- package/lib/ditamap/ditamap.js +11 -4
- package/lib/ditamap/ditamap.js.map +1 -1
- package/lib/docs.js +2 -2
- package/lib/docs.js.map +1 -1
- package/oclif.manifest.json +1 -1
- package/package.json +103 -102
- package/templates/command.hbs +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -2,120 +2,124 @@
|
|
|
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.2.2](https://github.com/salesforcecli/plugin-command-reference/compare/v2.2.1...v2.2.2) (2022-03-24)
|
|
6
|
+
|
|
7
|
+
### Bug Fixes
|
|
8
|
+
|
|
9
|
+
- remove cli-ux reference ([43c8680](https://github.com/salesforcecli/plugin-command-reference/commit/43c86808eb7b24783b15b703d39c1f49df5fc4f8))
|
|
10
|
+
|
|
11
|
+
### [2.2.1](https://github.com/salesforcecli/plugin-command-reference/compare/v2.2.0...v2.2.1) (2022-03-08)
|
|
12
|
+
|
|
13
|
+
### Bug Fixes
|
|
14
|
+
|
|
15
|
+
- dont run default functions ([264b7bb](https://github.com/salesforcecli/plugin-command-reference/commit/264b7bb02fded86c23c75e6e81b1410aececca08))
|
|
16
|
+
|
|
17
|
+
## [2.2.0](https://github.com/salesforcecli/plugin-command-reference/compare/v2.1.1...v2.2.0) (2022-03-08)
|
|
18
|
+
|
|
19
|
+
### Features
|
|
20
|
+
|
|
21
|
+
- update dependencies ([289c50c](https://github.com/salesforcecli/plugin-command-reference/commit/289c50c026efae4e5708ba9d14c67dac29a9b392))
|
|
22
|
+
|
|
5
23
|
### [2.1.1](https://github.com/salesforcecli/plugin-command-reference/compare/v2.1.0...v2.1.1) (2021-10-13)
|
|
6
24
|
|
|
7
25
|
## [2.1.0](https://github.com/salesforcecli/plugin-command-reference/compare/v2.0.12...v2.1.0) (2021-10-07)
|
|
8
26
|
|
|
9
|
-
|
|
10
27
|
### Features
|
|
11
28
|
|
|
12
|
-
|
|
29
|
+
- add --all ([#38](https://github.com/salesforcecli/plugin-command-reference/issues/38)) ([ecf8fb2](https://github.com/salesforcecli/plugin-command-reference/commit/ecf8fb2539c553aa4acb43206e6bd5bc7d27e6e2))
|
|
13
30
|
|
|
14
31
|
### [2.0.12](https://github.com/salesforcecli/plugin-command-reference/compare/v2.0.11...v2.0.12) (2021-10-01)
|
|
15
32
|
|
|
16
|
-
|
|
17
33
|
### Bug Fixes
|
|
18
34
|
|
|
19
|
-
|
|
35
|
+
- bump to GA deps ([#37](https://github.com/salesforcecli/plugin-command-reference/issues/37)) ([0f0644f](https://github.com/salesforcecli/plugin-command-reference/commit/0f0644f9298f44eec86c0210cf9bce267b3c3cfc))
|
|
20
36
|
|
|
21
37
|
### [2.0.11](https://github.com/salesforcecli/plugin-command-reference/compare/v2.0.10...v2.0.11) (2021-09-20)
|
|
22
38
|
|
|
23
|
-
|
|
24
39
|
### Bug Fixes
|
|
25
40
|
|
|
26
|
-
|
|
41
|
+
- stop generating main topic intro ([ba42e7f](https://github.com/salesforcecli/plugin-command-reference/commit/ba42e7fc66ca88b64658c9b88f9a7209a6953b55))
|
|
27
42
|
|
|
28
43
|
### [2.0.10](https://github.com/salesforcecli/plugin-command-reference/compare/v2.0.9...v2.0.10) (2021-09-16)
|
|
29
44
|
|
|
30
|
-
|
|
31
45
|
### Bug Fixes
|
|
32
46
|
|
|
33
|
-
|
|
47
|
+
- change title/shortdesc of main ditamap so it says "sf" ([48f183e](https://github.com/salesforcecli/plugin-command-reference/commit/48f183ec1be08b265f95baf6bf8bfab72cc932e1))
|
|
34
48
|
|
|
35
49
|
### [2.0.9](https://github.com/salesforcecli/plugin-command-reference/compare/v2.0.8...v2.0.9) (2021-09-16)
|
|
36
50
|
|
|
37
|
-
|
|
38
51
|
### Bug Fixes
|
|
39
52
|
|
|
40
|
-
|
|
53
|
+
- use latest sf-plugins-core ([9366b09](https://github.com/salesforcecli/plugin-command-reference/commit/9366b096cfcbe2fae41b1f6eede805c8d817570b))
|
|
41
54
|
|
|
42
55
|
### [2.0.8](https://github.com/salesforcecli/plugin-command-reference/compare/v2.0.7...v2.0.8) (2021-09-15)
|
|
43
56
|
|
|
44
|
-
|
|
45
57
|
### Bug Fixes
|
|
46
58
|
|
|
47
|
-
|
|
48
|
-
|
|
59
|
+
- update template files for sf ([2a0ca0a](https://github.com/salesforcecli/plugin-command-reference/commit/2a0ca0acc1744b2b090d5c7b3d3a196d127061c9))
|
|
60
|
+
- update test with new title in command XML file ([b9b14ea](https://github.com/salesforcecli/plugin-command-reference/commit/b9b14ea2a8505d153a244ebc0d1e7759e2803a40))
|
|
49
61
|
|
|
50
62
|
### [2.0.7](https://github.com/salesforcecli/plugin-command-reference/compare/v2.0.6...v2.0.7) (2021-09-14)
|
|
51
63
|
|
|
52
|
-
|
|
53
64
|
### Bug Fixes
|
|
54
65
|
|
|
55
|
-
|
|
66
|
+
- improve error handling ([50a8f5a](https://github.com/salesforcecli/plugin-command-reference/commit/50a8f5a7c92307ac2a0b0d3e72cc98e3e679870d))
|
|
56
67
|
|
|
57
68
|
### [2.0.6](https://github.com/salesforcecli/plugin-command-reference/compare/v2.0.5...v2.0.6) (2021-09-09)
|
|
58
69
|
|
|
59
|
-
|
|
60
70
|
### Bug Fixes
|
|
61
71
|
|
|
62
|
-
|
|
72
|
+
- don't generate xml for topics ([60e0056](https://github.com/salesforcecli/plugin-command-reference/commit/60e00563698ce8db4a12077f7866cdbe15fbdf6a))
|
|
63
73
|
|
|
64
74
|
### [2.0.5](https://github.com/salesforcecli/plugin-command-reference/compare/v2.0.4...v2.0.5) (2021-09-08)
|
|
65
75
|
|
|
66
|
-
|
|
67
76
|
### Bug Fixes
|
|
68
77
|
|
|
69
|
-
|
|
78
|
+
- use unique id ([56c946e](https://github.com/salesforcecli/plugin-command-reference/commit/56c946eab0dcb8775bd538ddc80e824aee8b7273))
|
|
70
79
|
|
|
71
80
|
### [2.0.4](https://github.com/salesforcecli/plugin-command-reference/compare/v2.0.3...v2.0.4) (2021-09-08)
|
|
72
81
|
|
|
73
|
-
|
|
74
82
|
### Bug Fixes
|
|
75
83
|
|
|
76
|
-
|
|
84
|
+
- append suffix to all filenames ([6264636](https://github.com/salesforcecli/plugin-command-reference/commit/626463690bc5e6d157949b14dc5b1966e65c5d3f))
|
|
77
85
|
|
|
78
86
|
### [2.0.3](https://github.com/salesforcecli/plugin-command-reference/compare/v2.0.2...v2.0.3) (2021-09-08)
|
|
79
87
|
|
|
80
|
-
|
|
81
88
|
### Bug Fixes
|
|
82
89
|
|
|
83
|
-
|
|
90
|
+
- populate topic command xml ([d8b61e5](https://github.com/salesforcecli/plugin-command-reference/commit/d8b61e51b41192a97de3a166011d0d494606959d))
|
|
84
91
|
|
|
85
92
|
### [2.0.2](https://github.com/salesforcecli/plugin-command-reference/compare/v2.0.1...v2.0.2) (2021-09-08)
|
|
86
93
|
|
|
87
|
-
|
|
88
94
|
### Bug Fixes
|
|
89
95
|
|
|
90
|
-
|
|
96
|
+
- update generate command reference ([d864b2d](https://github.com/salesforcecli/plugin-command-reference/commit/d864b2d5749732e1870e2f59c80c8975b028c21b))
|
|
91
97
|
|
|
92
98
|
### [2.0.1](https://github.com/salesforcecli/plugin-command-reference/compare/v2.0.0...v2.0.1) (2021-09-07)
|
|
93
99
|
|
|
94
|
-
|
|
95
100
|
### Bug Fixes
|
|
96
101
|
|
|
97
|
-
|
|
102
|
+
- use this.config ([de4a137](https://github.com/salesforcecli/plugin-command-reference/commit/de4a137d6e3e5ca8d322e5c45e3e893c6830ff40))
|
|
98
103
|
|
|
99
104
|
## [2.0.0](https://github.com/salesforcecli/plugin-command-reference/compare/v1.3.14...v2.0.0) (2021-09-07)
|
|
100
105
|
|
|
101
|
-
|
|
102
106
|
### ⚠ BREAKING CHANGES
|
|
103
107
|
|
|
104
|
-
|
|
108
|
+
- only works for sf now
|
|
105
109
|
|
|
106
|
-
|
|
110
|
+
- test: update to work with new file structure
|
|
107
111
|
|
|
108
|
-
|
|
112
|
+
- refactor: use oclif/core
|
|
109
113
|
|
|
110
|
-
|
|
114
|
+
- chore: bump to 2.0.0
|
|
111
115
|
|
|
112
|
-
|
|
116
|
+
- chore: satisfy dev-scripts
|
|
113
117
|
|
|
114
|
-
|
|
118
|
+
- chore: code review
|
|
115
119
|
|
|
116
|
-
|
|
120
|
+
- chore: regenerate yarn.lock
|
|
117
121
|
|
|
118
|
-
|
|
122
|
+
- Updates for `sf` (#34) ([6177be2](https://github.com/salesforcecli/plugin-command-reference/commit/6177be292a3895f3226951a763fe4610b5587cd0)), closes [#34](https://github.com/salesforcecli/plugin-command-reference/issues/34)
|
|
119
123
|
|
|
120
124
|
### [1.3.14](https://github.com/forcedotcom/plugin-command-reference/compare/v1.3.13...v1.3.14) (2021-08-13)
|
|
121
125
|
|
|
@@ -139,192 +143,168 @@ All notable changes to this project will be documented in this file. See [standa
|
|
|
139
143
|
|
|
140
144
|
## [1.3.4](https://github.com/forcedotcom/plugin-command-reference/compare/v1.3.3...v1.3.4) (2021-06-04)
|
|
141
145
|
|
|
142
|
-
|
|
143
146
|
### Bug Fixes
|
|
144
147
|
|
|
145
|
-
|
|
148
|
+
- list plug-ins and their version in a <ul> ([f0e3f20](https://github.com/forcedotcom/plugin-command-reference/commit/f0e3f201a19818bac9d714a9a3a00fd0c2721407))
|
|
146
149
|
|
|
147
150
|
## [1.3.3](https://github.com/forcedotcom/plugin-command-reference/compare/v1.3.2...v1.3.3) (2021-05-17)
|
|
148
151
|
|
|
149
|
-
|
|
150
152
|
### Bug Fixes
|
|
151
153
|
|
|
152
|
-
|
|
154
|
+
- async load oclif/core commands ([#26](https://github.com/forcedotcom/plugin-command-reference/issues/26)) ([caa788d](https://github.com/forcedotcom/plugin-command-reference/commit/caa788d4f0efedb5c6e598a6df32e4c65cc4f1b3))
|
|
153
155
|
|
|
154
156
|
## [1.3.2](https://github.com/forcedotcom/plugin-command-reference/compare/v1.3.1...v1.3.2) (2021-05-03)
|
|
155
157
|
|
|
156
|
-
|
|
157
158
|
### Bug Fixes
|
|
158
159
|
|
|
159
|
-
|
|
160
|
+
- force patch release ([9a72942](https://github.com/forcedotcom/plugin-command-reference/commit/9a72942dca2bbdb791a1f765fed067290f365254))
|
|
160
161
|
|
|
161
162
|
## [1.3.1](https://github.com/forcedotcom/plugin-command-reference/compare/v1.3.0...v1.3.1) (2021-05-03)
|
|
162
163
|
|
|
163
|
-
|
|
164
164
|
### Bug Fixes
|
|
165
165
|
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
166
|
+
- add auth to list of plugins ([0a5494a](https://github.com/forcedotcom/plugin-command-reference/commit/0a5494a96bec63c3519ae5ea726d7f5e09e79cef))
|
|
167
|
+
- add back spaces that were mistakenly removed ([381d2f9](https://github.com/forcedotcom/plugin-command-reference/commit/381d2f92966f1dcdfa2149f086b693ad658a548a))
|
|
168
|
+
- bump version 1.3.2 to force release ([2d38cf5](https://github.com/forcedotcom/plugin-command-reference/commit/2d38cf5a5ed6090e51360bbcab5131e13f709893))
|
|
169
|
+
- bump version 1.3.2 to force release ([34d8c00](https://github.com/forcedotcom/plugin-command-reference/commit/34d8c001f9a33b430ea1eeabc884194815ee2d25))
|
|
170
|
+
- fix deprecated warning message ([9fc5219](https://github.com/forcedotcom/plugin-command-reference/commit/9fc5219d476f5456b9ed6d2c9c27216560bbf8bb))
|
|
171
|
+
- undo commit to master ([cbc3195](https://github.com/forcedotcom/plugin-command-reference/commit/cbc31958c4797118159039b466cd4365576bee62))
|
|
172
|
+
- undo commit to master ([47efe40](https://github.com/forcedotcom/plugin-command-reference/commit/47efe40dde6c19782de6a21b89e62f8dc5e2d66a))
|
|
173
173
|
|
|
174
174
|
## [1.3.1](https://github.com/forcedotcom/plugin-command-reference/compare/v1.3.0...v1.3.1) (2021-04-30)
|
|
175
175
|
|
|
176
|
-
|
|
177
176
|
### Bug Fixes
|
|
178
177
|
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
178
|
+
- add auth to list of plugins ([0a5494a](https://github.com/forcedotcom/plugin-command-reference/commit/0a5494a96bec63c3519ae5ea726d7f5e09e79cef))
|
|
179
|
+
- add back spaces that were mistakenly removed ([381d2f9](https://github.com/forcedotcom/plugin-command-reference/commit/381d2f92966f1dcdfa2149f086b693ad658a548a))
|
|
180
|
+
- bump version 1.3.2 to force release ([34d8c00](https://github.com/forcedotcom/plugin-command-reference/commit/34d8c001f9a33b430ea1eeabc884194815ee2d25))
|
|
181
|
+
- fix deprecated warning message ([9fc5219](https://github.com/forcedotcom/plugin-command-reference/commit/9fc5219d476f5456b9ed6d2c9c27216560bbf8bb))
|
|
182
|
+
- undo commit to master ([cbc3195](https://github.com/forcedotcom/plugin-command-reference/commit/cbc31958c4797118159039b466cd4365576bee62))
|
|
183
|
+
- undo commit to master ([47efe40](https://github.com/forcedotcom/plugin-command-reference/commit/47efe40dde6c19782de6a21b89e62f8dc5e2d66a))
|
|
185
184
|
|
|
186
185
|
## [1.3.1](https://github.com/forcedotcom/plugin-command-reference/compare/v1.3.0...v1.3.1) (2021-04-29)
|
|
187
186
|
|
|
188
|
-
|
|
189
187
|
### Bug Fixes
|
|
190
188
|
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
189
|
+
- add auth to list of plugins ([0a5494a](https://github.com/forcedotcom/plugin-command-reference/commit/0a5494a96bec63c3519ae5ea726d7f5e09e79cef))
|
|
190
|
+
- add back spaces that were mistakenly removed ([381d2f9](https://github.com/forcedotcom/plugin-command-reference/commit/381d2f92966f1dcdfa2149f086b693ad658a548a))
|
|
191
|
+
- fix deprecated warning message ([9fc5219](https://github.com/forcedotcom/plugin-command-reference/commit/9fc5219d476f5456b9ed6d2c9c27216560bbf8bb))
|
|
192
|
+
- undo commit to master ([cbc3195](https://github.com/forcedotcom/plugin-command-reference/commit/cbc31958c4797118159039b466cd4365576bee62))
|
|
193
|
+
- undo commit to master ([47efe40](https://github.com/forcedotcom/plugin-command-reference/commit/47efe40dde6c19782de6a21b89e62f8dc5e2d66a))
|
|
196
194
|
|
|
197
195
|
## [1.3.1](https://github.com/forcedotcom/plugin-command-reference/compare/v1.3.0...v1.3.1) (2021-04-29)
|
|
198
196
|
|
|
199
|
-
|
|
200
197
|
### Bug Fixes
|
|
201
198
|
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
199
|
+
- add back spaces that were mistakenly removed ([381d2f9](https://github.com/forcedotcom/plugin-command-reference/commit/381d2f92966f1dcdfa2149f086b693ad658a548a))
|
|
200
|
+
- fix deprecated warning message ([9fc5219](https://github.com/forcedotcom/plugin-command-reference/commit/9fc5219d476f5456b9ed6d2c9c27216560bbf8bb))
|
|
201
|
+
- undo commit to master ([cbc3195](https://github.com/forcedotcom/plugin-command-reference/commit/cbc31958c4797118159039b466cd4365576bee62))
|
|
202
|
+
- undo commit to master ([47efe40](https://github.com/forcedotcom/plugin-command-reference/commit/47efe40dde6c19782de6a21b89e62f8dc5e2d66a))
|
|
206
203
|
|
|
207
204
|
## [1.3.1](https://github.com/forcedotcom/plugin-command-reference/compare/v1.3.0...v1.3.1) (2021-04-29)
|
|
208
205
|
|
|
209
|
-
|
|
210
206
|
### Bug Fixes
|
|
211
207
|
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
208
|
+
- fix deprecated warning message ([9fc5219](https://github.com/forcedotcom/plugin-command-reference/commit/9fc5219d476f5456b9ed6d2c9c27216560bbf8bb))
|
|
209
|
+
- undo commit to master ([cbc3195](https://github.com/forcedotcom/plugin-command-reference/commit/cbc31958c4797118159039b466cd4365576bee62))
|
|
210
|
+
- undo commit to master ([47efe40](https://github.com/forcedotcom/plugin-command-reference/commit/47efe40dde6c19782de6a21b89e62f8dc5e2d66a))
|
|
215
211
|
|
|
216
212
|
## [1.3.1](https://github.com/forcedotcom/plugin-command-reference/compare/v1.3.0...v1.3.1) (2021-04-26)
|
|
217
213
|
|
|
218
|
-
|
|
219
214
|
### Bug Fixes
|
|
220
215
|
|
|
221
|
-
|
|
222
|
-
|
|
216
|
+
- undo commit to master ([cbc3195](https://github.com/forcedotcom/plugin-command-reference/commit/cbc31958c4797118159039b466cd4365576bee62))
|
|
217
|
+
- undo commit to master ([47efe40](https://github.com/forcedotcom/plugin-command-reference/commit/47efe40dde6c19782de6a21b89e62f8dc5e2d66a))
|
|
223
218
|
|
|
224
219
|
## [1.3.1](https://github.com/forcedotcom/plugin-command-reference/compare/v1.3.0...v1.3.1) (2021-04-26)
|
|
225
220
|
|
|
226
|
-
|
|
227
221
|
### Bug Fixes
|
|
228
222
|
|
|
229
|
-
|
|
223
|
+
- undo commit to master ([47efe40](https://github.com/forcedotcom/plugin-command-reference/commit/47efe40dde6c19782de6a21b89e62f8dc5e2d66a))
|
|
230
224
|
|
|
231
225
|
# [1.3.0](https://github.com/forcedotcom/plugin-command-reference/compare/v1.2.6...v1.3.0) (2021-02-02)
|
|
232
226
|
|
|
233
|
-
|
|
234
227
|
### Features
|
|
235
228
|
|
|
236
|
-
|
|
229
|
+
- default to current working directory when no plugins are provided ([#15](https://github.com/forcedotcom/plugin-command-reference/issues/15)) ([57a66b2](https://github.com/forcedotcom/plugin-command-reference/commit/57a66b21093f896adc69d71a3025679770e6e7ad))
|
|
237
230
|
|
|
238
231
|
## [1.2.6](https://github.com/forcedotcom/plugin-command-reference/compare/v1.2.5...v1.2.6) (2021-02-01)
|
|
239
232
|
|
|
240
|
-
|
|
241
233
|
### Bug Fixes
|
|
242
234
|
|
|
243
|
-
|
|
235
|
+
- remove note about "sfdx force:doc:commands:list" ([2378f39](https://github.com/forcedotcom/plugin-command-reference/commit/2378f39a88923c294a2a2cb8c002372e85e819cf))
|
|
244
236
|
|
|
245
237
|
## [1.2.5](https://github.com/forcedotcom/plugin-command-reference/compare/v1.2.4...v1.2.5) (2021-02-01)
|
|
246
238
|
|
|
247
|
-
|
|
248
239
|
### Bug Fixes
|
|
249
240
|
|
|
250
|
-
|
|
241
|
+
- Add list of other plugins as a top-level topic ([800d797](https://github.com/forcedotcom/plugin-command-reference/commit/800d7973a9e1c29a38866b258e20c0006ecf8aa2))
|
|
251
242
|
|
|
252
243
|
## [1.2.4](https://github.com/forcedotcom/plugin-command-reference/compare/v1.2.3...v1.2.4) (2021-01-20)
|
|
253
244
|
|
|
254
|
-
|
|
255
245
|
### Bug Fixes
|
|
256
246
|
|
|
257
|
-
|
|
247
|
+
- remove <ph id="topic-title"> ([2180c1a](https://github.com/forcedotcom/plugin-command-reference/commit/2180c1aaf310fb9cfbda2b947e5f5b77bdf3e226))
|
|
258
248
|
|
|
259
249
|
## [1.2.3](https://github.com/forcedotcom/plugin-command-reference/compare/v1.2.2...v1.2.3) (2020-11-05)
|
|
260
250
|
|
|
261
|
-
|
|
262
251
|
### Bug Fixes
|
|
263
252
|
|
|
264
|
-
|
|
253
|
+
- fix rel notes link to point to main branch ([663483b](https://github.com/forcedotcom/plugin-command-reference/commit/663483bd3aab0f40c68ac6b6327c34a4edce1014))
|
|
265
254
|
|
|
266
255
|
## [1.2.2](https://github.com/forcedotcom/plugin-command-reference/compare/v1.2.1...v1.2.2) (2020-10-28)
|
|
267
256
|
|
|
268
|
-
|
|
269
257
|
### Bug Fixes
|
|
270
258
|
|
|
271
|
-
|
|
259
|
+
- rearrange command xml, rename setup guide, fix rn link ([b1ad787](https://github.com/forcedotcom/plugin-command-reference/commit/b1ad7874958bd2cbe38f19896cfc5964da213488))
|
|
272
260
|
|
|
273
261
|
## [1.2.1](https://github.com/forcedotcom/plugin-command-reference/compare/v1.2.0...v1.2.1) (2020-10-27)
|
|
274
262
|
|
|
275
|
-
|
|
276
263
|
### Bug Fixes
|
|
277
264
|
|
|
278
|
-
|
|
265
|
+
- don't duplicate examples ([cd6328b](https://github.com/forcedotcom/plugin-command-reference/commit/cd6328b5cbc4a58f11d309acade7a67513acaf58))
|
|
279
266
|
|
|
280
267
|
# [1.2.0](https://github.com/forcedotcom/plugin-command-reference/compare/v1.1.5...v1.2.0) (2020-10-21)
|
|
281
268
|
|
|
282
|
-
|
|
283
269
|
### Features
|
|
284
270
|
|
|
285
|
-
|
|
271
|
+
- add aliases and examples ([aaf61ad](https://github.com/forcedotcom/plugin-command-reference/commit/aaf61adf3508f69d899898876f03154218ff5a9b))
|
|
286
272
|
|
|
287
273
|
## [1.1.5](https://github.com/forcedotcom/plugin-command-reference/compare/v1.1.4...v1.1.5) (2020-10-01)
|
|
288
274
|
|
|
289
|
-
|
|
290
275
|
### Bug Fixes
|
|
291
276
|
|
|
292
|
-
|
|
277
|
+
- correct help ([b75dd61](https://github.com/forcedotcom/plugin-command-reference/commit/b75dd61281ec1671e20f9a52078da642ede2e0a6))
|
|
293
278
|
|
|
294
279
|
## [1.1.4](https://github.com/forcedotcom/plugin-command-reference/compare/v1.1.3...v1.1.4) (2020-10-01)
|
|
295
280
|
|
|
296
|
-
|
|
297
281
|
### Bug Fixes
|
|
298
282
|
|
|
299
|
-
|
|
283
|
+
- ensure unique ids ([d51f193](https://github.com/forcedotcom/plugin-command-reference/commit/d51f19350bab150da23575bfa27e94e467df99d6))
|
|
300
284
|
|
|
301
285
|
## [1.1.3](https://github.com/forcedotcom/plugin-command-reference/compare/v1.1.2...v1.1.3) (2020-08-12)
|
|
302
286
|
|
|
303
|
-
|
|
304
287
|
### Bug Fixes
|
|
305
288
|
|
|
306
|
-
|
|
289
|
+
- put back multiple flag descriptions ([4c340a8](https://github.com/forcedotcom/plugin-command-reference/commit/4c340a8f414d2e892e135797754883db040ff89a))
|
|
307
290
|
|
|
308
291
|
## [1.1.2](https://github.com/forcedotcom/plugin-command-reference/compare/v1.1.1...v1.1.2) (2020-08-12)
|
|
309
292
|
|
|
310
|
-
|
|
311
293
|
### Bug Fixes
|
|
312
294
|
|
|
313
|
-
|
|
295
|
+
- return parameters ([c713fd0](https://github.com/forcedotcom/plugin-command-reference/commit/c713fd0f7d3f93f64a7f76b9a430d43aeaca875f))
|
|
314
296
|
|
|
315
297
|
## [1.1.1](https://github.com/forcedotcom/plugin-command-reference/compare/v1.1.0...v1.1.1) (2020-08-06)
|
|
316
298
|
|
|
317
|
-
|
|
318
299
|
### Bug Fixes
|
|
319
300
|
|
|
320
|
-
|
|
301
|
+
- no multiline in description ([0b846b7](https://github.com/forcedotcom/plugin-command-reference/commit/0b846b7931a35e1cad4956fa918ece30650944f9))
|
|
321
302
|
|
|
322
303
|
# [1.1.0](https://github.com/forcedotcom/plugin-command-reference/compare/v1.0.7...v1.1.0) (2020-07-29)
|
|
323
304
|
|
|
324
|
-
|
|
325
305
|
### Features
|
|
326
306
|
|
|
327
|
-
|
|
307
|
+
- support no long description ([4b5dabc](https://github.com/forcedotcom/plugin-command-reference/commit/4b5dabc7acc30bd689bda110484e2c0e345d64da))
|
|
328
308
|
|
|
329
309
|
## [1.0.7](https://github.com/forcedotcom/plugin-command-reference/compare/v1.0.6...v1.0.7) (2020-03-11)
|
|
330
310
|
|
package/LICENSE.txt
CHANGED
|
@@ -8,12 +8,12 @@
|
|
|
8
8
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
9
|
const os = require("os");
|
|
10
10
|
const path = require("path");
|
|
11
|
+
const fs_extra_1 = require("fs-extra");
|
|
11
12
|
const sf_plugins_core_1 = require("@salesforce/sf-plugins-core");
|
|
12
13
|
const core_1 = require("@oclif/core");
|
|
13
14
|
const core_2 = require("@salesforce/core");
|
|
14
15
|
const ts_types_1 = require("@salesforce/ts-types");
|
|
15
16
|
const chalk = require("chalk");
|
|
16
|
-
const cli_ux_1 = require("cli-ux");
|
|
17
17
|
const ditamap_1 = require("../../ditamap/ditamap");
|
|
18
18
|
const docs_1 = require("../../docs");
|
|
19
19
|
const utils_1 = require("../../utils");
|
|
@@ -27,12 +27,12 @@ class CommandReferenceGenerate extends sf_plugins_core_1.SfCommand {
|
|
|
27
27
|
let pluginNames;
|
|
28
28
|
if (!flags.plugins && !flags.all) {
|
|
29
29
|
const pJsonPath = path.join(process.cwd(), 'package.json');
|
|
30
|
-
if (await
|
|
31
|
-
const packageJson = await
|
|
30
|
+
if (await (0, fs_extra_1.pathExists)(pJsonPath)) {
|
|
31
|
+
const packageJson = await (0, fs_extra_1.readJSON)(pJsonPath);
|
|
32
32
|
pluginNames = [(0, ts_types_1.getString)(packageJson, 'name')];
|
|
33
33
|
}
|
|
34
34
|
else {
|
|
35
|
-
throw new core_2.
|
|
35
|
+
throw new core_2.SfError("No plugins provided. Provide the '--plugins' flag or cd into a directory that contains a valid oclif plugin.");
|
|
36
36
|
}
|
|
37
37
|
}
|
|
38
38
|
else if (flags.all) {
|
|
@@ -56,12 +56,12 @@ class CommandReferenceGenerate extends sf_plugins_core_1.SfCommand {
|
|
|
56
56
|
pluginName = `@salesforce/plugin-${pluginName}`;
|
|
57
57
|
plugin = this.getPlugin(pluginName);
|
|
58
58
|
if (!plugin) {
|
|
59
|
-
throw new core_2.
|
|
59
|
+
throw new core_2.SfError(`Plugin ${name} or ${pluginName} not found. Is it installed?`);
|
|
60
60
|
}
|
|
61
61
|
}
|
|
62
62
|
return pluginName;
|
|
63
63
|
});
|
|
64
|
-
|
|
64
|
+
this.log(`Generating command reference for the following plugins:${plugins
|
|
65
65
|
.map((name) => `${os.EOL} - ${name}`)
|
|
66
66
|
.join(', ')}`);
|
|
67
67
|
ditamap_1.Ditamap.outputDir = flags.outputdir;
|
|
@@ -86,7 +86,7 @@ class CommandReferenceGenerate extends sf_plugins_core_1.SfCommand {
|
|
|
86
86
|
await docs.build(await this.loadCommands());
|
|
87
87
|
this.log(`\nWrote generated doc to ${ditamap_1.Ditamap.outputDir}`);
|
|
88
88
|
if (flags.erroronwarnings && warnings.length > 0) {
|
|
89
|
-
throw new core_2.
|
|
89
|
+
throw new core_2.SfError(`Found ${warnings.length} warnings.`);
|
|
90
90
|
}
|
|
91
91
|
return { warnings };
|
|
92
92
|
}
|
|
@@ -101,7 +101,7 @@ class CommandReferenceGenerate extends sf_plugins_core_1.SfCommand {
|
|
|
101
101
|
for (const plugin of plugins) {
|
|
102
102
|
const masterPlugin = this.getPlugin(plugin);
|
|
103
103
|
if (!masterPlugin) {
|
|
104
|
-
throw new core_2.
|
|
104
|
+
throw new core_2.SfError(`Plugin ${plugin} not found. Is it installed?`);
|
|
105
105
|
}
|
|
106
106
|
pluginToParentPlugin[masterPlugin.name] = masterPlugin.name;
|
|
107
107
|
resolveChildPlugins(masterPlugin);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../../src/commands/commandreference/generate.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAEH,yBAAyB;AACzB,6BAA6B;AAC7B,iEAAwD;AACxD,sCAAoC;AAEpC,
|
|
1
|
+
{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../../src/commands/commandreference/generate.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAEH,yBAAyB;AACzB,6BAA6B;AAC7B,uCAAgD;AAChD,iEAAwD;AACxD,sCAAoC;AAEpC,2CAAqD;AACrD,mDAAuF;AACvF,+BAAgC;AAChC,mDAAgD;AAChD,qCAAkC;AAClC,uCAAgD;AAEhD,wDAAwD;AACxD,eAAQ,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;AAC5C,MAAM,QAAQ,GAAG,eAAQ,CAAC,YAAY,CAAC,sCAAsC,EAAE,MAAM,CAAC,CAAC;AAEvF,MAAqB,wBAAyB,SAAQ,2BAAkB;IA6B/D,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAE7D,iBAAO,CAAC,MAAM,GAAG,KAAK,CAAC,gBAAgB,CAAC,CAAC;QAEzC,IAAI,WAAqB,CAAC;QAC1B,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE;YAChC,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,cAAc,CAAC,CAAC;YAC3D,IAAI,MAAM,IAAA,qBAAU,EAAC,SAAS,CAAC,EAAE;gBAC/B,MAAM,WAAW,GAAG,MAAM,IAAA,mBAAQ,EAAC,SAAS,CAAC,CAAC;gBAC9C,WAAW,GAAG,CAAC,IAAA,oBAAS,EAAC,WAAW,EAAE,MAAM,CAAC,CAAC,CAAC;aAChD;iBAAM;gBACL,MAAM,IAAI,cAAO,CACf,8GAA8G,CAC/G,CAAC;aACH;SACF;aAAM,IAAI,KAAK,CAAC,GAAG,EAAE;YACpB,MAAM,MAAM,GAAG;gBACb,QAAQ;gBACR,kBAAkB;gBAClB,+BAA+B;gBAC/B,uCAAuC;aACxC,CAAC;YACF,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SACpG;aAAM;YACL,WAAW,GAAG,KAAK,CAAC,OAAO,CAAC;SAC7B;QAED,MAAM,OAAO,GAAG,WAAW;aACxB,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;aAC9B,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACZ,IAAI,UAAU,GAAG,IAAI,CAAC;YACtB,IAAI,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;YAExC,IAAI,CAAC,MAAM,EAAE;gBACX,UAAU,GAAG,sBAAsB,UAAU,EAAE,CAAC;gBAChD,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;gBACpC,IAAI,CAAC,MAAM,EAAE;oBACX,MAAM,IAAI,cAAO,CAAC,UAAU,IAAI,OAAO,UAAU,8BAA8B,CAAC,CAAC;iBAClF;aACF;YACD,OAAO,UAAU,CAAC;QACpB,CAAC,CAAC,CAAC;QACL,IAAI,CAAC,GAAG,CACN,0DAA0D,OAAO;aAC9D,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO,IAAI,EAAE,CAAC;aACrC,IAAI,CAAC,IAAI,CAAC,EAAE,CAChB,CAAC;QACF,iBAAO,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QAEpC,iBAAO,CAAC,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC;QACvE,iBAAO,CAAC,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAC1C,iBAAO,CAAC,cAAc,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YAC5C,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YACpC,MAAM,OAAO,GAAG,MAAM,IAAI,MAAM,CAAC,OAAO,CAAC;YACzC,IAAI,CAAC,OAAO;gBAAE,MAAM,IAAI,KAAK,CAAC,+BAA+B,IAAI,EAAE,CAAC,CAAC;YACrE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;QAC3B,CAAC,CAAC,CAAC;QAEH,MAAM,IAAI,GAAG,IAAI,WAAI,CACnB,iBAAO,CAAC,SAAS,EACjB,iBAAO,CAAC,OAAO,EACf,KAAK,CAAC,MAAM,EACZ,MAAM,IAAI,CAAC,iBAAiB,EAAE,EAC9B,IAAI,CAAC,WAAW,EAAE,CACnB,CAAC;QAEF,cAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE;YAC/B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,qBAAqB,KAAK,GAAG,CAAC,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,EAAE,CAAC;QACpB,cAAM,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,GAAG,EAAE,EAAE;YAC3B,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC;YACjD,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACrB,CAAC,CAAC,CAAC;QAEH,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;QAC5C,IAAI,CAAC,GAAG,CAAC,4BAA4B,iBAAO,CAAC,SAAS,EAAE,CAAC,CAAC;QAE1D,IAAI,KAAK,CAAC,eAAe,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;YAChD,MAAM,IAAI,cAAO,CAAC,SAAS,QAAQ,CAAC,MAAM,YAAY,CAAC,CAAC;SACzD;QAED,OAAO,EAAE,QAAQ,EAAE,CAAC;IACtB,CAAC;IAEO,SAAS,CAAC,OAAiB;QACjC,MAAM,oBAAoB,GAAY,EAAE,CAAC;QAEzC,MAAM,mBAAmB,GAAG,CAAC,YAAoB,EAAE,EAAE;YACnD,KAAK,MAAM,WAAW,IAAI,YAAY,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,IAAI,EAAE,EAAE;gBAChE,oBAAoB,CAAC,WAAW,CAAC,GAAG,YAAY,CAAC,IAAI,CAAC;gBACtD,mBAAmB,CAAC,IAAA,iBAAM,EAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;aAC1D;QACH,CAAC,CAAC;QAEF,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;YAC5B,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;YAC5C,IAAI,CAAC,YAAY,EAAE;gBACjB,MAAM,IAAI,cAAO,CAAC,UAAU,MAAM,8BAA8B,CAAC,CAAC;aACnE;YACD,oBAAoB,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,IAAI,CAAC;YAC5D,mBAAmB,CAAC,YAAY,CAAC,CAAC;SACnC;QACD,OAAO,oBAAoB,CAAC;IAC9B,CAAC;IAEO,SAAS,CAAC,UAAkB;QAClC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC;IACtE,CAAC;IAEO,KAAK,CAAC,iBAAiB;QAC7B,MAAM,OAAO,GAAwB,EAAE,CAAC;QACxC,MAAM,UAAU,GAAG,EAAE,CAAC;QAEtB,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE;YACtC,wCAAwC;YACxC,IAAI,GAAG,CAAC,UAAU,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE;gBAC9C,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;gBAEjD,IAAI,YAAY,CAAC,MAAM,IAAI,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE;oBACjE,IAAA,iBAAS,EAAC,UAAU,EAAE,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAAoB,CAAC,CAAC;oBAC5E,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;iBAC1C;aACF;SACF;QACD,OAAO,UAAU,CAAC;IACpB,CAAC;IAEO,KAAK,CAAC,YAAY;QACxB,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;YACtD,IAAI;gBACF,IAAI,YAAY,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;gBAC/C,IAAI,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,EAAa,EAAE,GAAG,EAAE,YAAY,EAAE;oBACxD,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,GAAG,CAAC,KAAK,EAAE,YAAY,CAAC,KAAK,CAAC;iBACxD,CAAC,CAAC;gBAEH,gDAAgD;gBAChD,OAAO,YAAY,KAAK,SAAS,EAAE;oBACjC,YAAY,GAAG,MAAM,CAAC,cAAc,CAAC,YAAY,CAAC,IAAI,SAAS,CAAC;oBAChE,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,YAAY,EAAE,GAAG,EAAE;wBACzC,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,YAAY,IAAI,YAAY,CAAC,KAAK,EAAE,GAAG,CAAC,KAAK,CAAC;qBACxE,CAAC,CAAC;iBACJ;gBAED,OAAO,GAAG,CAAC;aACZ;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,MAAM,CAAC,MAAM,CAAC,EAAa,EAAE,GAAG,CAAC,CAAC;aAC1C;QACH,CAAC,CAAC,CAAC;QACH,OAAO,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC/B,CAAC;IAEO,KAAK,CAAC,WAAW,CAAC,OAAO;QAC/B,OAAO,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,KAAK,eAAe,CAAC,CAAC,CAAC,MAAM,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;IACnG,CAAC;IAEO,WAAW;QACjB,OAAO;YACL,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,IAAI,MAAM;YAC7C,cAAc,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,cAAc;YACtD,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK;SACrC,CAAC;IACJ,CAAC;;AAjMH,2CAkMC;AAjMe,oCAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAC;AAExD,8BAAK,GAAG;IACpB,SAAS,EAAE,YAAK,CAAC,MAAM,CAAC;QACtB,IAAI,EAAE,GAAG;QACT,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,0BAA0B,CAAC;QAC5D,OAAO,EAAE,YAAY;KACtB,CAAC;IACF,OAAO,EAAE,YAAK,CAAC,MAAM,CAAC;QACpB,IAAI,EAAE,GAAG;QACT,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,uBAAuB,CAAC;QACzD,QAAQ,EAAE,IAAI;QACd,SAAS,EAAE,CAAC,KAAK,CAAC;KACnB,CAAC;IACF,GAAG,EAAE,YAAK,CAAC,OAAO,CAAC;QACjB,IAAI,EAAE,GAAG;QACT,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,oBAAoB,CAAC;QACtD,SAAS,EAAE,CAAC,SAAS,CAAC;KACvB,CAAC;IACF,gBAAgB,EAAE,YAAK,CAAC,MAAM,CAAC;QAC7B,IAAI,EAAE,GAAG;QACT,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,8BAA8B,CAAC;QAChE,OAAO,EAAE,iBAAO,CAAC,MAAM;KACxB,CAAC;IACF,MAAM,EAAE,YAAK,CAAC,OAAO,CAAC,EAAE,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,uBAAuB,CAAC,EAAE,CAAC;IACpF,eAAe,EAAE,YAAK,CAAC,OAAO,CAAC,EAAE,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,+BAA+B,CAAC,EAAE,CAAC;CACtG,CAAC"}
|
package/lib/ditamap/ditamap.js
CHANGED
|
@@ -8,7 +8,8 @@
|
|
|
8
8
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
9
|
exports.Ditamap = void 0;
|
|
10
10
|
const path_1 = require("path");
|
|
11
|
-
const
|
|
11
|
+
const fs = require("fs/promises");
|
|
12
|
+
const mkdirp = require("mkdirp");
|
|
12
13
|
const debugCreator = require("debug");
|
|
13
14
|
const hb = require("handlebars");
|
|
14
15
|
const debug = debugCreator('commandreference');
|
|
@@ -22,6 +23,12 @@ hb.registerHelper('uniqueId', (...strings) => {
|
|
|
22
23
|
const parts = strings.filter((s) => typeof s === 'string');
|
|
23
24
|
return Ditamap.file(parts.join('_'), 'xml').replace('.xml', '');
|
|
24
25
|
});
|
|
26
|
+
hb.registerHelper('getDefault', function (flagDefault) {
|
|
27
|
+
if (flagDefault && typeof flagDefault !== 'function')
|
|
28
|
+
return `Default value: ${flagDefault}`;
|
|
29
|
+
else
|
|
30
|
+
return '';
|
|
31
|
+
});
|
|
25
32
|
/*
|
|
26
33
|
* Returns true if the string should be formatted as code block in docs
|
|
27
34
|
*/
|
|
@@ -55,9 +62,9 @@ class Ditamap {
|
|
|
55
62
|
return this.destination;
|
|
56
63
|
}
|
|
57
64
|
async write() {
|
|
58
|
-
await
|
|
65
|
+
await mkdirp((0, path_1.dirname)(this.destination));
|
|
59
66
|
const output = await this.transformToDitamap();
|
|
60
|
-
await
|
|
67
|
+
await fs.writeFile(this.destination, output);
|
|
61
68
|
}
|
|
62
69
|
formatParagraphs(textToFormat) {
|
|
63
70
|
return textToFormat ? textToFormat.split('\n').filter((n) => n !== '') : [];
|
|
@@ -71,7 +78,7 @@ class Ditamap {
|
|
|
71
78
|
*/
|
|
72
79
|
async transformToDitamap() {
|
|
73
80
|
debug(`Generating ${this.destination} from ${this.getTemplateFileName()}`);
|
|
74
|
-
const src = await
|
|
81
|
+
const src = await fs.readFile(this.source, 'utf8');
|
|
75
82
|
const template = hb.compile(src);
|
|
76
83
|
return template(this.data);
|
|
77
84
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ditamap.js","sourceRoot":"","sources":["../../src/ditamap/ditamap.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,+BAAqC;AACrC,
|
|
1
|
+
{"version":3,"file":"ditamap.js","sourceRoot":"","sources":["../../src/ditamap/ditamap.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,+BAAqC;AACrC,kCAAkC;AAClC,iCAAiC;AAEjC,sCAAsC;AACtC,iCAAiC;AAEjC,MAAM,KAAK,GAAG,YAAY,CAAC,kBAAkB,CAAC,CAAC;AAE/C,EAAE,CAAC,cAAc,CAAC,aAAa,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC;AAC7D,EAAE,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;AACvD,EAAE,CAAC,cAAc,CAAC,SAAS,EAAE,CAAC,GAAG,OAAO,EAAE,EAAE;IAC1C,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC;IAC3D,OAAO,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC;AAC9C,CAAC,CAAC,CAAC;AACH,EAAE,CAAC,cAAc,CAAC,UAAU,EAAE,CAAC,GAAG,OAAO,EAAE,EAAE;IAC3C,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC;IAC3D,OAAO,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AAClE,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,cAAc,CAAC,YAAY,EAAE,UAAU,WAAW;IACnD,IAAI,WAAW,IAAI,OAAO,WAAW,KAAK,UAAU;QAAE,OAAO,kBAAkB,WAAW,EAAE,CAAC;;QACxF,OAAO,EAAE,CAAC;AACjB,CAAC,CAAC,CAAC;AAEH;;GAEG;AACH,mCAAmC;AACnC,EAAE,CAAC,cAAc,CAAC,aAAa,EAAE,UAAqB,GAAG,EAAE,OAAO;IAChE,OAAO,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC;QAC5G,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC;QAClB,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAC5B,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,cAAc,CAAC,aAAa,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;AAEpE,MAAsB,OAAO;IAkC3B,YAA2B,QAAgB,EAAY,IAAa;QAAzC,aAAQ,GAAR,QAAQ,CAAQ;QAAY,SAAI,GAAJ,IAAI,CAAS;QAClE,IAAI,CAAC,MAAM,GAAG,IAAA,WAAI,EAAC,OAAO,CAAC,YAAY,EAAE,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC;QACrE,IAAI,CAAC,WAAW,GAAG,IAAA,WAAI,EAAC,OAAO,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IACvD,CAAC;IArBM,MAAM,KAAK,MAAM;QACtB,OAAO,OAAO,CAAC,OAAO,CAAC;IACzB,CAAC;IAEM,MAAM,KAAK,MAAM,CAAC,MAAc;QACrC,OAAO,CAAC,OAAO,GAAG,MAAM,CAAC;IAC3B,CAAC;IAEM,MAAM,CAAC,IAAI,CAAC,IAAY,EAAE,GAAW;QAC1C,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,OAAO,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,GAAG,EAAE,CAAC;IAChF,CAAC;IAeM,WAAW;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAEM,iBAAiB;QACtB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAEM,KAAK,CAAC,KAAK;QAChB,MAAM,MAAM,CAAC,IAAA,cAAO,EAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;QACxC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAE/C,MAAM,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IAC/C,CAAC;IAES,gBAAgB,CAAC,YAAqB;QAC9C,OAAO,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC9E,CAAC;IAED;;;;;;OAMG;IACK,KAAK,CAAC,kBAAkB;QAC9B,KAAK,CAAC,cAAc,IAAI,CAAC,WAAW,SAAS,IAAI,CAAC,mBAAmB,EAAE,EAAE,CAAC,CAAC;QAC3E,MAAM,GAAG,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACnD,MAAM,QAAQ,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACjC,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;;AAxEH,0BAyEC;AAxEe,cAAM,GAAG,SAAS,CAAC;AAEnB,oBAAY,GAAG,IAAA,WAAI,EAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC"}
|
package/lib/docs.js
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
*/
|
|
8
8
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
9
|
exports.Docs = void 0;
|
|
10
|
-
const
|
|
10
|
+
const mkdirp = require("mkdirp");
|
|
11
11
|
const ts_types_1 = require("@salesforce/ts-types");
|
|
12
12
|
const chalk = require("chalk");
|
|
13
13
|
const base_ditamap_1 = require("./ditamap/base-ditamap");
|
|
@@ -30,7 +30,7 @@ class Docs {
|
|
|
30
30
|
}
|
|
31
31
|
async build(commands) {
|
|
32
32
|
// Create if doesn't exist
|
|
33
|
-
await
|
|
33
|
+
await mkdirp(this.outputDir);
|
|
34
34
|
await this.populateTemplate(commands);
|
|
35
35
|
}
|
|
36
36
|
async populateTopic(topic, subtopics) {
|
package/lib/docs.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"docs.js","sourceRoot":"","sources":["../src/docs.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;
|
|
1
|
+
{"version":3,"file":"docs.js","sourceRoot":"","sources":["../src/docs.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,iCAAiC;AAEjC,mDAS8B;AAC9B,+BAA+B;AAC/B,yDAAqD;AACrD,2DAAuD;AACvD,+CAA4C;AAC5C,6DAAyD;AACzD,2DAAuD;AACvD,mCAA4C;AAC5C,6DAAyD;AAEzD,SAAS,0BAA0B,CAAC,KAAa;IAC/C,cAAM,CAAC,IAAI,CACT,SAAS,EACT,yBAAyB,KAAK,CAAC,IAAI,CACjC,KAAK,CACN,+GAA+G,CACjH,CAAC;AACJ,CAAC;AAED,MAAa,IAAI;IACf,YACU,SAAiB,EACjB,OAAgB,EAChB,MAAe,EACf,SAAkB,EAClB,OAAgB;QAJhB,cAAS,GAAT,SAAS,CAAQ;QACjB,YAAO,GAAP,OAAO,CAAS;QAChB,WAAM,GAAN,MAAM,CAAS;QACf,cAAS,GAAT,SAAS,CAAS;QAClB,YAAO,GAAP,OAAO,CAAS;IACvB,CAAC;IAEG,KAAK,CAAC,KAAK,CAAC,QAAmB;QACpC,0BAA0B;QAC1B,MAAM,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAE7B,MAAM,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IACxC,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,KAAa,EAAE,SAAgD;QACxF,MAAM,SAAS,GAAG,IAAA,wBAAa,EAC7B,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EACrB,qBAAqB,KAAK,6DAA6D,CACxF,CAAC;QACF,IAAI,WAAW,GAAG,IAAA,mBAAQ,EAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QAClD,IAAI,CAAC,WAAW,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE;YACvC,WAAW,GAAG,IAAA,iBAAS,EAAC,IAAA,mBAAQ,EAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC;YACzD,IAAI,CAAC,WAAW,EAAE;gBAChB,cAAM,CAAC,IAAI,CACT,SAAS,EACT,4BAA4B,KAAK,CAAC,IAAI,CACpC,KAAK,CACN,qHAAqH,CACvH,CAAC;gBACF,OAAO;aACR;SACF;QAED,MAAM,aAAa,GAAG,EAAE,CAAC;QACzB,MAAM,UAAU,GAAG,EAAE,CAAC;QAEtB,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;YAC7C,MAAM,iBAAiB,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;YAC9C,IAAI;gBACF,IAAI,CAAC,IAAA,kBAAO,EAAC,iBAAiB,CAAC,EAAE;oBAC/B,uEAAuE;oBACvE,MAAM,OAAO,GAAG,iBAAiB,CAAC;oBAClC,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAA,uBAAY,EAAC,OAAO,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;oBAClF,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;oBAC9D,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;oBAC5B,SAAS;iBACV;gBAED,MAAM,aAAa,GAAG,IAAA,wBAAa,EAAC,SAAS,CAAC,SAAS,CAAC,CAAC;gBAEzD,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE;oBAC5B,0BAA0B,CAAC,GAAG,KAAK,IAAI,QAAQ,EAAE,CAAC,CAAC;oBACnD,SAAS;iBACV;gBAED,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAE7B,gCAAgC;gBAChC,KAAK,MAAM,OAAO,IAAI,iBAAiB,EAAE;oBACvC,MAAM,SAAS,GAAG,IAAA,uBAAY,EAAC,OAAO,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;oBAChE,MAAM,mBAAmB,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAA,uBAAY,EAAC,GAAG,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;oBAC7G,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAA,uBAAY,EAAC,OAAO,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,mBAAmB,CAAC,MAAM,CAAC,CAAC;oBAE3G,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;oBAClE,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;iBAC7B;aACF;YAAC,OAAO,KAAK,EAAE;gBACd,IAAI,KAAK,CAAC,IAAI,KAAK,0BAA0B,EAAE;oBAC7C,0BAA0B,CAAC,GAAG,KAAK,IAAI,QAAQ,EAAE,CAAC,CAAC;iBACpD;qBAAM;oBACL,cAAM,CAAC,IAAI,CAAC,SAAS,EAAE,0BAA0B,KAAK,IAAI,QAAQ,KAAK,KAAK,CAAC,OAAO,IAAI,CAAC,CAAC;iBAC3F;aACF;SACF;QAED,oDAAoD;QACpD,cAAM,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,EAAE,aAAa,CAAC,CAAC;QAE/C,MAAM,IAAI,8BAAa,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC,KAAK,EAAE,CAAC;QAClD,MAAM,IAAI,4BAAY,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC,KAAK,EAAE,CAAC;QAClD,OAAO,aAAa,CAAC;IACvB,CAAC;IAED;;;;;;OAMG;IACK,uBAAuB,CAAC,QAAmB;QACjD,MAAM,cAAc,GAAsD,EAAE,CAAC;QAE7E,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;YAC9B,IAAI,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;gBAClC,SAAS;aACV;YACD,MAAM,YAAY,GAAG,IAAA,uBAAY,EAAC,OAAO,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACzD,MAAM,aAAa,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;YAEtC,MAAM,MAAM,GAAG,OAAO,CAAC,MAA2B,CAAC;YACnD,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;gBAC7B,0GAA0G;gBAC1G,OAAO,CAAC,KAAK,GAAG,aAAa,CAAC;gBAE9B,MAAM,MAAM,GAAG,cAAc,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC;gBAEnD,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE;oBAC7B,mDAAmD;oBACnD,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC;iBACnC;qBAAM,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE;oBACpC,uDAAuD;oBACvD,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC;iBACnC;qBAAM;oBACL,MAAM,QAAQ,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;oBAEjC,IAAI;wBACF,MAAM,SAAS,GAAG,IAAA,wBAAa,EAAC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAC;wBAC/D,MAAM,aAAa,GAAG,IAAA,wBAAa,EAAC,SAAS,CAAC,SAAS,CAAC,CAAC;wBACzD,IAAI,aAAa,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;4BACxC,SAAS;yBACV;qBACF;oBAAC,OAAO,CAAC,EAAE,GAAE,CAAC,qGAAqG;oBAEpH,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;oBAE5B,MAAM,iBAAiB,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;oBAC3C,IAAI,gBAAgB,GAAG,EAAE,CAAC;oBAC1B,IAAI,iBAAiB,EAAE;wBACrB,gBAAgB,GAAG,IAAA,kBAAO,EAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC;qBACzF;oBACD,IAAA,sBAAW,EAAC,gBAAgB,CAAC,CAAC;oBAC9B,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;oBAC/B,MAAM,CAAC,QAAQ,CAAC,GAAG,gBAAgB,CAAC;iBACrC;gBAED,cAAc,CAAC,aAAa,CAAC,GAAG,MAAM,CAAC;aACxC;SACF;QACD,OAAO,cAAc,CAAC;IACxB,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAAC,QAAmB;QAChD,MAAM,kBAAkB,GAAG,IAAI,CAAC,uBAAuB,CAAC,QAAQ,CAAC,CAAC;QAElE,MAAM,IAAI,4BAAY,EAAE,CAAC,KAAK,EAAE,CAAC;QACjC,MAAM,IAAI,8BAAa,EAAE,CAAC,KAAK,EAAE,CAAC;QAElC,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAE/C,oDAAoD;QACpD,MAAM,IAAI,0BAAW,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,CAAC;QAEtC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE;YAC1B,cAAM,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;YAChC,MAAM,SAAS,GAAG,IAAA,iBAAM,EAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC;YACpD,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;SAC5C;IACH,CAAC;IAEO,kBAAkB,CAAC,SAAiB,EAAE,OAAO,EAAE,eAAuB;QAC5E,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACpD,yEAAyE;QACzE,MAAM,YAAY,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC1C,IAAI,IAAI,CAAC;QACT,IAAI;YACF,IAAI,WAAgC,CAAC;YACrC,KAAK,IAAI,IAAI,YAAY,EAAE;gBACzB,IAAI,WAAW,EAAE;oBACf,MAAM,SAAS,GAAG,IAAA,wBAAa,EAAC,WAAW,CAAC,SAAS,CAAC,CAAC;oBACvD,WAAW,GAAG,IAAA,wBAAa,EAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;iBAC9C;qBAAM;oBACL,WAAW,GAAG,IAAA,wBAAa,EAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;iBACnD;gBAED,+GAA+G;gBAC/G,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;aACzC;SACF;QAAC,OAAO,KAAK,EAAE;YACd,IAAI,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;gBAC5B,+FAA+F;gBAC/F,OAAO,WAAW,CAAC;aACpB;iBAAM;gBACL,IAAI,eAAe,KAAK,CAAC,EAAE;oBACzB,cAAM,CAAC,IAAI,CAAC,SAAS,EAAE,aAAa,IAAI,gCAAgC,SAAS,EAAE,CAAC,CAAC;iBACtF;qBAAM;oBACL,kGAAkG;oBAClG,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE;wBAC5B,WAAW,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;wBAC9C,WAAW,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,IAAI,IAAA,iBAAS,EAAC,OAAO,CAAC,WAAW,CAAC,CAAC;qBACzF;iBACF;aACF;SACF;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;IAEO,KAAK,CAAC,eAAe,CAAC,KAAa,EAAE,QAAgB,EAAE,OAAmB,EAAE,WAAoB;QACtG,oCAAoC;QACpC,IAAI,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YAClC,OAAO,EAAE,CAAC;SACX;QAED,MAAM,cAAc,GAAG,IAAI,iBAAO,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;QAC1E,MAAM,cAAc,CAAC,KAAK,EAAE,CAAC;QAC7B,OAAO,cAAc,CAAC,WAAW,EAAE,CAAC;IACtC,CAAC;CACF;AAjND,oBAiNC"}
|
package/oclif.manifest.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":"2.
|
|
1
|
+
{"version":"2.2.2","commands":{"commandreference:generate":{"id":"commandreference:generate","description":"generate the command reference guide located","strict":true,"pluginName":"@salesforce/plugin-command-reference","pluginAlias":"@salesforce/plugin-command-reference","pluginType":"core","aliases":[],"flags":{"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"outputdir":{"name":"outputdir","type":"option","char":"d","description":"output directory to put generated files","multiple":false,"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","multiple":true,"exclusive":["all"]},"all":{"name":"all","type":"boolean","char":"a","description":"include all relevant plugins in the generation","allowNo":false,"exclusive":["plugins"]},"ditamap-suffix":{"name":"ditamap-suffix","type":"option","char":"s","description":"unique suffix to append to generated ditamap","multiple":false,"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":[],"_globalFlags":{"json":{"description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false,"type":"boolean"}}}}}
|
package/package.json
CHANGED
|
@@ -1,105 +1,106 @@
|
|
|
1
1
|
{
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
"@oclif/plugin-help": "^5.1.1",
|
|
19
|
-
"@salesforce/dev-config": "^2.1.2",
|
|
20
|
-
"@salesforce/dev-scripts": "^0.9.18",
|
|
21
|
-
"@salesforce/plugin-login": "^1.0.0",
|
|
22
|
-
"@salesforce/prettier-config": "^0.0.2",
|
|
23
|
-
"@typescript-eslint/eslint-plugin": "^4.2.0",
|
|
24
|
-
"@typescript-eslint/parser": "^4.2.0",
|
|
25
|
-
"chai": "^4.2.0",
|
|
26
|
-
"eslint": "^6.8.0",
|
|
27
|
-
"eslint-config-prettier": "^6.11.0",
|
|
28
|
-
"eslint-config-salesforce": "^0.1.6",
|
|
29
|
-
"eslint-config-salesforce-license": "^0.1.6",
|
|
30
|
-
"eslint-config-salesforce-typescript": "^0.2.7",
|
|
31
|
-
"eslint-plugin-header": "^3.0.0",
|
|
32
|
-
"eslint-plugin-import": "^2.20.2",
|
|
33
|
-
"eslint-plugin-jsdoc": "^27.0.3",
|
|
34
|
-
"eslint-plugin-prettier": "^3.1.3",
|
|
35
|
-
"husky": "^4.3.8",
|
|
36
|
-
"mocha": "^8.4.0",
|
|
37
|
-
"nyc": "^15.1.0",
|
|
38
|
-
"oclif": "^2.0.0-main.5",
|
|
39
|
-
"prettier": "^2.0.5",
|
|
40
|
-
"pretty-quick": "^3.1.0",
|
|
41
|
-
"shx": "^0.3.3",
|
|
42
|
-
"sinon": "10.0.0",
|
|
43
|
-
"ts-node": "^10.0.0",
|
|
44
|
-
"typescript": "^4.1.3"
|
|
45
|
-
},
|
|
46
|
-
"engines": {
|
|
47
|
-
"node": ">=12.0.0"
|
|
48
|
-
},
|
|
49
|
-
"files": [
|
|
50
|
-
"/lib",
|
|
51
|
-
"/messages",
|
|
52
|
-
"/npm-shrinkwrap.json",
|
|
53
|
-
"/oclif.manifest.json",
|
|
54
|
-
"/templates"
|
|
55
|
-
],
|
|
56
|
-
"homepage": "https://github.com/salesforcecli/plugin-command-reference",
|
|
57
|
-
"keywords": [
|
|
58
|
-
"sfdx-plugin"
|
|
59
|
-
],
|
|
60
|
-
"license": "BSD-3-Clause",
|
|
61
|
-
"oclif": {
|
|
62
|
-
"commands": "./lib/commands",
|
|
63
|
-
"bin": "sf",
|
|
64
|
-
"topicSeparator": " ",
|
|
65
|
-
"topics": {
|
|
66
|
-
"commandreference": {
|
|
67
|
-
"description": "generate the Salesforce CLI command reference guide.",
|
|
68
|
-
"longDescription": "xx"
|
|
69
|
-
}
|
|
2
|
+
"name": "@salesforce/plugin-command-reference",
|
|
3
|
+
"description": "Generate the Salesforce CLI command reference guide",
|
|
4
|
+
"version": "2.2.2",
|
|
5
|
+
"author": "Salesforce",
|
|
6
|
+
"bugs": "https://github.com/salesforcecli/plugin-command-reference/issues",
|
|
7
|
+
"dependencies": {
|
|
8
|
+
"@oclif/core": "^1.5.2",
|
|
9
|
+
"@salesforce/core": "^3.7.9",
|
|
10
|
+
"@salesforce/kit": "^1.5.17",
|
|
11
|
+
"@salesforce/sf-plugins-core": "^1.6.0",
|
|
12
|
+
"@salesforce/ts-types": "^1.5.20",
|
|
13
|
+
"chalk": "^3.0.0",
|
|
14
|
+
"fs-extra": "^10.0.1",
|
|
15
|
+
"handlebars": "^4.7.7",
|
|
16
|
+
"mkdirp": "^1.0.4",
|
|
17
|
+
"tslib": "^2"
|
|
70
18
|
},
|
|
71
|
-
"
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
19
|
+
"devDependencies": {
|
|
20
|
+
"@oclif/plugin-help": "^5.1.1",
|
|
21
|
+
"@salesforce/dev-config": "^3.0.1",
|
|
22
|
+
"@salesforce/dev-scripts": "^2.0.1",
|
|
23
|
+
"@salesforce/plugin-login": "^1.0.0",
|
|
24
|
+
"@salesforce/prettier-config": "^0.0.2",
|
|
25
|
+
"@types/fs-extra": "^9.0.13",
|
|
26
|
+
"@typescript-eslint/eslint-plugin": "^4.2.0",
|
|
27
|
+
"@typescript-eslint/parser": "^4.2.0",
|
|
28
|
+
"chai": "^4.2.0",
|
|
29
|
+
"eslint": "^6.8.0",
|
|
30
|
+
"eslint-config-prettier": "^6.11.0",
|
|
31
|
+
"eslint-config-salesforce": "^0.1.6",
|
|
32
|
+
"eslint-config-salesforce-license": "^0.1.6",
|
|
33
|
+
"eslint-config-salesforce-typescript": "^0.2.7",
|
|
34
|
+
"eslint-plugin-header": "^3.0.0",
|
|
35
|
+
"eslint-plugin-import": "^2.20.2",
|
|
36
|
+
"eslint-plugin-jsdoc": "^27.0.3",
|
|
37
|
+
"eslint-plugin-prettier": "^3.1.3",
|
|
38
|
+
"husky": "^7.0.4",
|
|
39
|
+
"mocha": "^9.1.3",
|
|
40
|
+
"nyc": "^15.1.0",
|
|
41
|
+
"oclif": "^2.5.0",
|
|
42
|
+
"prettier": "^2.0.5",
|
|
43
|
+
"pretty-quick": "^3.1.0",
|
|
44
|
+
"shx": "^0.3.3",
|
|
45
|
+
"sinon": "10.0.0",
|
|
46
|
+
"ts-node": "^10.0.0",
|
|
47
|
+
"typescript": "^4.1.3"
|
|
48
|
+
},
|
|
49
|
+
"engines": {
|
|
50
|
+
"node": ">=12.0.0"
|
|
51
|
+
},
|
|
52
|
+
"files": [
|
|
53
|
+
"/lib",
|
|
54
|
+
"/messages",
|
|
55
|
+
"/npm-shrinkwrap.json",
|
|
56
|
+
"/oclif.manifest.json",
|
|
57
|
+
"/templates"
|
|
58
|
+
],
|
|
59
|
+
"homepage": "https://github.com/salesforcecli/plugin-command-reference",
|
|
60
|
+
"keywords": [
|
|
61
|
+
"sfdx-plugin"
|
|
62
|
+
],
|
|
63
|
+
"license": "BSD-3-Clause",
|
|
64
|
+
"oclif": {
|
|
65
|
+
"commands": "./lib/commands",
|
|
66
|
+
"bin": "sf",
|
|
67
|
+
"topicSeparator": " ",
|
|
68
|
+
"topics": {
|
|
69
|
+
"commandreference": {
|
|
70
|
+
"description": "generate the Salesforce CLI command reference guide.",
|
|
71
|
+
"longDescription": "xx"
|
|
72
|
+
}
|
|
73
|
+
},
|
|
74
|
+
"devPlugins": [
|
|
75
|
+
"@oclif/plugin-help",
|
|
76
|
+
"@salesforce/plugin-login"
|
|
77
|
+
]
|
|
78
|
+
},
|
|
79
|
+
"repository": "salesforcecli/plugin-command-reference",
|
|
80
|
+
"scripts": {
|
|
81
|
+
"build": "sf-build",
|
|
82
|
+
"clean": "sf-clean",
|
|
83
|
+
"clean-all": "sf-clean all",
|
|
84
|
+
"clean:lib": "shx rm -rf lib && shx rm -rf coverage && shx rm -rf .nyc_output && shx rm -f oclif.manifest.json",
|
|
85
|
+
"command-reference": "./bin/dev commandreference:generate --plugins login --outputdir test/tmp",
|
|
86
|
+
"compile": "sf-compile",
|
|
87
|
+
"docs": "sf-docs",
|
|
88
|
+
"format": "sf-format",
|
|
89
|
+
"lint": "sf-lint",
|
|
90
|
+
"postpack": "shx rm -f oclif.manifest.json",
|
|
91
|
+
"posttest": "yarn lint",
|
|
92
|
+
"prepack": "sf-prepack",
|
|
93
|
+
"prepare": "sf-install",
|
|
94
|
+
"pretest": "sf-compile-test && yarn command-reference",
|
|
95
|
+
"test": "sf-test",
|
|
96
|
+
"version": "oclif readme"
|
|
97
|
+
},
|
|
98
|
+
"publishConfig": {
|
|
99
|
+
"access": "public"
|
|
100
|
+
},
|
|
101
|
+
"main": "lib/index.js",
|
|
102
|
+
"sfdx": {
|
|
103
|
+
"publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-command-reference/2.2.2.crt",
|
|
104
|
+
"signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-command-reference/2.2.2.sig"
|
|
100
105
|
}
|
|
101
|
-
|
|
102
|
-
"publishConfig": {
|
|
103
|
-
"access": "public"
|
|
104
|
-
}
|
|
105
|
-
}
|
|
106
|
+
}
|
package/templates/command.hbs
CHANGED
|
@@ -100,8 +100,8 @@ IF YOU WANT TO CHANGE THIS CONTENT, CONTACT juliet.shackell@salesforce.com FOR D
|
|
|
100
100
|
{{/if}}<dd>{{#if optional}}Optional{{else}}Required{{/if}}</dd>
|
|
101
101
|
<dd>{{#each description}}<p>{{[]}}</p>{{/each}}</dd>{{#if kind}}
|
|
102
102
|
<dd>Type: {{kind}}</dd>{{/if}}{{#if options}}
|
|
103
|
-
<dd>Permissible values are: {{join options}}</dd>{{/if}}
|
|
104
|
-
<dd>
|
|
103
|
+
<dd>Permissible values are: {{join options}}</dd>{{/if}}
|
|
104
|
+
<dd>{{getDefault default}}</dd>
|
|
105
105
|
</dlentry>
|
|
106
106
|
{{/each}}
|
|
107
107
|
</dl>
|