@salesforce/plugin-command-reference 2.0.12 → 2.2.0
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 +80 -103
- package/LICENSE.txt +1 -1
- package/README.md +2 -1
- package/lib/commands/commandreference/generate.d.ts +1 -0
- package/lib/commands/commandreference/generate.js +23 -7
- package/lib/commands/commandreference/generate.js.map +1 -1
- package/lib/ditamap/ditamap.js +5 -4
- package/lib/ditamap/ditamap.js.map +1 -1
- package/lib/docs.js +2 -2
- package/lib/docs.js.map +1 -1
- package/messages/main.json +1 -0
- package/oclif.manifest.json +1 -1
- package/package.json +103 -102
package/CHANGELOG.md
CHANGED
|
@@ -2,111 +2,112 @@
|
|
|
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
|
-
|
|
5
|
+
## [2.2.0](https://github.com/salesforcecli/plugin-command-reference/compare/v2.1.1...v2.2.0) (2022-03-08)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
- update dependencies ([289c50c](https://github.com/salesforcecli/plugin-command-reference/commit/289c50c026efae4e5708ba9d14c67dac29a9b392))
|
|
10
|
+
|
|
11
|
+
### [2.1.1](https://github.com/salesforcecli/plugin-command-reference/compare/v2.1.0...v2.1.1) (2021-10-13)
|
|
12
|
+
|
|
13
|
+
## [2.1.0](https://github.com/salesforcecli/plugin-command-reference/compare/v2.0.12...v2.1.0) (2021-10-07)
|
|
6
14
|
|
|
15
|
+
### Features
|
|
16
|
+
|
|
17
|
+
- add --all ([#38](https://github.com/salesforcecli/plugin-command-reference/issues/38)) ([ecf8fb2](https://github.com/salesforcecli/plugin-command-reference/commit/ecf8fb2539c553aa4acb43206e6bd5bc7d27e6e2))
|
|
18
|
+
|
|
19
|
+
### [2.0.12](https://github.com/salesforcecli/plugin-command-reference/compare/v2.0.11...v2.0.12) (2021-10-01)
|
|
7
20
|
|
|
8
21
|
### Bug Fixes
|
|
9
22
|
|
|
10
|
-
|
|
23
|
+
- bump to GA deps ([#37](https://github.com/salesforcecli/plugin-command-reference/issues/37)) ([0f0644f](https://github.com/salesforcecli/plugin-command-reference/commit/0f0644f9298f44eec86c0210cf9bce267b3c3cfc))
|
|
11
24
|
|
|
12
25
|
### [2.0.11](https://github.com/salesforcecli/plugin-command-reference/compare/v2.0.10...v2.0.11) (2021-09-20)
|
|
13
26
|
|
|
14
|
-
|
|
15
27
|
### Bug Fixes
|
|
16
28
|
|
|
17
|
-
|
|
29
|
+
- stop generating main topic intro ([ba42e7f](https://github.com/salesforcecli/plugin-command-reference/commit/ba42e7fc66ca88b64658c9b88f9a7209a6953b55))
|
|
18
30
|
|
|
19
31
|
### [2.0.10](https://github.com/salesforcecli/plugin-command-reference/compare/v2.0.9...v2.0.10) (2021-09-16)
|
|
20
32
|
|
|
21
|
-
|
|
22
33
|
### Bug Fixes
|
|
23
34
|
|
|
24
|
-
|
|
35
|
+
- change title/shortdesc of main ditamap so it says "sf" ([48f183e](https://github.com/salesforcecli/plugin-command-reference/commit/48f183ec1be08b265f95baf6bf8bfab72cc932e1))
|
|
25
36
|
|
|
26
37
|
### [2.0.9](https://github.com/salesforcecli/plugin-command-reference/compare/v2.0.8...v2.0.9) (2021-09-16)
|
|
27
38
|
|
|
28
|
-
|
|
29
39
|
### Bug Fixes
|
|
30
40
|
|
|
31
|
-
|
|
41
|
+
- use latest sf-plugins-core ([9366b09](https://github.com/salesforcecli/plugin-command-reference/commit/9366b096cfcbe2fae41b1f6eede805c8d817570b))
|
|
32
42
|
|
|
33
43
|
### [2.0.8](https://github.com/salesforcecli/plugin-command-reference/compare/v2.0.7...v2.0.8) (2021-09-15)
|
|
34
44
|
|
|
35
|
-
|
|
36
45
|
### Bug Fixes
|
|
37
46
|
|
|
38
|
-
|
|
39
|
-
|
|
47
|
+
- update template files for sf ([2a0ca0a](https://github.com/salesforcecli/plugin-command-reference/commit/2a0ca0acc1744b2b090d5c7b3d3a196d127061c9))
|
|
48
|
+
- update test with new title in command XML file ([b9b14ea](https://github.com/salesforcecli/plugin-command-reference/commit/b9b14ea2a8505d153a244ebc0d1e7759e2803a40))
|
|
40
49
|
|
|
41
50
|
### [2.0.7](https://github.com/salesforcecli/plugin-command-reference/compare/v2.0.6...v2.0.7) (2021-09-14)
|
|
42
51
|
|
|
43
|
-
|
|
44
52
|
### Bug Fixes
|
|
45
53
|
|
|
46
|
-
|
|
54
|
+
- improve error handling ([50a8f5a](https://github.com/salesforcecli/plugin-command-reference/commit/50a8f5a7c92307ac2a0b0d3e72cc98e3e679870d))
|
|
47
55
|
|
|
48
56
|
### [2.0.6](https://github.com/salesforcecli/plugin-command-reference/compare/v2.0.5...v2.0.6) (2021-09-09)
|
|
49
57
|
|
|
50
|
-
|
|
51
58
|
### Bug Fixes
|
|
52
59
|
|
|
53
|
-
|
|
60
|
+
- don't generate xml for topics ([60e0056](https://github.com/salesforcecli/plugin-command-reference/commit/60e00563698ce8db4a12077f7866cdbe15fbdf6a))
|
|
54
61
|
|
|
55
62
|
### [2.0.5](https://github.com/salesforcecli/plugin-command-reference/compare/v2.0.4...v2.0.5) (2021-09-08)
|
|
56
63
|
|
|
57
|
-
|
|
58
64
|
### Bug Fixes
|
|
59
65
|
|
|
60
|
-
|
|
66
|
+
- use unique id ([56c946e](https://github.com/salesforcecli/plugin-command-reference/commit/56c946eab0dcb8775bd538ddc80e824aee8b7273))
|
|
61
67
|
|
|
62
68
|
### [2.0.4](https://github.com/salesforcecli/plugin-command-reference/compare/v2.0.3...v2.0.4) (2021-09-08)
|
|
63
69
|
|
|
64
|
-
|
|
65
70
|
### Bug Fixes
|
|
66
71
|
|
|
67
|
-
|
|
72
|
+
- append suffix to all filenames ([6264636](https://github.com/salesforcecli/plugin-command-reference/commit/626463690bc5e6d157949b14dc5b1966e65c5d3f))
|
|
68
73
|
|
|
69
74
|
### [2.0.3](https://github.com/salesforcecli/plugin-command-reference/compare/v2.0.2...v2.0.3) (2021-09-08)
|
|
70
75
|
|
|
71
|
-
|
|
72
76
|
### Bug Fixes
|
|
73
77
|
|
|
74
|
-
|
|
78
|
+
- populate topic command xml ([d8b61e5](https://github.com/salesforcecli/plugin-command-reference/commit/d8b61e51b41192a97de3a166011d0d494606959d))
|
|
75
79
|
|
|
76
80
|
### [2.0.2](https://github.com/salesforcecli/plugin-command-reference/compare/v2.0.1...v2.0.2) (2021-09-08)
|
|
77
81
|
|
|
78
|
-
|
|
79
82
|
### Bug Fixes
|
|
80
83
|
|
|
81
|
-
|
|
84
|
+
- update generate command reference ([d864b2d](https://github.com/salesforcecli/plugin-command-reference/commit/d864b2d5749732e1870e2f59c80c8975b028c21b))
|
|
82
85
|
|
|
83
86
|
### [2.0.1](https://github.com/salesforcecli/plugin-command-reference/compare/v2.0.0...v2.0.1) (2021-09-07)
|
|
84
87
|
|
|
85
|
-
|
|
86
88
|
### Bug Fixes
|
|
87
89
|
|
|
88
|
-
|
|
90
|
+
- use this.config ([de4a137](https://github.com/salesforcecli/plugin-command-reference/commit/de4a137d6e3e5ca8d322e5c45e3e893c6830ff40))
|
|
89
91
|
|
|
90
92
|
## [2.0.0](https://github.com/salesforcecli/plugin-command-reference/compare/v1.3.14...v2.0.0) (2021-09-07)
|
|
91
93
|
|
|
92
|
-
|
|
93
94
|
### ⚠ BREAKING CHANGES
|
|
94
95
|
|
|
95
|
-
|
|
96
|
+
- only works for sf now
|
|
96
97
|
|
|
97
|
-
|
|
98
|
+
- test: update to work with new file structure
|
|
98
99
|
|
|
99
|
-
|
|
100
|
+
- refactor: use oclif/core
|
|
100
101
|
|
|
101
|
-
|
|
102
|
+
- chore: bump to 2.0.0
|
|
102
103
|
|
|
103
|
-
|
|
104
|
+
- chore: satisfy dev-scripts
|
|
104
105
|
|
|
105
|
-
|
|
106
|
+
- chore: code review
|
|
106
107
|
|
|
107
|
-
|
|
108
|
+
- chore: regenerate yarn.lock
|
|
108
109
|
|
|
109
|
-
|
|
110
|
+
- 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)
|
|
110
111
|
|
|
111
112
|
### [1.3.14](https://github.com/forcedotcom/plugin-command-reference/compare/v1.3.13...v1.3.14) (2021-08-13)
|
|
112
113
|
|
|
@@ -130,192 +131,168 @@ All notable changes to this project will be documented in this file. See [standa
|
|
|
130
131
|
|
|
131
132
|
## [1.3.4](https://github.com/forcedotcom/plugin-command-reference/compare/v1.3.3...v1.3.4) (2021-06-04)
|
|
132
133
|
|
|
133
|
-
|
|
134
134
|
### Bug Fixes
|
|
135
135
|
|
|
136
|
-
|
|
136
|
+
- list plug-ins and their version in a <ul> ([f0e3f20](https://github.com/forcedotcom/plugin-command-reference/commit/f0e3f201a19818bac9d714a9a3a00fd0c2721407))
|
|
137
137
|
|
|
138
138
|
## [1.3.3](https://github.com/forcedotcom/plugin-command-reference/compare/v1.3.2...v1.3.3) (2021-05-17)
|
|
139
139
|
|
|
140
|
-
|
|
141
140
|
### Bug Fixes
|
|
142
141
|
|
|
143
|
-
|
|
142
|
+
- 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))
|
|
144
143
|
|
|
145
144
|
## [1.3.2](https://github.com/forcedotcom/plugin-command-reference/compare/v1.3.1...v1.3.2) (2021-05-03)
|
|
146
145
|
|
|
147
|
-
|
|
148
146
|
### Bug Fixes
|
|
149
147
|
|
|
150
|
-
|
|
148
|
+
- force patch release ([9a72942](https://github.com/forcedotcom/plugin-command-reference/commit/9a72942dca2bbdb791a1f765fed067290f365254))
|
|
151
149
|
|
|
152
150
|
## [1.3.1](https://github.com/forcedotcom/plugin-command-reference/compare/v1.3.0...v1.3.1) (2021-05-03)
|
|
153
151
|
|
|
154
|
-
|
|
155
152
|
### Bug Fixes
|
|
156
153
|
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
154
|
+
- add auth to list of plugins ([0a5494a](https://github.com/forcedotcom/plugin-command-reference/commit/0a5494a96bec63c3519ae5ea726d7f5e09e79cef))
|
|
155
|
+
- add back spaces that were mistakenly removed ([381d2f9](https://github.com/forcedotcom/plugin-command-reference/commit/381d2f92966f1dcdfa2149f086b693ad658a548a))
|
|
156
|
+
- bump version 1.3.2 to force release ([2d38cf5](https://github.com/forcedotcom/plugin-command-reference/commit/2d38cf5a5ed6090e51360bbcab5131e13f709893))
|
|
157
|
+
- bump version 1.3.2 to force release ([34d8c00](https://github.com/forcedotcom/plugin-command-reference/commit/34d8c001f9a33b430ea1eeabc884194815ee2d25))
|
|
158
|
+
- fix deprecated warning message ([9fc5219](https://github.com/forcedotcom/plugin-command-reference/commit/9fc5219d476f5456b9ed6d2c9c27216560bbf8bb))
|
|
159
|
+
- undo commit to master ([cbc3195](https://github.com/forcedotcom/plugin-command-reference/commit/cbc31958c4797118159039b466cd4365576bee62))
|
|
160
|
+
- undo commit to master ([47efe40](https://github.com/forcedotcom/plugin-command-reference/commit/47efe40dde6c19782de6a21b89e62f8dc5e2d66a))
|
|
164
161
|
|
|
165
162
|
## [1.3.1](https://github.com/forcedotcom/plugin-command-reference/compare/v1.3.0...v1.3.1) (2021-04-30)
|
|
166
163
|
|
|
167
|
-
|
|
168
164
|
### Bug Fixes
|
|
169
165
|
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
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 ([34d8c00](https://github.com/forcedotcom/plugin-command-reference/commit/34d8c001f9a33b430ea1eeabc884194815ee2d25))
|
|
169
|
+
- fix deprecated warning message ([9fc5219](https://github.com/forcedotcom/plugin-command-reference/commit/9fc5219d476f5456b9ed6d2c9c27216560bbf8bb))
|
|
170
|
+
- undo commit to master ([cbc3195](https://github.com/forcedotcom/plugin-command-reference/commit/cbc31958c4797118159039b466cd4365576bee62))
|
|
171
|
+
- undo commit to master ([47efe40](https://github.com/forcedotcom/plugin-command-reference/commit/47efe40dde6c19782de6a21b89e62f8dc5e2d66a))
|
|
176
172
|
|
|
177
173
|
## [1.3.1](https://github.com/forcedotcom/plugin-command-reference/compare/v1.3.0...v1.3.1) (2021-04-29)
|
|
178
174
|
|
|
179
|
-
|
|
180
175
|
### Bug Fixes
|
|
181
176
|
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
177
|
+
- add auth to list of plugins ([0a5494a](https://github.com/forcedotcom/plugin-command-reference/commit/0a5494a96bec63c3519ae5ea726d7f5e09e79cef))
|
|
178
|
+
- add back spaces that were mistakenly removed ([381d2f9](https://github.com/forcedotcom/plugin-command-reference/commit/381d2f92966f1dcdfa2149f086b693ad658a548a))
|
|
179
|
+
- fix deprecated warning message ([9fc5219](https://github.com/forcedotcom/plugin-command-reference/commit/9fc5219d476f5456b9ed6d2c9c27216560bbf8bb))
|
|
180
|
+
- undo commit to master ([cbc3195](https://github.com/forcedotcom/plugin-command-reference/commit/cbc31958c4797118159039b466cd4365576bee62))
|
|
181
|
+
- undo commit to master ([47efe40](https://github.com/forcedotcom/plugin-command-reference/commit/47efe40dde6c19782de6a21b89e62f8dc5e2d66a))
|
|
187
182
|
|
|
188
183
|
## [1.3.1](https://github.com/forcedotcom/plugin-command-reference/compare/v1.3.0...v1.3.1) (2021-04-29)
|
|
189
184
|
|
|
190
|
-
|
|
191
185
|
### Bug Fixes
|
|
192
186
|
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
187
|
+
- add back spaces that were mistakenly removed ([381d2f9](https://github.com/forcedotcom/plugin-command-reference/commit/381d2f92966f1dcdfa2149f086b693ad658a548a))
|
|
188
|
+
- fix deprecated warning message ([9fc5219](https://github.com/forcedotcom/plugin-command-reference/commit/9fc5219d476f5456b9ed6d2c9c27216560bbf8bb))
|
|
189
|
+
- undo commit to master ([cbc3195](https://github.com/forcedotcom/plugin-command-reference/commit/cbc31958c4797118159039b466cd4365576bee62))
|
|
190
|
+
- undo commit to master ([47efe40](https://github.com/forcedotcom/plugin-command-reference/commit/47efe40dde6c19782de6a21b89e62f8dc5e2d66a))
|
|
197
191
|
|
|
198
192
|
## [1.3.1](https://github.com/forcedotcom/plugin-command-reference/compare/v1.3.0...v1.3.1) (2021-04-29)
|
|
199
193
|
|
|
200
|
-
|
|
201
194
|
### Bug Fixes
|
|
202
195
|
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
196
|
+
- fix deprecated warning message ([9fc5219](https://github.com/forcedotcom/plugin-command-reference/commit/9fc5219d476f5456b9ed6d2c9c27216560bbf8bb))
|
|
197
|
+
- undo commit to master ([cbc3195](https://github.com/forcedotcom/plugin-command-reference/commit/cbc31958c4797118159039b466cd4365576bee62))
|
|
198
|
+
- undo commit to master ([47efe40](https://github.com/forcedotcom/plugin-command-reference/commit/47efe40dde6c19782de6a21b89e62f8dc5e2d66a))
|
|
206
199
|
|
|
207
200
|
## [1.3.1](https://github.com/forcedotcom/plugin-command-reference/compare/v1.3.0...v1.3.1) (2021-04-26)
|
|
208
201
|
|
|
209
|
-
|
|
210
202
|
### Bug Fixes
|
|
211
203
|
|
|
212
|
-
|
|
213
|
-
|
|
204
|
+
- undo commit to master ([cbc3195](https://github.com/forcedotcom/plugin-command-reference/commit/cbc31958c4797118159039b466cd4365576bee62))
|
|
205
|
+
- undo commit to master ([47efe40](https://github.com/forcedotcom/plugin-command-reference/commit/47efe40dde6c19782de6a21b89e62f8dc5e2d66a))
|
|
214
206
|
|
|
215
207
|
## [1.3.1](https://github.com/forcedotcom/plugin-command-reference/compare/v1.3.0...v1.3.1) (2021-04-26)
|
|
216
208
|
|
|
217
|
-
|
|
218
209
|
### Bug Fixes
|
|
219
210
|
|
|
220
|
-
|
|
211
|
+
- undo commit to master ([47efe40](https://github.com/forcedotcom/plugin-command-reference/commit/47efe40dde6c19782de6a21b89e62f8dc5e2d66a))
|
|
221
212
|
|
|
222
213
|
# [1.3.0](https://github.com/forcedotcom/plugin-command-reference/compare/v1.2.6...v1.3.0) (2021-02-02)
|
|
223
214
|
|
|
224
|
-
|
|
225
215
|
### Features
|
|
226
216
|
|
|
227
|
-
|
|
217
|
+
- 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))
|
|
228
218
|
|
|
229
219
|
## [1.2.6](https://github.com/forcedotcom/plugin-command-reference/compare/v1.2.5...v1.2.6) (2021-02-01)
|
|
230
220
|
|
|
231
|
-
|
|
232
221
|
### Bug Fixes
|
|
233
222
|
|
|
234
|
-
|
|
223
|
+
- remove note about "sfdx force:doc:commands:list" ([2378f39](https://github.com/forcedotcom/plugin-command-reference/commit/2378f39a88923c294a2a2cb8c002372e85e819cf))
|
|
235
224
|
|
|
236
225
|
## [1.2.5](https://github.com/forcedotcom/plugin-command-reference/compare/v1.2.4...v1.2.5) (2021-02-01)
|
|
237
226
|
|
|
238
|
-
|
|
239
227
|
### Bug Fixes
|
|
240
228
|
|
|
241
|
-
|
|
229
|
+
- Add list of other plugins as a top-level topic ([800d797](https://github.com/forcedotcom/plugin-command-reference/commit/800d7973a9e1c29a38866b258e20c0006ecf8aa2))
|
|
242
230
|
|
|
243
231
|
## [1.2.4](https://github.com/forcedotcom/plugin-command-reference/compare/v1.2.3...v1.2.4) (2021-01-20)
|
|
244
232
|
|
|
245
|
-
|
|
246
233
|
### Bug Fixes
|
|
247
234
|
|
|
248
|
-
|
|
235
|
+
- remove <ph id="topic-title"> ([2180c1a](https://github.com/forcedotcom/plugin-command-reference/commit/2180c1aaf310fb9cfbda2b947e5f5b77bdf3e226))
|
|
249
236
|
|
|
250
237
|
## [1.2.3](https://github.com/forcedotcom/plugin-command-reference/compare/v1.2.2...v1.2.3) (2020-11-05)
|
|
251
238
|
|
|
252
|
-
|
|
253
239
|
### Bug Fixes
|
|
254
240
|
|
|
255
|
-
|
|
241
|
+
- fix rel notes link to point to main branch ([663483b](https://github.com/forcedotcom/plugin-command-reference/commit/663483bd3aab0f40c68ac6b6327c34a4edce1014))
|
|
256
242
|
|
|
257
243
|
## [1.2.2](https://github.com/forcedotcom/plugin-command-reference/compare/v1.2.1...v1.2.2) (2020-10-28)
|
|
258
244
|
|
|
259
|
-
|
|
260
245
|
### Bug Fixes
|
|
261
246
|
|
|
262
|
-
|
|
247
|
+
- rearrange command xml, rename setup guide, fix rn link ([b1ad787](https://github.com/forcedotcom/plugin-command-reference/commit/b1ad7874958bd2cbe38f19896cfc5964da213488))
|
|
263
248
|
|
|
264
249
|
## [1.2.1](https://github.com/forcedotcom/plugin-command-reference/compare/v1.2.0...v1.2.1) (2020-10-27)
|
|
265
250
|
|
|
266
|
-
|
|
267
251
|
### Bug Fixes
|
|
268
252
|
|
|
269
|
-
|
|
253
|
+
- don't duplicate examples ([cd6328b](https://github.com/forcedotcom/plugin-command-reference/commit/cd6328b5cbc4a58f11d309acade7a67513acaf58))
|
|
270
254
|
|
|
271
255
|
# [1.2.0](https://github.com/forcedotcom/plugin-command-reference/compare/v1.1.5...v1.2.0) (2020-10-21)
|
|
272
256
|
|
|
273
|
-
|
|
274
257
|
### Features
|
|
275
258
|
|
|
276
|
-
|
|
259
|
+
- add aliases and examples ([aaf61ad](https://github.com/forcedotcom/plugin-command-reference/commit/aaf61adf3508f69d899898876f03154218ff5a9b))
|
|
277
260
|
|
|
278
261
|
## [1.1.5](https://github.com/forcedotcom/plugin-command-reference/compare/v1.1.4...v1.1.5) (2020-10-01)
|
|
279
262
|
|
|
280
|
-
|
|
281
263
|
### Bug Fixes
|
|
282
264
|
|
|
283
|
-
|
|
265
|
+
- correct help ([b75dd61](https://github.com/forcedotcom/plugin-command-reference/commit/b75dd61281ec1671e20f9a52078da642ede2e0a6))
|
|
284
266
|
|
|
285
267
|
## [1.1.4](https://github.com/forcedotcom/plugin-command-reference/compare/v1.1.3...v1.1.4) (2020-10-01)
|
|
286
268
|
|
|
287
|
-
|
|
288
269
|
### Bug Fixes
|
|
289
270
|
|
|
290
|
-
|
|
271
|
+
- ensure unique ids ([d51f193](https://github.com/forcedotcom/plugin-command-reference/commit/d51f19350bab150da23575bfa27e94e467df99d6))
|
|
291
272
|
|
|
292
273
|
## [1.1.3](https://github.com/forcedotcom/plugin-command-reference/compare/v1.1.2...v1.1.3) (2020-08-12)
|
|
293
274
|
|
|
294
|
-
|
|
295
275
|
### Bug Fixes
|
|
296
276
|
|
|
297
|
-
|
|
277
|
+
- put back multiple flag descriptions ([4c340a8](https://github.com/forcedotcom/plugin-command-reference/commit/4c340a8f414d2e892e135797754883db040ff89a))
|
|
298
278
|
|
|
299
279
|
## [1.1.2](https://github.com/forcedotcom/plugin-command-reference/compare/v1.1.1...v1.1.2) (2020-08-12)
|
|
300
280
|
|
|
301
|
-
|
|
302
281
|
### Bug Fixes
|
|
303
282
|
|
|
304
|
-
|
|
283
|
+
- return parameters ([c713fd0](https://github.com/forcedotcom/plugin-command-reference/commit/c713fd0f7d3f93f64a7f76b9a430d43aeaca875f))
|
|
305
284
|
|
|
306
285
|
## [1.1.1](https://github.com/forcedotcom/plugin-command-reference/compare/v1.1.0...v1.1.1) (2020-08-06)
|
|
307
286
|
|
|
308
|
-
|
|
309
287
|
### Bug Fixes
|
|
310
288
|
|
|
311
|
-
|
|
289
|
+
- no multiline in description ([0b846b7](https://github.com/forcedotcom/plugin-command-reference/commit/0b846b7931a35e1cad4956fa918ece30650944f9))
|
|
312
290
|
|
|
313
291
|
# [1.1.0](https://github.com/forcedotcom/plugin-command-reference/compare/v1.0.7...v1.1.0) (2020-07-29)
|
|
314
292
|
|
|
315
|
-
|
|
316
293
|
### Features
|
|
317
294
|
|
|
318
|
-
|
|
295
|
+
- support no long description ([4b5dabc](https://github.com/forcedotcom/plugin-command-reference/commit/4b5dabc7acc30bd689bda110484e2c0e345d64da))
|
|
319
296
|
|
|
320
297
|
## [1.0.7](https://github.com/forcedotcom/plugin-command-reference/compare/v1.0.6...v1.0.7) (2020-03-11)
|
|
321
298
|
|
package/LICENSE.txt
CHANGED
package/README.md
CHANGED
|
@@ -74,9 +74,10 @@ generate the command reference guide located
|
|
|
74
74
|
|
|
75
75
|
```
|
|
76
76
|
USAGE
|
|
77
|
-
$ sf commandreference generate [--json] [-d <value>] [-p <value>] [-s <value>] [--hidden] [--erroronwarnings]
|
|
77
|
+
$ sf commandreference generate [--json] [-d <value>] [-p <value> | -a] [-s <value>] [--hidden] [--erroronwarnings]
|
|
78
78
|
|
|
79
79
|
FLAGS
|
|
80
|
+
-a, --all include all relevant plugins in the generation
|
|
80
81
|
-d, --outputdir=<value> [default: ./tmp/root] output directory to put generated files
|
|
81
82
|
-p, --plugins=<value>... comma separated list of plugin names to be part of the generation. Defaults to the oclif
|
|
82
83
|
plugin in the current working directory
|
|
@@ -5,6 +5,7 @@ export default class CommandReferenceGenerate extends SfCommand<AnyJson> {
|
|
|
5
5
|
static flags: {
|
|
6
6
|
outputdir: import("@oclif/core/lib/interfaces").OptionFlag<string>;
|
|
7
7
|
plugins: import("@oclif/core/lib/interfaces").OptionFlag<string[]>;
|
|
8
|
+
all: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
|
|
8
9
|
'ditamap-suffix': import("@oclif/core/lib/interfaces").OptionFlag<string>;
|
|
9
10
|
hidden: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
|
|
10
11
|
erroronwarnings: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
|
|
@@ -8,6 +8,7 @@
|
|
|
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");
|
|
@@ -25,16 +26,25 @@ class CommandReferenceGenerate extends sf_plugins_core_1.SfCommand {
|
|
|
25
26
|
const { flags } = await this.parse(CommandReferenceGenerate);
|
|
26
27
|
ditamap_1.Ditamap.suffix = flags['ditamap-suffix'];
|
|
27
28
|
let pluginNames;
|
|
28
|
-
if (!flags.plugins) {
|
|
29
|
+
if (!flags.plugins && !flags.all) {
|
|
29
30
|
const pJsonPath = path.join(process.cwd(), 'package.json');
|
|
30
|
-
if (await
|
|
31
|
-
const packageJson = await
|
|
31
|
+
if (await (0, fs_extra_1.pathExists)(pJsonPath)) {
|
|
32
|
+
const packageJson = await (0, fs_extra_1.readJSON)(pJsonPath);
|
|
32
33
|
pluginNames = [(0, ts_types_1.getString)(packageJson, 'name')];
|
|
33
34
|
}
|
|
34
35
|
else {
|
|
35
|
-
throw new core_2.
|
|
36
|
+
throw new core_2.SfError("No plugins provided. Provide the '--plugins' flag or cd into a directory that contains a valid oclif plugin.");
|
|
36
37
|
}
|
|
37
38
|
}
|
|
39
|
+
else if (flags.all) {
|
|
40
|
+
const ignore = [
|
|
41
|
+
/@oclif/,
|
|
42
|
+
/@salesforce\/cli/,
|
|
43
|
+
/@salesforce\/plugin-telemetry/,
|
|
44
|
+
/@salesforce\/plugin-command-reference/,
|
|
45
|
+
];
|
|
46
|
+
pluginNames = this.config.plugins.map((p) => p.name).filter((p) => !ignore.some((i) => i.test(p)));
|
|
47
|
+
}
|
|
38
48
|
else {
|
|
39
49
|
pluginNames = flags.plugins;
|
|
40
50
|
}
|
|
@@ -47,7 +57,7 @@ class CommandReferenceGenerate extends sf_plugins_core_1.SfCommand {
|
|
|
47
57
|
pluginName = `@salesforce/plugin-${pluginName}`;
|
|
48
58
|
plugin = this.getPlugin(pluginName);
|
|
49
59
|
if (!plugin) {
|
|
50
|
-
throw new core_2.
|
|
60
|
+
throw new core_2.SfError(`Plugin ${name} or ${pluginName} not found. Is it installed?`);
|
|
51
61
|
}
|
|
52
62
|
}
|
|
53
63
|
return pluginName;
|
|
@@ -77,7 +87,7 @@ class CommandReferenceGenerate extends sf_plugins_core_1.SfCommand {
|
|
|
77
87
|
await docs.build(await this.loadCommands());
|
|
78
88
|
this.log(`\nWrote generated doc to ${ditamap_1.Ditamap.outputDir}`);
|
|
79
89
|
if (flags.erroronwarnings && warnings.length > 0) {
|
|
80
|
-
throw new core_2.
|
|
90
|
+
throw new core_2.SfError(`Found ${warnings.length} warnings.`);
|
|
81
91
|
}
|
|
82
92
|
return { warnings };
|
|
83
93
|
}
|
|
@@ -92,7 +102,7 @@ class CommandReferenceGenerate extends sf_plugins_core_1.SfCommand {
|
|
|
92
102
|
for (const plugin of plugins) {
|
|
93
103
|
const masterPlugin = this.getPlugin(plugin);
|
|
94
104
|
if (!masterPlugin) {
|
|
95
|
-
throw new core_2.
|
|
105
|
+
throw new core_2.SfError(`Plugin ${plugin} not found. Is it installed?`);
|
|
96
106
|
}
|
|
97
107
|
pluginToParentPlugin[masterPlugin.name] = masterPlugin.name;
|
|
98
108
|
resolveChildPlugins(masterPlugin);
|
|
@@ -162,6 +172,12 @@ CommandReferenceGenerate.flags = {
|
|
|
162
172
|
char: 'p',
|
|
163
173
|
description: messages.getMessage('pluginFlagDescription'),
|
|
164
174
|
multiple: true,
|
|
175
|
+
exclusive: ['all'],
|
|
176
|
+
}),
|
|
177
|
+
all: core_1.Flags.boolean({
|
|
178
|
+
char: 'a',
|
|
179
|
+
description: messages.getMessage('allFlagDescription'),
|
|
180
|
+
exclusive: ['plugins'],
|
|
165
181
|
}),
|
|
166
182
|
'ditamap-suffix': core_1.Flags.string({
|
|
167
183
|
char: 's',
|
|
@@ -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,mCAA6B;AAC7B,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,YAAG,CAAC,GAAG,CACL,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');
|
|
@@ -55,9 +56,9 @@ class Ditamap {
|
|
|
55
56
|
return this.destination;
|
|
56
57
|
}
|
|
57
58
|
async write() {
|
|
58
|
-
await
|
|
59
|
+
await mkdirp((0, path_1.dirname)(this.destination));
|
|
59
60
|
const output = await this.transformToDitamap();
|
|
60
|
-
await
|
|
61
|
+
await fs.writeFile(this.destination, output);
|
|
61
62
|
}
|
|
62
63
|
formatParagraphs(textToFormat) {
|
|
63
64
|
return textToFormat ? textToFormat.split('\n').filter((n) => n !== '') : [];
|
|
@@ -71,7 +72,7 @@ class Ditamap {
|
|
|
71
72
|
*/
|
|
72
73
|
async transformToDitamap() {
|
|
73
74
|
debug(`Generating ${this.destination} from ${this.getTemplateFileName()}`);
|
|
74
|
-
const src = await
|
|
75
|
+
const src = await fs.readFile(this.source, 'utf8');
|
|
75
76
|
const template = hb.compile(src);
|
|
76
77
|
return template(this.data);
|
|
77
78
|
}
|
|
@@ -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;;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/messages/main.json
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"commandDescription": "generate the command reference guide located",
|
|
3
3
|
"pluginFlagDescription": "comma separated list of plugin names to be part of the generation. Defaults to the oclif plugin in the current working directory",
|
|
4
|
+
"allFlagDescription": "include all relevant plugins in the generation",
|
|
4
5
|
"hiddenFlagDescription": "show hidden commands",
|
|
5
6
|
"outputdirFlagDescription": "output directory to put generated files",
|
|
6
7
|
"erroronwarningFlagDescription": "fail the command if there are any warnings",
|
package/oclif.manifest.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":"2.0
|
|
1
|
+
{"version":"2.2.0","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.0",
|
|
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.0.crt",
|
|
104
|
+
"signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-command-reference/2.2.0.sig"
|
|
100
105
|
}
|
|
101
|
-
|
|
102
|
-
"publishConfig": {
|
|
103
|
-
"access": "public"
|
|
104
|
-
}
|
|
105
|
-
}
|
|
106
|
+
}
|