@salesforce/plugin-command-reference 1.3.16 → 1.3.19
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 +61 -71
- package/LICENSE.txt +12 -0
- package/README.md +5 -3
- package/lib/commands/commandreference/generate.d.ts +1 -1
- package/lib/commands/commandreference/generate.js +13 -13
- package/lib/commands/commandreference/generate.js.map +1 -1
- package/lib/ditamap/base-ditamap.js +2 -1
- package/lib/ditamap/base-ditamap.js.map +1 -1
- package/lib/ditamap/cli-reference-topic.js +2 -1
- package/lib/ditamap/cli-reference-topic.js.map +1 -1
- package/lib/ditamap/cli-reference.js +2 -1
- package/lib/ditamap/cli-reference.js.map +1 -1
- package/lib/ditamap/command.js +4 -3
- package/lib/ditamap/command.js.map +1 -1
- package/lib/ditamap/ditamap.d.ts +2 -1
- package/lib/ditamap/ditamap.js +18 -12
- package/lib/ditamap/ditamap.js.map +1 -1
- package/lib/ditamap/main-topic-intro.js +4 -2
- package/lib/ditamap/main-topic-intro.js.map +1 -1
- package/lib/ditamap/subtopic-ditamap.js +2 -1
- package/lib/ditamap/subtopic-ditamap.js.map +1 -1
- package/lib/ditamap/topic-ditamap.js +3 -2
- package/lib/ditamap/topic-ditamap.js.map +1 -1
- package/lib/docs.d.ts +1 -0
- package/lib/docs.js +8 -3
- package/lib/docs.js.map +1 -1
- package/lib/utils.d.ts +1 -1
- package/lib/utils.js +6 -10
- package/lib/utils.js.map +1 -1
- package/oclif.manifest.json +1 -0
- package/package.json +53 -36
- package/templates/command.hbs +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -2,12 +2,26 @@
|
|
|
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
|
-
### [1.3.
|
|
5
|
+
### [1.3.19](https://github.com/forcedotcom/plugin-command-reference/compare/v1.3.17...v1.3.19) (2022-05-17)
|
|
6
|
+
|
|
7
|
+
### Bug Fixes
|
|
8
|
+
|
|
9
|
+
- add dependabot and versioning strategy ([6a13574](https://github.com/forcedotcom/plugin-command-reference/commit/6a13574724f9e317a0624bc0bb92e9f1dc7a689c))
|
|
10
|
+
- remove '$' in codeblocks ([79e2b7b](https://github.com/forcedotcom/plugin-command-reference/commit/79e2b7b8bb5eacfad43319e1ca7ed42d2705f419))
|
|
11
|
+
|
|
12
|
+
### [1.3.17](https://github.com/forcedotcom/plugin-command-reference/compare/v1.3.16...v1.3.17) (2021-11-19)
|
|
6
13
|
|
|
14
|
+
### Bug Fixes
|
|
15
|
+
|
|
16
|
+
- combination of compatible handlebars w/ typescript ([a8c9088](https://github.com/forcedotcom/plugin-command-reference/commit/a8c90884fa78b413928fa9bffcfb93b9ba690365))
|
|
17
|
+
- move generate to test command ([a803451](https://github.com/forcedotcom/plugin-command-reference/commit/a80345161da0057767c5d480a3e8047478831a2d))
|
|
18
|
+
- run command in test itself ([9923935](https://github.com/forcedotcom/plugin-command-reference/commit/99239351fa218fcb3cc3fd5798e7148451cbc048))
|
|
19
|
+
|
|
20
|
+
### [1.3.16](https://github.com/forcedotcom/plugin-command-reference/compare/v1.3.15...v1.3.16) (2021-09-30)
|
|
7
21
|
|
|
8
22
|
### Bug Fixes
|
|
9
23
|
|
|
10
|
-
|
|
24
|
+
- update for the combined sf/sfdx cli reference ([ed08b75](https://github.com/forcedotcom/plugin-command-reference/commit/ed08b759b4a42fb245c82ab348ce78803de132db))
|
|
11
25
|
|
|
12
26
|
### [1.3.15](https://github.com/forcedotcom/plugin-command-reference/compare/v1.3.14...v1.3.15) (2021-09-10)
|
|
13
27
|
|
|
@@ -33,192 +47,168 @@ All notable changes to this project will be documented in this file. See [standa
|
|
|
33
47
|
|
|
34
48
|
## [1.3.4](https://github.com/forcedotcom/plugin-command-reference/compare/v1.3.3...v1.3.4) (2021-06-04)
|
|
35
49
|
|
|
36
|
-
|
|
37
50
|
### Bug Fixes
|
|
38
51
|
|
|
39
|
-
|
|
52
|
+
- list plug-ins and their version in a <ul> ([f0e3f20](https://github.com/forcedotcom/plugin-command-reference/commit/f0e3f201a19818bac9d714a9a3a00fd0c2721407))
|
|
40
53
|
|
|
41
54
|
## [1.3.3](https://github.com/forcedotcom/plugin-command-reference/compare/v1.3.2...v1.3.3) (2021-05-17)
|
|
42
55
|
|
|
43
|
-
|
|
44
56
|
### Bug Fixes
|
|
45
57
|
|
|
46
|
-
|
|
58
|
+
- 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))
|
|
47
59
|
|
|
48
60
|
## [1.3.2](https://github.com/forcedotcom/plugin-command-reference/compare/v1.3.1...v1.3.2) (2021-05-03)
|
|
49
61
|
|
|
50
|
-
|
|
51
62
|
### Bug Fixes
|
|
52
63
|
|
|
53
|
-
|
|
64
|
+
- force patch release ([9a72942](https://github.com/forcedotcom/plugin-command-reference/commit/9a72942dca2bbdb791a1f765fed067290f365254))
|
|
54
65
|
|
|
55
66
|
## [1.3.1](https://github.com/forcedotcom/plugin-command-reference/compare/v1.3.0...v1.3.1) (2021-05-03)
|
|
56
67
|
|
|
57
|
-
|
|
58
68
|
### Bug Fixes
|
|
59
69
|
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
70
|
+
- add auth to list of plugins ([0a5494a](https://github.com/forcedotcom/plugin-command-reference/commit/0a5494a96bec63c3519ae5ea726d7f5e09e79cef))
|
|
71
|
+
- add back spaces that were mistakenly removed ([381d2f9](https://github.com/forcedotcom/plugin-command-reference/commit/381d2f92966f1dcdfa2149f086b693ad658a548a))
|
|
72
|
+
- bump version 1.3.2 to force release ([2d38cf5](https://github.com/forcedotcom/plugin-command-reference/commit/2d38cf5a5ed6090e51360bbcab5131e13f709893))
|
|
73
|
+
- bump version 1.3.2 to force release ([34d8c00](https://github.com/forcedotcom/plugin-command-reference/commit/34d8c001f9a33b430ea1eeabc884194815ee2d25))
|
|
74
|
+
- fix deprecated warning message ([9fc5219](https://github.com/forcedotcom/plugin-command-reference/commit/9fc5219d476f5456b9ed6d2c9c27216560bbf8bb))
|
|
75
|
+
- undo commit to master ([cbc3195](https://github.com/forcedotcom/plugin-command-reference/commit/cbc31958c4797118159039b466cd4365576bee62))
|
|
76
|
+
- undo commit to master ([47efe40](https://github.com/forcedotcom/plugin-command-reference/commit/47efe40dde6c19782de6a21b89e62f8dc5e2d66a))
|
|
67
77
|
|
|
68
78
|
## [1.3.1](https://github.com/forcedotcom/plugin-command-reference/compare/v1.3.0...v1.3.1) (2021-04-30)
|
|
69
79
|
|
|
70
|
-
|
|
71
80
|
### Bug Fixes
|
|
72
81
|
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
82
|
+
- add auth to list of plugins ([0a5494a](https://github.com/forcedotcom/plugin-command-reference/commit/0a5494a96bec63c3519ae5ea726d7f5e09e79cef))
|
|
83
|
+
- add back spaces that were mistakenly removed ([381d2f9](https://github.com/forcedotcom/plugin-command-reference/commit/381d2f92966f1dcdfa2149f086b693ad658a548a))
|
|
84
|
+
- bump version 1.3.2 to force release ([34d8c00](https://github.com/forcedotcom/plugin-command-reference/commit/34d8c001f9a33b430ea1eeabc884194815ee2d25))
|
|
85
|
+
- fix deprecated warning message ([9fc5219](https://github.com/forcedotcom/plugin-command-reference/commit/9fc5219d476f5456b9ed6d2c9c27216560bbf8bb))
|
|
86
|
+
- undo commit to master ([cbc3195](https://github.com/forcedotcom/plugin-command-reference/commit/cbc31958c4797118159039b466cd4365576bee62))
|
|
87
|
+
- undo commit to master ([47efe40](https://github.com/forcedotcom/plugin-command-reference/commit/47efe40dde6c19782de6a21b89e62f8dc5e2d66a))
|
|
79
88
|
|
|
80
89
|
## [1.3.1](https://github.com/forcedotcom/plugin-command-reference/compare/v1.3.0...v1.3.1) (2021-04-29)
|
|
81
90
|
|
|
82
|
-
|
|
83
91
|
### Bug Fixes
|
|
84
92
|
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
93
|
+
- add auth to list of plugins ([0a5494a](https://github.com/forcedotcom/plugin-command-reference/commit/0a5494a96bec63c3519ae5ea726d7f5e09e79cef))
|
|
94
|
+
- add back spaces that were mistakenly removed ([381d2f9](https://github.com/forcedotcom/plugin-command-reference/commit/381d2f92966f1dcdfa2149f086b693ad658a548a))
|
|
95
|
+
- fix deprecated warning message ([9fc5219](https://github.com/forcedotcom/plugin-command-reference/commit/9fc5219d476f5456b9ed6d2c9c27216560bbf8bb))
|
|
96
|
+
- undo commit to master ([cbc3195](https://github.com/forcedotcom/plugin-command-reference/commit/cbc31958c4797118159039b466cd4365576bee62))
|
|
97
|
+
- undo commit to master ([47efe40](https://github.com/forcedotcom/plugin-command-reference/commit/47efe40dde6c19782de6a21b89e62f8dc5e2d66a))
|
|
90
98
|
|
|
91
99
|
## [1.3.1](https://github.com/forcedotcom/plugin-command-reference/compare/v1.3.0...v1.3.1) (2021-04-29)
|
|
92
100
|
|
|
93
|
-
|
|
94
101
|
### Bug Fixes
|
|
95
102
|
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
103
|
+
- add back spaces that were mistakenly removed ([381d2f9](https://github.com/forcedotcom/plugin-command-reference/commit/381d2f92966f1dcdfa2149f086b693ad658a548a))
|
|
104
|
+
- fix deprecated warning message ([9fc5219](https://github.com/forcedotcom/plugin-command-reference/commit/9fc5219d476f5456b9ed6d2c9c27216560bbf8bb))
|
|
105
|
+
- undo commit to master ([cbc3195](https://github.com/forcedotcom/plugin-command-reference/commit/cbc31958c4797118159039b466cd4365576bee62))
|
|
106
|
+
- undo commit to master ([47efe40](https://github.com/forcedotcom/plugin-command-reference/commit/47efe40dde6c19782de6a21b89e62f8dc5e2d66a))
|
|
100
107
|
|
|
101
108
|
## [1.3.1](https://github.com/forcedotcom/plugin-command-reference/compare/v1.3.0...v1.3.1) (2021-04-29)
|
|
102
109
|
|
|
103
|
-
|
|
104
110
|
### Bug Fixes
|
|
105
111
|
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
112
|
+
- fix deprecated warning message ([9fc5219](https://github.com/forcedotcom/plugin-command-reference/commit/9fc5219d476f5456b9ed6d2c9c27216560bbf8bb))
|
|
113
|
+
- undo commit to master ([cbc3195](https://github.com/forcedotcom/plugin-command-reference/commit/cbc31958c4797118159039b466cd4365576bee62))
|
|
114
|
+
- undo commit to master ([47efe40](https://github.com/forcedotcom/plugin-command-reference/commit/47efe40dde6c19782de6a21b89e62f8dc5e2d66a))
|
|
109
115
|
|
|
110
116
|
## [1.3.1](https://github.com/forcedotcom/plugin-command-reference/compare/v1.3.0...v1.3.1) (2021-04-26)
|
|
111
117
|
|
|
112
|
-
|
|
113
118
|
### Bug Fixes
|
|
114
119
|
|
|
115
|
-
|
|
116
|
-
|
|
120
|
+
- undo commit to master ([cbc3195](https://github.com/forcedotcom/plugin-command-reference/commit/cbc31958c4797118159039b466cd4365576bee62))
|
|
121
|
+
- undo commit to master ([47efe40](https://github.com/forcedotcom/plugin-command-reference/commit/47efe40dde6c19782de6a21b89e62f8dc5e2d66a))
|
|
117
122
|
|
|
118
123
|
## [1.3.1](https://github.com/forcedotcom/plugin-command-reference/compare/v1.3.0...v1.3.1) (2021-04-26)
|
|
119
124
|
|
|
120
|
-
|
|
121
125
|
### Bug Fixes
|
|
122
126
|
|
|
123
|
-
|
|
127
|
+
- undo commit to master ([47efe40](https://github.com/forcedotcom/plugin-command-reference/commit/47efe40dde6c19782de6a21b89e62f8dc5e2d66a))
|
|
124
128
|
|
|
125
129
|
# [1.3.0](https://github.com/forcedotcom/plugin-command-reference/compare/v1.2.6...v1.3.0) (2021-02-02)
|
|
126
130
|
|
|
127
|
-
|
|
128
131
|
### Features
|
|
129
132
|
|
|
130
|
-
|
|
133
|
+
- 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))
|
|
131
134
|
|
|
132
135
|
## [1.2.6](https://github.com/forcedotcom/plugin-command-reference/compare/v1.2.5...v1.2.6) (2021-02-01)
|
|
133
136
|
|
|
134
|
-
|
|
135
137
|
### Bug Fixes
|
|
136
138
|
|
|
137
|
-
|
|
139
|
+
- remove note about "sfdx force:doc:commands:list" ([2378f39](https://github.com/forcedotcom/plugin-command-reference/commit/2378f39a88923c294a2a2cb8c002372e85e819cf))
|
|
138
140
|
|
|
139
141
|
## [1.2.5](https://github.com/forcedotcom/plugin-command-reference/compare/v1.2.4...v1.2.5) (2021-02-01)
|
|
140
142
|
|
|
141
|
-
|
|
142
143
|
### Bug Fixes
|
|
143
144
|
|
|
144
|
-
|
|
145
|
+
- Add list of other plugins as a top-level topic ([800d797](https://github.com/forcedotcom/plugin-command-reference/commit/800d7973a9e1c29a38866b258e20c0006ecf8aa2))
|
|
145
146
|
|
|
146
147
|
## [1.2.4](https://github.com/forcedotcom/plugin-command-reference/compare/v1.2.3...v1.2.4) (2021-01-20)
|
|
147
148
|
|
|
148
|
-
|
|
149
149
|
### Bug Fixes
|
|
150
150
|
|
|
151
|
-
|
|
151
|
+
- remove <ph id="topic-title"> ([2180c1a](https://github.com/forcedotcom/plugin-command-reference/commit/2180c1aaf310fb9cfbda2b947e5f5b77bdf3e226))
|
|
152
152
|
|
|
153
153
|
## [1.2.3](https://github.com/forcedotcom/plugin-command-reference/compare/v1.2.2...v1.2.3) (2020-11-05)
|
|
154
154
|
|
|
155
|
-
|
|
156
155
|
### Bug Fixes
|
|
157
156
|
|
|
158
|
-
|
|
157
|
+
- fix rel notes link to point to main branch ([663483b](https://github.com/forcedotcom/plugin-command-reference/commit/663483bd3aab0f40c68ac6b6327c34a4edce1014))
|
|
159
158
|
|
|
160
159
|
## [1.2.2](https://github.com/forcedotcom/plugin-command-reference/compare/v1.2.1...v1.2.2) (2020-10-28)
|
|
161
160
|
|
|
162
|
-
|
|
163
161
|
### Bug Fixes
|
|
164
162
|
|
|
165
|
-
|
|
163
|
+
- rearrange command xml, rename setup guide, fix rn link ([b1ad787](https://github.com/forcedotcom/plugin-command-reference/commit/b1ad7874958bd2cbe38f19896cfc5964da213488))
|
|
166
164
|
|
|
167
165
|
## [1.2.1](https://github.com/forcedotcom/plugin-command-reference/compare/v1.2.0...v1.2.1) (2020-10-27)
|
|
168
166
|
|
|
169
|
-
|
|
170
167
|
### Bug Fixes
|
|
171
168
|
|
|
172
|
-
|
|
169
|
+
- don't duplicate examples ([cd6328b](https://github.com/forcedotcom/plugin-command-reference/commit/cd6328b5cbc4a58f11d309acade7a67513acaf58))
|
|
173
170
|
|
|
174
171
|
# [1.2.0](https://github.com/forcedotcom/plugin-command-reference/compare/v1.1.5...v1.2.0) (2020-10-21)
|
|
175
172
|
|
|
176
|
-
|
|
177
173
|
### Features
|
|
178
174
|
|
|
179
|
-
|
|
175
|
+
- add aliases and examples ([aaf61ad](https://github.com/forcedotcom/plugin-command-reference/commit/aaf61adf3508f69d899898876f03154218ff5a9b))
|
|
180
176
|
|
|
181
177
|
## [1.1.5](https://github.com/forcedotcom/plugin-command-reference/compare/v1.1.4...v1.1.5) (2020-10-01)
|
|
182
178
|
|
|
183
|
-
|
|
184
179
|
### Bug Fixes
|
|
185
180
|
|
|
186
|
-
|
|
181
|
+
- correct help ([b75dd61](https://github.com/forcedotcom/plugin-command-reference/commit/b75dd61281ec1671e20f9a52078da642ede2e0a6))
|
|
187
182
|
|
|
188
183
|
## [1.1.4](https://github.com/forcedotcom/plugin-command-reference/compare/v1.1.3...v1.1.4) (2020-10-01)
|
|
189
184
|
|
|
190
|
-
|
|
191
185
|
### Bug Fixes
|
|
192
186
|
|
|
193
|
-
|
|
187
|
+
- ensure unique ids ([d51f193](https://github.com/forcedotcom/plugin-command-reference/commit/d51f19350bab150da23575bfa27e94e467df99d6))
|
|
194
188
|
|
|
195
189
|
## [1.1.3](https://github.com/forcedotcom/plugin-command-reference/compare/v1.1.2...v1.1.3) (2020-08-12)
|
|
196
190
|
|
|
197
|
-
|
|
198
191
|
### Bug Fixes
|
|
199
192
|
|
|
200
|
-
|
|
193
|
+
- put back multiple flag descriptions ([4c340a8](https://github.com/forcedotcom/plugin-command-reference/commit/4c340a8f414d2e892e135797754883db040ff89a))
|
|
201
194
|
|
|
202
195
|
## [1.1.2](https://github.com/forcedotcom/plugin-command-reference/compare/v1.1.1...v1.1.2) (2020-08-12)
|
|
203
196
|
|
|
204
|
-
|
|
205
197
|
### Bug Fixes
|
|
206
198
|
|
|
207
|
-
|
|
199
|
+
- return parameters ([c713fd0](https://github.com/forcedotcom/plugin-command-reference/commit/c713fd0f7d3f93f64a7f76b9a430d43aeaca875f))
|
|
208
200
|
|
|
209
201
|
## [1.1.1](https://github.com/forcedotcom/plugin-command-reference/compare/v1.1.0...v1.1.1) (2020-08-06)
|
|
210
202
|
|
|
211
|
-
|
|
212
203
|
### Bug Fixes
|
|
213
204
|
|
|
214
|
-
|
|
205
|
+
- no multiline in description ([0b846b7](https://github.com/forcedotcom/plugin-command-reference/commit/0b846b7931a35e1cad4956fa918ece30650944f9))
|
|
215
206
|
|
|
216
207
|
# [1.1.0](https://github.com/forcedotcom/plugin-command-reference/compare/v1.0.7...v1.1.0) (2020-07-29)
|
|
217
208
|
|
|
218
|
-
|
|
219
209
|
### Features
|
|
220
210
|
|
|
221
|
-
|
|
211
|
+
- support no long description ([4b5dabc](https://github.com/forcedotcom/plugin-command-reference/commit/4b5dabc7acc30bd689bda110484e2c0e345d64da))
|
|
222
212
|
|
|
223
213
|
## [1.0.7](https://github.com/forcedotcom/plugin-command-reference/compare/v1.0.6...v1.0.7) (2020-03-11)
|
|
224
214
|
|
package/LICENSE.txt
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
Copyright (c) 2022, Salesforce.com, Inc.
|
|
2
|
+
All rights reserved.
|
|
3
|
+
|
|
4
|
+
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
|
|
5
|
+
|
|
6
|
+
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
|
|
7
|
+
|
|
8
|
+
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
|
|
9
|
+
|
|
10
|
+
* Neither the name of Salesforce.com nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
|
|
11
|
+
|
|
12
|
+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
package/README.md
CHANGED
|
@@ -65,7 +65,8 @@ sfdx commandreference --plugins alias,config,auth
|
|
|
65
65
|
## Commands
|
|
66
66
|
|
|
67
67
|
<!-- commands -->
|
|
68
|
-
|
|
68
|
+
|
|
69
|
+
- [`sfdx commandreference:generate [-d <string>] [-p <array>] [--hidden] [--erroronwarnings] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-commandreferencegenerate--d-string--p-array---hidden---erroronwarnings---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
|
|
69
70
|
|
|
70
71
|
## `sfdx commandreference:generate [-d <string>] [-p <array>] [--hidden] [--erroronwarnings] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
|
|
71
72
|
|
|
@@ -73,7 +74,7 @@ generate the command reference guide located
|
|
|
73
74
|
|
|
74
75
|
```
|
|
75
76
|
USAGE
|
|
76
|
-
$ sfdx commandreference:generate [-d <string>] [-p <array>] [--hidden] [--erroronwarnings] [--json] [--loglevel
|
|
77
|
+
$ sfdx commandreference:generate [-d <string>] [-p <array>] [--hidden] [--erroronwarnings] [--json] [--loglevel
|
|
77
78
|
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
|
|
78
79
|
|
|
79
80
|
OPTIONS
|
|
@@ -96,5 +97,6 @@ OPTIONS
|
|
|
96
97
|
this command invocation
|
|
97
98
|
```
|
|
98
99
|
|
|
99
|
-
_See code: [
|
|
100
|
+
_See code: [src/commands/commandreference/generate.ts](https://github.com/forcedotcom/plugin-command-reference/blob/v1.3.19/src/commands/commandreference/generate.ts)_
|
|
101
|
+
|
|
100
102
|
<!-- commandsstop -->
|
|
@@ -6,7 +6,7 @@ export default class CommandReferenceGenerate extends SfdxCommand {
|
|
|
6
6
|
name: string;
|
|
7
7
|
}[];
|
|
8
8
|
protected static flagsConfig: {
|
|
9
|
-
outputdir: flags.Discriminated<flags.
|
|
9
|
+
outputdir: flags.Discriminated<flags.String>;
|
|
10
10
|
plugins: flags.Discriminated<flags.Array<string>>;
|
|
11
11
|
hidden: flags.Discriminated<flags.Boolean<boolean>>;
|
|
12
12
|
erroronwarnings: flags.Discriminated<flags.Boolean<boolean>>;
|
|
@@ -6,12 +6,12 @@
|
|
|
6
6
|
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
7
7
|
*/
|
|
8
8
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
|
+
const os = require("os");
|
|
10
|
+
const path = require("path");
|
|
9
11
|
const command_1 = require("@salesforce/command");
|
|
10
12
|
const core_1 = require("@salesforce/core");
|
|
11
13
|
const ts_types_1 = require("@salesforce/ts-types");
|
|
12
14
|
const chalk = require("chalk");
|
|
13
|
-
const os = require("os");
|
|
14
|
-
const path = require("path");
|
|
15
15
|
const ditamap_1 = require("../../ditamap/ditamap");
|
|
16
16
|
const docs_1 = require("../../docs");
|
|
17
17
|
const utils_1 = require("../../utils");
|
|
@@ -37,8 +37,8 @@ class CommandReferenceGenerate extends command_1.SfdxCommand {
|
|
|
37
37
|
pluginNames = this.flags.plugins;
|
|
38
38
|
}
|
|
39
39
|
const plugins = pluginNames
|
|
40
|
-
.map(plugin => plugin.trim())
|
|
41
|
-
.map(name => {
|
|
40
|
+
.map((plugin) => plugin.trim())
|
|
41
|
+
.map((name) => {
|
|
42
42
|
let pluginName = name;
|
|
43
43
|
let plugin = this.getPlugin(pluginName);
|
|
44
44
|
if (!plugin) {
|
|
@@ -50,11 +50,11 @@ class CommandReferenceGenerate extends command_1.SfdxCommand {
|
|
|
50
50
|
}
|
|
51
51
|
return pluginName;
|
|
52
52
|
});
|
|
53
|
-
this.ux.log(`Generating command reference for the following plugins:${plugins.map(name => `${os.EOL} - ${name}`)}`);
|
|
53
|
+
this.ux.log(`Generating command reference for the following plugins:${plugins.map((name) => `${os.EOL} - ${name}`)}`);
|
|
54
54
|
ditamap_1.Ditamap.outputDir = this.flags.outputdir;
|
|
55
55
|
ditamap_1.Ditamap.cliVersion = this.config.version.replace(/-[0-9a-zA-Z]+$/, '');
|
|
56
56
|
ditamap_1.Ditamap.plugins = this.pluginMap(plugins);
|
|
57
|
-
ditamap_1.Ditamap.pluginVersions = plugins.map(name => {
|
|
57
|
+
ditamap_1.Ditamap.pluginVersions = plugins.map((name) => {
|
|
58
58
|
const plugin = this.getPlugin(name);
|
|
59
59
|
const version = plugin && plugin.version;
|
|
60
60
|
if (!version)
|
|
@@ -66,7 +66,7 @@ class CommandReferenceGenerate extends command_1.SfdxCommand {
|
|
|
66
66
|
this.log(chalk.green(`Generating topic '${topic}'`));
|
|
67
67
|
});
|
|
68
68
|
const warnings = [];
|
|
69
|
-
utils_1.events.on('warning', msg => {
|
|
69
|
+
utils_1.events.on('warning', (msg) => {
|
|
70
70
|
process.stderr.write(chalk.yellow(`> ${msg}\n`));
|
|
71
71
|
warnings.push(msg);
|
|
72
72
|
});
|
|
@@ -96,7 +96,7 @@ class CommandReferenceGenerate extends command_1.SfdxCommand {
|
|
|
96
96
|
return pluginToParentPlugin;
|
|
97
97
|
}
|
|
98
98
|
getPlugin(pluginName) {
|
|
99
|
-
return this.config.plugins.find(info => info.name === pluginName);
|
|
99
|
+
return this.config.plugins.find((info) => info.name === pluginName);
|
|
100
100
|
}
|
|
101
101
|
async loadTopicMetadata() {
|
|
102
102
|
const plugins = {};
|
|
@@ -118,13 +118,13 @@ class CommandReferenceGenerate extends command_1.SfdxCommand {
|
|
|
118
118
|
try {
|
|
119
119
|
let commandClass = await this.loadCommand(cmd);
|
|
120
120
|
let obj = Object.assign({}, cmd, commandClass, {
|
|
121
|
-
flags: Object.assign({}, cmd.flags, commandClass.flags)
|
|
121
|
+
flags: Object.assign({}, cmd.flags, commandClass.flags),
|
|
122
122
|
});
|
|
123
123
|
// Load all properties on all extending classes.
|
|
124
124
|
while (commandClass !== undefined) {
|
|
125
125
|
commandClass = Object.getPrototypeOf(commandClass) || undefined;
|
|
126
126
|
obj = Object.assign({}, commandClass, obj, {
|
|
127
|
-
flags: Object.assign({}, commandClass && commandClass.flags, obj.flags)
|
|
127
|
+
flags: Object.assign({}, commandClass && commandClass.flags, obj.flags),
|
|
128
128
|
});
|
|
129
129
|
}
|
|
130
130
|
return obj;
|
|
@@ -146,13 +146,13 @@ CommandReferenceGenerate.flagsConfig = {
|
|
|
146
146
|
outputdir: command_1.flags.string({
|
|
147
147
|
char: 'd',
|
|
148
148
|
description: messages.getMessage('outputdirFlagDescription'),
|
|
149
|
-
default: './tmp/root'
|
|
149
|
+
default: './tmp/root',
|
|
150
150
|
}),
|
|
151
151
|
plugins: command_1.flags.array({
|
|
152
152
|
char: 'p',
|
|
153
|
-
description: messages.getMessage('pluginFlagDescription')
|
|
153
|
+
description: messages.getMessage('pluginFlagDescription'),
|
|
154
154
|
}),
|
|
155
155
|
hidden: command_1.flags.boolean({ description: messages.getMessage('hiddenFlagDescription') }),
|
|
156
|
-
erroronwarnings: command_1.flags.boolean({ description: messages.getMessage('erroronwarningFlagDescription') })
|
|
156
|
+
erroronwarnings: command_1.flags.boolean({ description: messages.getMessage('erroronwarningFlagDescription') }),
|
|
157
157
|
};
|
|
158
158
|
//# sourceMappingURL=generate.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../../src/commands/commandreference/generate.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;
|
|
1
|
+
{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../../src/commands/commandreference/generate.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAEH,yBAAyB;AACzB,6BAA6B;AAE7B,iDAAyD;AACzD,2CAA2D;AAC3D,mDAAuF;AACvF,+BAAgC;AAChC,mDAAgD;AAChD,qCAAkC;AAClC,uCAAgD;AAEhD,wDAAwD;AACxD,eAAQ,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;AAE5C,iGAAiG;AACjG,mFAAmF;AACnF,MAAM,QAAQ,GAAG,eAAQ,CAAC,YAAY,CAAC,sCAAsC,EAAE,MAAM,CAAC,CAAC;AAEvF,MAAqB,wBAAyB,SAAQ,qBAAW;IAmBxD,KAAK,CAAC,GAAG;QACd,IAAI,WAAqB,CAAC;QAC1B,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE;YACvB,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,cAAc,CAAC,CAAC;YAC3D,IAAI,MAAM,SAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;gBAClC,MAAM,WAAW,GAAG,MAAM,SAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;gBACjD,WAAW,GAAG,CAAC,oBAAS,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC,CAAC;aAChD;iBAAM;gBACL,MAAM,IAAI,gBAAS,CACjB,8GAA8G,CAC/G,CAAC;aACH;SACF;aAAM;YACL,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC;SAClC;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,gBAAS,CAAC,UAAU,IAAI,OAAO,UAAU,8BAA8B,CAAC,CAAC;iBACpF;aACF;YACD,OAAO,UAAU,CAAC;QACpB,CAAC,CAAC,CAAC;QACL,IAAI,CAAC,EAAE,CAAC,GAAG,CACT,0DAA0D,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO,IAAI,EAAE,CAAC,EAAE,CAC1G,CAAC;QACF,iBAAO,CAAC,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC;QAEzC,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,CAAC,iBAAO,CAAC,SAAS,EAAE,iBAAO,CAAC,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC,CAAC;QAE7G,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,IAAI,CAAC,KAAK,CAAC,eAAe,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;YACrD,MAAM,IAAI,gBAAS,CAAC,SAAS,QAAQ,CAAC,MAAM,YAAY,CAAC,CAAC;SAC3D;QAED,OAAO,EAAE,QAAQ,EAAE,CAAC;IACtB,CAAC;IAEO,SAAS,CAAC,OAAiB;QACjC,MAAM,oBAAoB,GAAY,EAAE,CAAC;QAEzC,MAAM,mBAAmB,GAAG,CAAC,YAAqB,EAAE,EAAE;YACpD,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,iBAAM,CAAC,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,gBAAS,CAAC,UAAU,MAAM,8BAA8B,CAAC,CAAC;aACrE;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,iBAAS,CAAC,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;;AA3JH,2CA4JC;AA3Je,oCAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAC;AAExD,6BAAI,GAAG,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;AAEvB,oCAAW,GAAG;IAC7B,SAAS,EAAE,eAAK,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,eAAK,CAAC,KAAK,CAAC;QACnB,IAAI,EAAE,GAAG;QACT,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,uBAAuB,CAAC;KAC1D,CAAC;IACF,MAAM,EAAE,eAAK,CAAC,OAAO,CAAC,EAAE,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,uBAAuB,CAAC,EAAE,CAAC;IACpF,eAAe,EAAE,eAAK,CAAC,OAAO,CAAC,EAAE,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,+BAA+B,CAAC,EAAE,CAAC;CACtG,CAAC"}
|
|
@@ -6,12 +6,13 @@
|
|
|
6
6
|
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
7
7
|
*/
|
|
8
8
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
|
+
exports.BaseDitamap = void 0;
|
|
9
10
|
const ditamap_1 = require("./ditamap");
|
|
10
11
|
class BaseDitamap extends ditamap_1.Ditamap {
|
|
11
12
|
constructor(topics) {
|
|
12
13
|
// Set the data of topic and filenames
|
|
13
14
|
super('cli_reference_sfdx.ditamap', {
|
|
14
|
-
namespaceDitamapFiles: topics.sort().map(topic => `${topic}/cli_reference_${topic}.ditamap`)
|
|
15
|
+
namespaceDitamapFiles: topics.sort().map((topic) => `${topic}/cli_reference_${topic}.ditamap`),
|
|
15
16
|
});
|
|
16
17
|
}
|
|
17
18
|
getTemplateFileName() {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"base-ditamap.js","sourceRoot":"","sources":["../../src/ditamap/base-ditamap.ts"],"names":[],"mappings":";AAAA;;;;;GAKG
|
|
1
|
+
{"version":3,"file":"base-ditamap.js","sourceRoot":"","sources":["../../src/ditamap/base-ditamap.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,uCAAoC;AAEpC,MAAa,WAAY,SAAQ,iBAAO;IACtC,YAAmB,MAAgB;QACjC,sCAAsC;QACtC,KAAK,CAAC,4BAA4B,EAAE;YAClC,qBAAqB,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,KAAK,kBAAkB,KAAK,UAAU,CAAC;SAC/F,CAAC,CAAC;IACL,CAAC;IAEM,mBAAmB;QACxB,OAAO,kBAAkB,CAAC;IAC5B,CAAC;CACF;AAXD,kCAWC"}
|
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
7
7
|
*/
|
|
8
8
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
|
+
exports.CLIReferenceTopic = void 0;
|
|
9
10
|
const path_1 = require("path");
|
|
10
11
|
const ditamap_1 = require("./ditamap");
|
|
11
12
|
class CLIReferenceTopic extends ditamap_1.Ditamap {
|
|
@@ -14,7 +15,7 @@ class CLIReferenceTopic extends ditamap_1.Ditamap {
|
|
|
14
15
|
// Set the data of topic and filenames
|
|
15
16
|
super(filename, {
|
|
16
17
|
topic,
|
|
17
|
-
longDescription
|
|
18
|
+
longDescription,
|
|
18
19
|
});
|
|
19
20
|
// Override destination to include topic and subtopic
|
|
20
21
|
this.destination = path_1.join(ditamap_1.Ditamap.outputDir, topic, filename);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cli-reference-topic.js","sourceRoot":"","sources":["../../src/ditamap/cli-reference-topic.ts"],"names":[],"mappings":";AAAA;;;;;GAKG
|
|
1
|
+
{"version":3,"file":"cli-reference-topic.js","sourceRoot":"","sources":["../../src/ditamap/cli-reference-topic.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,+BAA4B;AAC5B,uCAAoC;AAEpC,MAAa,iBAAkB,SAAQ,iBAAO;IAC5C,YAAmB,KAAa,EAAE,eAAuB;QACvD,MAAM,QAAQ,GAAG,iBAAiB,KAAK,MAAM,CAAC;QAC9C,sCAAsC;QACtC,KAAK,CAAC,QAAQ,EAAE;YACd,KAAK;YACL,eAAe;SAChB,CAAC,CAAC;QAEH,qDAAqD;QACrD,IAAI,CAAC,WAAW,GAAG,WAAI,CAAC,iBAAO,CAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC9D,CAAC;IAEM,mBAAmB;QACxB,OAAO,yBAAyB,CAAC;IACnC,CAAC;CACF;AAhBD,8CAgBC"}
|
|
@@ -6,13 +6,14 @@
|
|
|
6
6
|
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
7
7
|
*/
|
|
8
8
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
|
+
exports.CLIReference = void 0;
|
|
9
10
|
const ditamap_1 = require("./ditamap");
|
|
10
11
|
class CLIReference extends ditamap_1.Ditamap {
|
|
11
12
|
constructor() {
|
|
12
13
|
const filename = 'cli_reference.xml';
|
|
13
14
|
super(filename, {
|
|
14
15
|
cliVersion: ditamap_1.Ditamap.cliVersion,
|
|
15
|
-
pluginVersions: ditamap_1.Ditamap.pluginVersions
|
|
16
|
+
pluginVersions: ditamap_1.Ditamap.pluginVersions,
|
|
16
17
|
});
|
|
17
18
|
}
|
|
18
19
|
getTemplateFileName() {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cli-reference.js","sourceRoot":"","sources":["../../src/ditamap/cli-reference.ts"],"names":[],"mappings":";AAAA;;;;;GAKG
|
|
1
|
+
{"version":3,"file":"cli-reference.js","sourceRoot":"","sources":["../../src/ditamap/cli-reference.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,uCAAoC;AAEpC,MAAa,YAAa,SAAQ,iBAAO;IACvC;QACE,MAAM,QAAQ,GAAG,mBAAmB,CAAC;QAErC,KAAK,CAAC,QAAQ,EAAE;YACd,UAAU,EAAE,iBAAO,CAAC,UAAU;YAC9B,cAAc,EAAE,iBAAO,CAAC,cAAc;SACvC,CAAC,CAAC;IACL,CAAC;IAEM,mBAAmB;QACxB,OAAO,uBAAuB,CAAC;IACjC,CAAC;CACF;AAbD,oCAaC"}
|
package/lib/ditamap/command.js
CHANGED
|
@@ -6,8 +6,9 @@
|
|
|
6
6
|
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
7
7
|
*/
|
|
8
8
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
|
-
|
|
9
|
+
exports.Command = void 0;
|
|
10
10
|
const path_1 = require("path");
|
|
11
|
+
const ts_types_1 = require("@salesforce/ts-types");
|
|
11
12
|
const utils_1 = require("../utils");
|
|
12
13
|
const ditamap_1 = require("./ditamap");
|
|
13
14
|
class Command extends ditamap_1.Ditamap {
|
|
@@ -52,7 +53,7 @@ class Command extends ditamap_1.Ditamap {
|
|
|
52
53
|
isOpenPilotCommand: state === 'openPilot',
|
|
53
54
|
isBetaCommand: state === 'beta',
|
|
54
55
|
trailblazerCommunityUrl,
|
|
55
|
-
trailblazerCommunityName
|
|
56
|
+
trailblazerCommunityName,
|
|
56
57
|
});
|
|
57
58
|
// Override destination to include topic and subtopic
|
|
58
59
|
if (subtopic) {
|
|
@@ -75,7 +76,7 @@ class Command extends ditamap_1.Ditamap {
|
|
|
75
76
|
description,
|
|
76
77
|
optional: !flag.required,
|
|
77
78
|
kind: flag.kind || flag.type,
|
|
78
|
-
hasValue: flag.type !== 'boolean'
|
|
79
|
+
hasValue: flag.type !== 'boolean',
|
|
79
80
|
});
|
|
80
81
|
});
|
|
81
82
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"command.js","sourceRoot":"","sources":["../../src/ditamap/command.ts"],"names":[],"mappings":";AAAA;;;;;GAKG
|
|
1
|
+
{"version":3,"file":"command.js","sourceRoot":"","sources":["../../src/ditamap/command.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,+BAA4B;AAC5B,mDAAgH;AAChH,oCAAkE;AAClE,uCAAoC;AAWpC,MAAa,OAAQ,SAAQ,iBAAO;IAClC,YAAmB,KAAa,EAAE,QAAgB,EAAE,OAAmB,EAAE,cAAuB,EAAE;QAChG,MAAM,sBAAsB,GAAG,uBAAY,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAC3E,MAAM,QAAQ,GAAG,iBAAiB,sBAAsB,MAAM,CAAC;QAE/D,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QAEpB,MAAM,KAAK,GAAG,uBAAY,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC1C,MAAM,UAAU,GAAG,IAAI,CAAC,wBAAwB,CAAC,KAAoC,CAAC,CAAC;QAEvF,0HAA0H;QAC1H,MAAM,eAAe,GAAG,mBAAQ,CAAC,OAAO,CAAC,eAAe,CAAC,IAAI,mBAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAC3F,MAAM,WAAW,GAAG,iBAAS,CAAC,eAAe,CAAC,CAAC;QAC/C,2HAA2H;QAC3H,gBAAgB;QAEhB,IAAI,CAAC,WAAW,EAAE;YAChB,cAAM,CAAC,IAAI,CAAC,SAAS,EAAE,2BAA2B,OAAO,CAAC,EAAE,IAAI,CAAC,CAAC;SACnE;QAED,MAAM,IAAI,GAAG,IAAI,CAAC,gBAAgB,CAAC,mBAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,2BAAmB,CAAC,eAAe,CAAC,CAAC,CAAC;QACnG,IAAI,uBAAuB,CAAC;QAC5B,IAAI,wBAAwB,CAAC;QAE7B,IAAI,WAAW,CAAC,wBAAwB,EAAE;YACxC,MAAM,SAAS,GAAG,wBAAa,CAAC,WAAW,CAAC,wBAAwB,CAAC,CAAC;YACtE,uBAAuB,GAAG,SAAS,CAAC,GAAG,CAAC;YACxC,wBAAwB,GAAG,SAAS,CAAC,IAAI,CAAC;SAC3C;QAED,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;YACnC,IACE,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC;gBAC1B,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,QAAQ,EAAE,EAAE,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,EACrF;gBACA,wDAAwD;gBACxD,gEAAgE;gBAChE,OAAO,OAAO,CAAC,QAAQ,CAAC;aACzB;SACF;QAED,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,WAAW,CAAC,KAAK,CAAC;QACjD,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE;YACjC,MAAM,EAAE,MAAM;YACd,sBAAsB;YACtB,IAAI;YACJ,WAAW;YACX,UAAU;YACV,oBAAoB,EAAE,KAAK,KAAK,aAAa;YAC7C,kBAAkB,EAAE,KAAK,KAAK,WAAW;YACzC,aAAa,EAAE,KAAK,KAAK,MAAM;YAC/B,uBAAuB;YACvB,wBAAwB;SACzB,CAAY,CAAC;QAEd,qDAAqD;QACrD,IAAI,QAAQ,EAAE;YACZ,IAAI,CAAC,WAAW,GAAG,WAAI,CAAC,iBAAO,CAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;SACvE;aAAM;YACL,IAAI,CAAC,WAAW,GAAG,WAAI,CAAC,iBAAO,CAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;SAC7D;IACH,CAAC;IAEM,wBAAwB,CAAC,KAAkC;QAChE,OAAO,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC;aACzB,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;aAClC,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,IAAI,CAAC,EAAE,EAAE;YACxB,MAAM,WAAW,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,eAAe,IAAI,iBAAS,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;YAC/F,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE;gBACzB,IAAI,CAAC,eAAe,GAAG,iBAAS,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;aACpD;YACD,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE;gBACzB,IAAI,EAAE,QAAQ;gBACd,WAAW;gBACX,QAAQ,EAAE,CAAC,IAAI,CAAC,QAAQ;gBACxB,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI;gBAC5B,QAAQ,EAAE,IAAI,CAAC,IAAI,KAAK,SAAS;aAClC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAEM,mBAAmB;QACxB,OAAO,aAAa,CAAC;IACvB,CAAC;CACF;AApFD,0BAoFC"}
|
package/lib/ditamap/ditamap.d.ts
CHANGED
|
@@ -13,16 +13,17 @@ export declare abstract class Ditamap {
|
|
|
13
13
|
protected destination: string;
|
|
14
14
|
private source;
|
|
15
15
|
constructor(filename: string, data: JsonMap);
|
|
16
|
-
abstract getTemplateFileName(): string;
|
|
17
16
|
getFilename(): string;
|
|
18
17
|
getOutputFilePath(): string;
|
|
19
18
|
write(): Promise<void>;
|
|
20
19
|
protected formatParagraphs(textToFormat?: string): string[];
|
|
21
20
|
/**
|
|
22
21
|
* Applies the named handlebars template to the supplied data
|
|
22
|
+
*
|
|
23
23
|
* @param data
|
|
24
24
|
* @param templateName
|
|
25
25
|
* @returns {object}
|
|
26
26
|
*/
|
|
27
27
|
private transformToDitamap;
|
|
28
|
+
abstract getTemplateFileName(): string;
|
|
28
29
|
}
|
package/lib/ditamap/ditamap.js
CHANGED
|
@@ -6,25 +6,30 @@
|
|
|
6
6
|
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
7
7
|
*/
|
|
8
8
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
|
+
exports.Ditamap = void 0;
|
|
10
|
+
const path_1 = require("path");
|
|
9
11
|
const core_1 = require("@salesforce/core");
|
|
10
12
|
const debugCreator = require("debug");
|
|
11
13
|
const handlebars_1 = require("handlebars");
|
|
12
|
-
const path_1 = require("path");
|
|
13
14
|
const debug = debugCreator('commandreference');
|
|
14
|
-
handlebars_1.registerHelper('toUpperCase', str => str.toUpperCase());
|
|
15
|
-
handlebars_1.registerHelper('join', array => array.join(', '));
|
|
16
|
-
/*
|
|
17
|
-
* Returns true if the string should be formatted as code block in docs
|
|
18
|
-
*/
|
|
19
|
-
// tslint:disable-next-line: no-any
|
|
20
|
-
handlebars_1.registerHelper('isCodeBlock', function (val, options) {
|
|
21
|
-
return val.indexOf('$ sfdx') >= 0 || val.indexOf('>>') >= 0 ? options.fn(this) : options.inverse(this);
|
|
22
|
-
});
|
|
23
|
-
handlebars_1.registerHelper('nextVersion', value => parseInt(value, 2) + 1);
|
|
24
15
|
class Ditamap {
|
|
25
16
|
constructor(filename, data) {
|
|
26
17
|
this.filename = filename;
|
|
27
18
|
this.data = data;
|
|
19
|
+
handlebars_1.registerHelper('toUpperCase', (str) => str.toUpperCase());
|
|
20
|
+
handlebars_1.registerHelper('join', (array) => array.join(', '));
|
|
21
|
+
/*
|
|
22
|
+
* Returns true if the string should be formatted as code block in docs
|
|
23
|
+
*/
|
|
24
|
+
// tslint:disable-next-line: no-any
|
|
25
|
+
handlebars_1.registerHelper('isCodeBlock', function (val, options) {
|
|
26
|
+
return val.indexOf('$ sfdx') >= 0 || val.indexOf('>>') >= 0 ? options.fn(this) : options.inverse(this);
|
|
27
|
+
});
|
|
28
|
+
/*
|
|
29
|
+
* Remove OS prompt in codeblocks, as per CCX style guidelines in our published docs
|
|
30
|
+
*/
|
|
31
|
+
handlebars_1.registerHelper('removePrompt', (codeblock) => codeblock.substring(codeblock.indexOf('$') + 1));
|
|
32
|
+
handlebars_1.registerHelper('nextVersion', (value) => parseInt(value, 2) + 1);
|
|
28
33
|
this.source = path_1.join(Ditamap.templatesDir, this.getTemplateFileName());
|
|
29
34
|
this.destination = path_1.join(Ditamap.outputDir, filename);
|
|
30
35
|
}
|
|
@@ -40,10 +45,11 @@ class Ditamap {
|
|
|
40
45
|
await core_1.fs.writeFile(this.destination, output);
|
|
41
46
|
}
|
|
42
47
|
formatParagraphs(textToFormat) {
|
|
43
|
-
return textToFormat ? textToFormat.split('\n').filter(n => n !== '') : [];
|
|
48
|
+
return textToFormat ? textToFormat.split('\n').filter((n) => n !== '') : [];
|
|
44
49
|
}
|
|
45
50
|
/**
|
|
46
51
|
* Applies the named handlebars template to the supplied data
|
|
52
|
+
*
|
|
47
53
|
* @param data
|
|
48
54
|
* @param templateName
|
|
49
55
|
* @returns {object}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ditamap.js","sourceRoot":"","sources":["../../src/ditamap/ditamap.ts"],"names":[],"mappings":";AAAA;;;;;GAKG
|
|
1
|
+
{"version":3,"file":"ditamap.js","sourceRoot":"","sources":["../../src/ditamap/ditamap.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,+BAAqC;AACrC,2CAAsC;AAEtC,sCAAsC;AACtC,2CAAqD;AAErD,MAAM,KAAK,GAAG,YAAY,CAAC,kBAAkB,CAAC,CAAC;AAE/C,MAAsB,OAAO;IAkB3B,YAA2B,QAAgB,EAAY,IAAa;QAAzC,aAAQ,GAAR,QAAQ,CAAQ;QAAY,SAAI,GAAJ,IAAI,CAAS;QAClE,2BAAc,CAAC,aAAa,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC;QAC1D,2BAAc,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAEpD;;WAEG;QACH,mCAAmC;QACnC,2BAAc,CAAC,aAAa,EAAE,UAAqB,GAAG,EAAE,OAAO;YAC7D,OAAO,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACzG,CAAC,CAAC,CAAC;QAEH;;WAEG;QACH,2BAAc,CAAC,cAAc,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,SAAS,CAAE,SAAS,CAAC,OAAO,CAAC,GAAG,CAAY,GAAG,CAAC,CAAC,CAAC,CAAC;QAC3G,2BAAc,CAAC,aAAa,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QACjE,IAAI,CAAC,MAAM,GAAG,WAAI,CAAC,OAAO,CAAC,YAAY,EAAE,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC;QACrE,IAAI,CAAC,WAAW,GAAG,WAAI,CAAC,OAAO,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IACvD,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,SAAE,CAAC,MAAM,CAAC,cAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;QAC3C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAE/C,MAAM,SAAE,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,SAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACnD,MAAM,QAAQ,GAAG,oBAAO,CAAC,GAAG,CAAC,CAAC;QAC9B,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;;AAtEH,0BAyEC;AAxEe,oBAAY,GAAG,WAAI,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC"}
|
|
@@ -5,9 +5,11 @@
|
|
|
5
5
|
* Licensed under the BSD 3-Clause license.
|
|
6
6
|
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
7
7
|
*/
|
|
8
|
+
/* eslint-disable @typescript-eslint/no-unsafe-assignment */
|
|
8
9
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
|
-
|
|
10
|
+
exports.MainTopicIntro = void 0;
|
|
10
11
|
const path_1 = require("path");
|
|
12
|
+
const ts_types_1 = require("@salesforce/ts-types");
|
|
11
13
|
const utils_1 = require("../utils");
|
|
12
14
|
const ditamap_1 = require("./ditamap");
|
|
13
15
|
class MainTopicIntro extends ditamap_1.Ditamap {
|
|
@@ -30,7 +32,7 @@ class MainTopicIntro extends ditamap_1.Ditamap {
|
|
|
30
32
|
isClosedPilotTopic: subTopicMeta.state === 'closedPilot',
|
|
31
33
|
isBetaTopic: subTopicMeta.state === 'beta',
|
|
32
34
|
trailblazerCommunityUrl,
|
|
33
|
-
trailblazerCommunityName
|
|
35
|
+
trailblazerCommunityName,
|
|
34
36
|
});
|
|
35
37
|
// Override destination to include topic and subtopic
|
|
36
38
|
this.destination = path_1.join(ditamap_1.Ditamap.outputDir, topic, subtopic, filename);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"main-topic-intro.js","sourceRoot":"","sources":["../../src/ditamap/main-topic-intro.ts"],"names":[],"mappings":";AAAA;;;;;GAKG
|
|
1
|
+
{"version":3,"file":"main-topic-intro.js","sourceRoot":"","sources":["../../src/ditamap/main-topic-intro.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;AACH,4DAA4D;;;AAE5D,+BAA4B;AAC5B,mDAAwE;AACxE,oCAAqC;AACrC,uCAAoC;AAEpC,MAAa,cAAe,SAAQ,iBAAO;IACzC,YAAmB,KAAa,EAAE,QAAgB,EAAE,YAAqB;QACvE,MAAM,QAAQ,GAAG,iBAAiB,KAAK,IAAI,QAAQ,MAAM,CAAC;QAE1D,IAAI,uBAAuB,CAAC;QAC5B,IAAI,wBAAwB,CAAC;QAC7B,IAAI,YAAY,CAAC,wBAAwB,EAAE;YACzC,MAAM,SAAS,GAAG,wBAAa,CAAC,YAAY,CAAC,wBAAwB,CAAC,CAAC;YACvE,uBAAuB,GAAG,SAAS,CAAC,GAAG,CAAC;YACxC,wBAAwB,GAAG,SAAS,CAAC,IAAI,CAAC;SAC3C;QAED,IAAI,CAAC,YAAY,CAAC,eAAe,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE;YAC3D,YAAY,CAAC,eAAe,GAAG,iBAAS,CAAC,mBAAQ,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC,CAAC;SAC9E;QAED,KAAK,CAAC,QAAQ,EAAE;YACd,KAAK,EAAE,QAAQ;YACf,eAAe,EAAE,YAAY,CAAC,eAAe;YAC7C,gBAAgB,EAAE,YAAY,CAAC,KAAK,KAAK,WAAW;YACpD,kBAAkB,EAAE,YAAY,CAAC,KAAK,KAAK,aAAa;YACxD,WAAW,EAAE,YAAY,CAAC,KAAK,KAAK,MAAM;YAC1C,uBAAuB;YACvB,wBAAwB;SACzB,CAAC,CAAC;QAEH,qDAAqD;QACrD,IAAI,CAAC,WAAW,GAAG,WAAI,CAAC,iBAAO,CAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACxE,CAAC;IAEM,mBAAmB;QACxB,OAAO,sBAAsB,CAAC;IAChC,CAAC;CACF;AAjCD,wCAiCC"}
|
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
7
7
|
*/
|
|
8
8
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
|
+
exports.SubTopicDitamap = void 0;
|
|
9
10
|
const path_1 = require("path");
|
|
10
11
|
const ditamap_1 = require("./ditamap");
|
|
11
12
|
class SubTopicDitamap extends ditamap_1.Ditamap {
|
|
@@ -16,7 +17,7 @@ class SubTopicDitamap extends ditamap_1.Ditamap {
|
|
|
16
17
|
super(filename, {
|
|
17
18
|
topic,
|
|
18
19
|
subtopic,
|
|
19
|
-
commandFileNames
|
|
20
|
+
commandFileNames,
|
|
20
21
|
});
|
|
21
22
|
// Override destination to include topic and subtopic
|
|
22
23
|
this.destination = path_1.join(ditamap_1.Ditamap.outputDir, topic, subtopic, filename);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"subtopic-ditamap.js","sourceRoot":"","sources":["../../src/ditamap/subtopic-ditamap.ts"],"names":[],"mappings":";AAAA;;;;;GAKG
|
|
1
|
+
{"version":3,"file":"subtopic-ditamap.js","sourceRoot":"","sources":["../../src/ditamap/subtopic-ditamap.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,+BAA4B;AAC5B,uCAAoC;AAEpC,MAAa,eAAgB,SAAQ,iBAAO;IAC1C,YAAmB,KAAa,EAAE,QAAgB,EAAE,gBAA0B;QAC5E,MAAM,QAAQ,GAAG,iBAAiB,KAAK,IAAI,QAAQ,UAAU,CAAC;QAE9D,gBAAgB,CAAC,IAAI,EAAE,CAAC;QAExB,sCAAsC;QACtC,KAAK,CAAC,QAAQ,EAAE;YACd,KAAK;YACL,QAAQ;YACR,gBAAgB;SACjB,CAAC,CAAC;QAEH,qDAAqD;QACrD,IAAI,CAAC,WAAW,GAAG,WAAI,CAAC,iBAAO,CAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACxE,CAAC;IAEM,mBAAmB;QACxB,OAAO,sBAAsB,CAAC;IAChC,CAAC;CACF;AApBD,0CAoBC"}
|
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
7
7
|
*/
|
|
8
8
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
|
+
exports.TopicDitamap = void 0;
|
|
9
10
|
const path_1 = require("path");
|
|
10
11
|
const ditamap_1 = require("./ditamap");
|
|
11
12
|
class TopicDitamap extends ditamap_1.Ditamap {
|
|
@@ -14,8 +15,8 @@ class TopicDitamap extends ditamap_1.Ditamap {
|
|
|
14
15
|
// Set the data of topic and filenames
|
|
15
16
|
super(filename, {
|
|
16
17
|
topic,
|
|
17
|
-
subtopics: subtopics.sort().map(subtopic => ({ subtopic })),
|
|
18
|
-
commands: commandNames.sort().map(command => ({ command }))
|
|
18
|
+
subtopics: subtopics.sort().map((subtopic) => ({ subtopic })),
|
|
19
|
+
commands: commandNames.sort().map((command) => ({ command })),
|
|
19
20
|
});
|
|
20
21
|
// Override destination to include topic and subtopic
|
|
21
22
|
this.destination = path_1.join(ditamap_1.Ditamap.outputDir, topic, filename);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"topic-ditamap.js","sourceRoot":"","sources":["../../src/ditamap/topic-ditamap.ts"],"names":[],"mappings":";AAAA;;;;;GAKG
|
|
1
|
+
{"version":3,"file":"topic-ditamap.js","sourceRoot":"","sources":["../../src/ditamap/topic-ditamap.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,+BAA4B;AAC5B,uCAAoC;AAEpC,MAAa,YAAa,SAAQ,iBAAO;IACvC,YAAmB,KAAa,EAAE,SAAmB,EAAE,YAAsB;QAC3E,MAAM,QAAQ,GAAG,iBAAiB,KAAK,UAAU,CAAC;QAClD,sCAAsC;QACtC,KAAK,CAAC,QAAQ,EAAE;YACd,KAAK;YACL,SAAS,EAAE,SAAS,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;YAC7D,QAAQ,EAAE,YAAY,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;SAC9D,CAAC,CAAC;QAEH,qDAAqD;QACrD,IAAI,CAAC,WAAW,GAAG,WAAI,CAAC,iBAAO,CAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC9D,CAAC;IAEM,mBAAmB;QACxB,OAAO,mBAAmB,CAAC;IAC7B,CAAC;CACF;AAjBD,oCAiBC"}
|
package/lib/docs.d.ts
CHANGED
|
@@ -10,6 +10,7 @@ export declare class Docs {
|
|
|
10
10
|
/**
|
|
11
11
|
* Group all commands by the top level topic and then subtopic. e.g. force, analytics, evergreen, etc
|
|
12
12
|
* then org, apex, etc within the force namespace.
|
|
13
|
+
*
|
|
13
14
|
* @param commands - The entire set of command data.
|
|
14
15
|
* @returns The commands grouped by topics/subtopic/commands.
|
|
15
16
|
*/
|
package/lib/docs.js
CHANGED
|
@@ -6,10 +6,11 @@
|
|
|
6
6
|
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
7
7
|
*/
|
|
8
8
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
|
+
exports.Docs = void 0;
|
|
10
|
+
const path_1 = require("path");
|
|
9
11
|
const core_1 = require("@salesforce/core");
|
|
10
12
|
const ts_types_1 = require("@salesforce/ts-types");
|
|
11
13
|
const chalk = require("chalk");
|
|
12
|
-
const path_1 = require("path");
|
|
13
14
|
const base_ditamap_1 = require("./ditamap/base-ditamap");
|
|
14
15
|
const cli_reference_1 = require("./ditamap/cli-reference");
|
|
15
16
|
const cli_reference_topic_1 = require("./ditamap/cli-reference-topic");
|
|
@@ -31,6 +32,7 @@ class Docs {
|
|
|
31
32
|
await core_1.fs.mkdirp(this.outputDir);
|
|
32
33
|
await this.populateTemplate(commands);
|
|
33
34
|
}
|
|
35
|
+
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
34
36
|
async populateTopic(topic, subtopics) {
|
|
35
37
|
const topicMeta = ts_types_1.ensureJsonMap(this.topicMeta[topic], `No topic meta for ${topic} - add this topic to the oclif section of the package.json.`);
|
|
36
38
|
let description = ts_types_1.asString(topicMeta.longDescription);
|
|
@@ -70,7 +72,7 @@ class Docs {
|
|
|
70
72
|
const filenames = [];
|
|
71
73
|
for (const command of subtopicOrCommand) {
|
|
72
74
|
const fullTopic = ts_types_1.ensureString(command.id).replace(/:\w+$/, '');
|
|
73
|
-
const commandsInFullTopic = subtopicOrCommand.filter(cmd => ts_types_1.ensureString(cmd.id).indexOf(fullTopic) === 0);
|
|
75
|
+
const commandsInFullTopic = subtopicOrCommand.filter((cmd) => ts_types_1.ensureString(cmd.id).indexOf(fullTopic) === 0);
|
|
74
76
|
const commandMeta = this.resolveCommandMeta(ts_types_1.ensureString(command.id), command, commandsInFullTopic.length);
|
|
75
77
|
filenames.push(await this.populateCommand(topic, subtopic, command, commandMeta));
|
|
76
78
|
}
|
|
@@ -88,6 +90,7 @@ class Docs {
|
|
|
88
90
|
/**
|
|
89
91
|
* Group all commands by the top level topic and then subtopic. e.g. force, analytics, evergreen, etc
|
|
90
92
|
* then org, apex, etc within the force namespace.
|
|
93
|
+
*
|
|
91
94
|
* @param commands - The entire set of command data.
|
|
92
95
|
* @returns The commands grouped by topics/subtopic/commands.
|
|
93
96
|
*/
|
|
@@ -120,7 +123,9 @@ class Docs {
|
|
|
120
123
|
continue;
|
|
121
124
|
}
|
|
122
125
|
}
|
|
123
|
-
catch (e) {
|
|
126
|
+
catch (e) {
|
|
127
|
+
// It means no meta so it isn't hidden, although it should always fail before here with no meta found
|
|
128
|
+
}
|
|
124
129
|
command.subtopic = subtopic;
|
|
125
130
|
const existingSubTopics = topics[subtopic];
|
|
126
131
|
let subtopicCommands = [];
|
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,+BAA4B;AAE5B,2CAAsC;AACtC,mDAS8B;AAC9B,+BAA+B;AAC/B,yDAAqD;AACrD,2DAAuD;AACvD,uEAAkE;AAClE,+CAA4C;AAC5C,iEAA4D;AAC5D,iEAA6D;AAC7D,2DAAuD;AACvD,mCAA4D;AAE5D,MAAM,YAAY,GAAG,WAAI,CAAC,SAAS,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC;AAExD,MAAa,IAAI;IACf,YACU,SAAiB,EACjB,OAAgB,EAChB,MAAe,EACf,SAAkB;QAHlB,cAAS,GAAT,SAAS,CAAQ;QACjB,YAAO,GAAP,OAAO,CAAS;QAChB,WAAM,GAAN,MAAM,CAAS;QACf,cAAS,GAAT,SAAS,CAAS;IACzB,CAAC;IAEG,KAAK,CAAC,KAAK,CAAC,QAAmB;QACpC,0BAA0B;QAC1B,MAAM,SAAE,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAEhC,MAAM,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED,8DAA8D;IACvD,KAAK,CAAC,aAAa,CAAC,KAAa,EAAE,SAAgD;QACxF,MAAM,SAAS,GAAG,wBAAa,CAC7B,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EACrB,qBAAqB,KAAK,6DAA6D,CACxF,CAAC;QACF,IAAI,WAAW,GAAG,mBAAQ,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;QACtD,IAAI,CAAC,WAAW,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE;YACvC,wDAAwD;YACxD,WAAW,GAAG,iBAAS,CAAC,mBAAQ,CAAC,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,qJAAqJ,CACvJ,CAAC;gBACF,OAAO;aACR;SACF;QACD,MAAM,IAAI,uCAAiB,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC,KAAK,EAAE,CAAC;QAExD,MAAM,aAAa,GAAG,EAAE,CAAC;QACzB,MAAM,YAAY,GAAG,EAAE,CAAC;QACxB,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,kBAAO,CAAC,iBAAiB,CAAC,EAAE;oBAC/B,uEAAuE;oBACvE,MAAM,OAAO,GAAG,iBAAiB,CAAC;oBAClC,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,uBAAY,CAAC,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,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;oBAC5B,SAAS;iBACV;gBAED,MAAM,aAAa,GAAG,wBAAa,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;gBAEzD,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE;oBAC5B,MAAM,aAAa,GAAG,GAAG,KAAK,IAAI,QAAQ,EAAE,CAAC;oBAC7C,cAAM,CAAC,IAAI,CACT,SAAS,EACT,yBAAyB,KAAK,CAAC,IAAI,CACjC,aAAa,CACd,+GAA+G,CACjH,CAAC;oBACF,SAAS;iBACV;gBAED,MAAM,YAAY,GAAG,wBAAa,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC;gBAE5D,+BAA+B;gBAC/B,MAAM,IAAI,iCAAc,CAAC,KAAK,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC,KAAK,EAAE,CAAC;gBAEhE,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAE7B,gCAAgC;gBAChC,MAAM,SAAS,GAAa,EAAE,CAAC;gBAC/B,KAAK,MAAM,OAAO,IAAI,iBAAiB,EAAE;oBACvC,MAAM,SAAS,GAAG,uBAAY,CAAC,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,uBAAY,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;oBAC7G,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,uBAAY,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,mBAAmB,CAAC,MAAM,CAAC,CAAC;oBAE3G,SAAS,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC;iBACnF;gBACD,MAAM,IAAI,kCAAe,CAAC,KAAK,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC,KAAK,EAAE,CAAC;aAC/D;YAAC,OAAO,KAAK,EAAE;gBACd,cAAM,CAAC,IAAI,CAAC,SAAS,EAAE,0BAA0B,KAAK,IAAI,QAAQ,KAAK,KAAK,CAAC,OAAO,IAAI,CAAC,CAAC;aAC3F;SACF;QAED,oDAAoD;QACpD,cAAM,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,EAAE,aAAa,CAAC,CAAC;QAC/C,MAAM,IAAI,4BAAY,CAAC,KAAK,EAAE,aAAa,EAAE,YAAY,CAAC,CAAC,KAAK,EAAE,CAAC;QACnE,OAAO,aAAa,CAAC;IACvB,CAAC;IAED;;;;;;OAMG;IACK,uBAAuB,CAC7B,QAAmB;QAEnB,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,uBAAY,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACzD,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE;gBAC7B,SAAS,CAAC,gFAAgF;aAC3F;YAED,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,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,wBAAa,CAAC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAC;wBAC/D,MAAM,aAAa,GAAG,wBAAa,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;wBACzD,IAAI,aAAa,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;4BACxC,SAAS;yBACV;qBACF;oBAAC,OAAO,CAAC,EAAE;wBACV,qGAAqG;qBACtG;oBAED,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;oBAE5B,MAAM,iBAAiB,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;oBAC3C,IAAI,gBAAgB,GAAG,EAAE,CAAC;oBAC1B,IAAI,kBAAO,CAAC,iBAAiB,CAAC,EAAE;wBAC9B,gBAAgB,GAAG,iBAAiB,CAAC;qBACtC;oBACD,sBAAW,CAAC,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,sBAAc,CAAC,IAAI,CAAC,SAAS,EAAE,YAAY,EAAE,wBAAwB,CAAC,CAAC;QAE7E,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,iBAAM,CAAC,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,GAAY,EAAE,CAAC;QAChC,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,wBAAa,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;oBACvD,WAAW,GAAG,wBAAa,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;iBAC9C;qBAAM;oBACL,WAAW,GAAG,wBAAa,CAAC,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,iBAAS,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;qBACzF;iBACF;aACF;SACF;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;IAEO,KAAK,CAAC,eAAe,CAC3B,KAAa,EACb,QAAgB,EAChB,OAAmB,EACnB,WAAoB;QAEpB,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;AAlOD,oBAkOC"}
|
package/lib/utils.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/// <reference types="node" />
|
|
2
|
-
import { Dictionary } from '@salesforce/ts-types';
|
|
3
2
|
import { EventEmitter } from 'events';
|
|
3
|
+
import { Dictionary } from '@salesforce/ts-types';
|
|
4
4
|
export declare const events: EventEmitter;
|
|
5
5
|
export declare function copyStaticFile(outputDir: string, fileDir: string, fileName: string): Promise<void>;
|
|
6
6
|
export declare function mergeDeep(target: Dictionary, source: Dictionary): Dictionary<unknown>;
|
package/lib/utils.js
CHANGED
|
@@ -5,13 +5,15 @@
|
|
|
5
5
|
* Licensed under the BSD 3-Clause license.
|
|
6
6
|
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
7
7
|
*/
|
|
8
|
+
/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
|
|
8
9
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
|
-
|
|
10
|
-
const ts_types_1 = require("@salesforce/ts-types");
|
|
10
|
+
exports.helpFromDescription = exports.punctuate = exports.mergeDeep = exports.copyStaticFile = exports.events = void 0;
|
|
11
11
|
const events_1 = require("events");
|
|
12
12
|
const fs_1 = require("fs");
|
|
13
13
|
const os_1 = require("os");
|
|
14
14
|
const path_1 = require("path");
|
|
15
|
+
const ts_types_1 = require("@salesforce/ts-types");
|
|
16
|
+
const core_1 = require("@salesforce/core");
|
|
15
17
|
exports.events = new events_1.EventEmitter();
|
|
16
18
|
async function copyStaticFile(outputDir, fileDir, fileName) {
|
|
17
19
|
const source = path_1.join(fileDir, fileName);
|
|
@@ -21,7 +23,7 @@ async function copyStaticFile(outputDir, fileDir, fileName) {
|
|
|
21
23
|
}
|
|
22
24
|
exports.copyStaticFile = copyStaticFile;
|
|
23
25
|
function mergeDeep(target, source) {
|
|
24
|
-
Object.keys(source).forEach(key => {
|
|
26
|
+
Object.keys(source).forEach((key) => {
|
|
25
27
|
if (ts_types_1.isObject(target[key]) && ts_types_1.isObject(source[key])) {
|
|
26
28
|
mergeDeep(target[key], source[key]);
|
|
27
29
|
}
|
|
@@ -45,13 +47,7 @@ function punctuate(description) {
|
|
|
45
47
|
}
|
|
46
48
|
exports.punctuate = punctuate;
|
|
47
49
|
function helpFromDescription(description) {
|
|
48
|
-
return description
|
|
49
|
-
? description
|
|
50
|
-
.split(os_1.EOL)
|
|
51
|
-
.slice(1)
|
|
52
|
-
.join(os_1.EOL)
|
|
53
|
-
.trim()
|
|
54
|
-
: '';
|
|
50
|
+
return description ? description.split(os_1.EOL).slice(1).join(os_1.EOL).trim() : '';
|
|
55
51
|
}
|
|
56
52
|
exports.helpFromDescription = helpFromDescription;
|
|
57
53
|
//# sourceMappingURL=utils.js.map
|
package/lib/utils.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";AAAA;;;;;GAKG
|
|
1
|
+
{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;AACH,sEAAsE;;;AAEtE,mCAAsC;AACtC,2BAAkC;AAClC,2BAAyB;AACzB,+BAA4B;AAC5B,mDAA4D;AAC5D,2CAAsC;AAEzB,QAAA,MAAM,GAAG,IAAI,qBAAY,EAAE,CAAC;AAElC,KAAK,UAAU,cAAc,CAAC,SAAiB,EAAE,OAAe,EAAE,QAAgB;IACvF,MAAM,MAAM,GAAG,WAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IACvC,MAAM,IAAI,GAAG,WAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IACvC,MAAM,SAAE,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAC3B,iBAAY,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AAC7B,CAAC;AALD,wCAKC;AAED,SAAgB,SAAS,CAAC,MAAkB,EAAE,MAAkB;IAC9D,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;QAClC,IAAI,mBAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,mBAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE;YAClD,SAAS,CAAC,MAAM,CAAC,GAAG,CAAe,EAAE,MAAM,CAAC,GAAG,CAAe,CAAC,CAAC;SACjE;aAAM;YACL,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;SAC3B;IACH,CAAC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAChB,CAAC;AATD,8BASC;AAED,SAAgB,SAAS,CAAC,WAAmB;IAC3C,IAAI,CAAC,WAAW;QAAE,OAAO,WAAW,CAAC;IAErC,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC,QAAG,CAAC,CAAC;IACrC,IAAI,eAAe,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAE/B,eAAe,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAEzF,IAAI,eAAe,CAAC,MAAM,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,GAAG,EAAE;QAC9D,eAAe,IAAI,GAAG,CAAC;KACxB;IAED,OAAO,eAAe,CAAC;AACzB,CAAC;AAbD,8BAaC;AAED,SAAgB,mBAAmB,CAAC,WAAmB;IACrD,OAAO,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,QAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAG,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;AAC7E,CAAC;AAFD,kDAEC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":"1.3.19","commands":{"commandreference:generate":{"id":"commandreference:generate","description":"generate the command reference guide located","usage":"<%= command.id %> [-d <string>] [-p <array>] [--hidden] [--erroronwarnings] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-command-reference","pluginType":"core","aliases":[],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"outputdir":{"name":"outputdir","type":"option","char":"d","description":"output directory to put generated files","default":"./tmp/root"},"plugins":{"name":"plugins","type":"option","char":"p","description":"comma separated list of plugin names to be part of the generation. Defaults to the oclif plugin in the current working directory"},"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":[{"name":"file"}]}}}
|
package/package.json
CHANGED
|
@@ -1,33 +1,56 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@salesforce/plugin-command-reference",
|
|
3
3
|
"description": "Generate the Salesforce CLI command reference guide",
|
|
4
|
-
"version": "1.3.
|
|
5
|
-
"author": "
|
|
4
|
+
"version": "1.3.19",
|
|
5
|
+
"author": "Salesforce",
|
|
6
6
|
"bugs": "https://github.com/forcedotcom/plugin-command-reference/issues",
|
|
7
7
|
"dependencies": {
|
|
8
|
-
"@oclif/command": "^1.
|
|
9
|
-
"@oclif/config": "^1.
|
|
10
|
-
"@oclif/errors": "^1.
|
|
11
|
-
"@salesforce/command": "^
|
|
12
|
-
"@salesforce/core": "^2.
|
|
8
|
+
"@oclif/command": "^1.8.9",
|
|
9
|
+
"@oclif/config": "^1.18.3",
|
|
10
|
+
"@oclif/errors": "^1.3.5",
|
|
11
|
+
"@salesforce/command": "^4.2.2",
|
|
12
|
+
"@salesforce/core": "^2.36.4",
|
|
13
13
|
"chalk": "^3.0.0",
|
|
14
|
-
"handlebars": "
|
|
14
|
+
"handlebars": "4.7.7",
|
|
15
|
+
"shelljs": "^0.8.5",
|
|
15
16
|
"tslib": "^1"
|
|
16
17
|
},
|
|
17
18
|
"devDependencies": {
|
|
18
|
-
"@oclif/dev-cli": "^1.
|
|
19
|
-
"@oclif/plugin-help": "^
|
|
20
|
-
"@oclif/test": "^1.2.
|
|
21
|
-
"@salesforce/dev-
|
|
22
|
-
"@salesforce/
|
|
19
|
+
"@oclif/dev-cli": "^1.26.10",
|
|
20
|
+
"@oclif/plugin-help": "^3.3.1",
|
|
21
|
+
"@oclif/test": "^1.2.9",
|
|
22
|
+
"@salesforce/dev-config": "^2.1.3",
|
|
23
|
+
"@salesforce/dev-scripts": "^1.0.4",
|
|
24
|
+
"@salesforce/prettier-config": "^0.0.2",
|
|
23
25
|
"@semantic-release/changelog": "^5.0.0",
|
|
24
|
-
"@semantic-release/git": "^9.0.
|
|
25
|
-
"
|
|
26
|
+
"@semantic-release/git": "^9.0.1",
|
|
27
|
+
"@types/jsforce": "^1.9.42",
|
|
28
|
+
"@types/shelljs": "^0.8.11",
|
|
29
|
+
"@typescript-eslint/eslint-plugin": "^4.2.0",
|
|
30
|
+
"@typescript-eslint/parser": "^4.2.0",
|
|
31
|
+
"chai": "^4.3.6",
|
|
32
|
+
"eslint": "^7.27.0",
|
|
33
|
+
"eslint-config-prettier": "^6.11.0",
|
|
34
|
+
"eslint-config-salesforce": "^0.1.6",
|
|
35
|
+
"eslint-config-salesforce-license": "^0.1.6",
|
|
36
|
+
"eslint-config-salesforce-typescript": "^0.2.7",
|
|
37
|
+
"eslint-plugin-header": "^3.0.0",
|
|
38
|
+
"eslint-plugin-import": "2.26.0",
|
|
39
|
+
"eslint-plugin-jsdoc": "^35.1.2",
|
|
40
|
+
"eslint-plugin-prettier": "^3.1.3",
|
|
41
|
+
"husky": "^7.0.4",
|
|
42
|
+
"mocha": "^8.4.0",
|
|
43
|
+
"nyc": "^15.1.0",
|
|
44
|
+
"prettier": "^2.6.2",
|
|
45
|
+
"pretty-quick": "^3.1.3",
|
|
26
46
|
"salesforcedx": "48.4.1",
|
|
27
|
-
"semantic-release": "^17.
|
|
47
|
+
"semantic-release": "^17.4.7",
|
|
48
|
+
"sinon": "10.0.0",
|
|
49
|
+
"ts-node": "^10.7.0",
|
|
50
|
+
"typescript": "4.3"
|
|
28
51
|
},
|
|
29
52
|
"engines": {
|
|
30
|
-
"node": ">=
|
|
53
|
+
"node": ">=12.0.0"
|
|
31
54
|
},
|
|
32
55
|
"files": [
|
|
33
56
|
"/lib",
|
|
@@ -57,27 +80,21 @@
|
|
|
57
80
|
},
|
|
58
81
|
"repository": "forcedotcom/plugin-command-reference",
|
|
59
82
|
"scripts": {
|
|
60
|
-
"build": "
|
|
61
|
-
"clean": "
|
|
62
|
-
"clean-all": "
|
|
63
|
-
"compile": "
|
|
64
|
-
"docs": "
|
|
65
|
-
"format": "
|
|
66
|
-
"lint": "
|
|
67
|
-
"postpack": "rm -f oclif.manifest.json",
|
|
68
|
-
"
|
|
69
|
-
"
|
|
70
|
-
"
|
|
71
|
-
"
|
|
83
|
+
"build": "sf-build",
|
|
84
|
+
"clean": "sf-clean",
|
|
85
|
+
"clean-all": "sf-clean all",
|
|
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",
|
|
95
|
+
"test": "sf-test",
|
|
72
96
|
"version": "oclif-dev readme && git add README.md"
|
|
73
97
|
},
|
|
74
|
-
"husky": {
|
|
75
|
-
"hooks": {
|
|
76
|
-
"commit-msg": "yarn sfdx-husky-commit-msg",
|
|
77
|
-
"pre-commit": "yarn sfdx-husky-pre-commit",
|
|
78
|
-
"pre-push": "yarn sfdx-husky-pre-push"
|
|
79
|
-
}
|
|
80
|
-
},
|
|
81
98
|
"publishConfig": {
|
|
82
99
|
"access": "public"
|
|
83
100
|
}
|
package/templates/command.hbs
CHANGED
|
@@ -65,7 +65,7 @@ IF YOU WANT TO CHANGE THIS CONTENT, CONTACT juliet.shackell@salesforce.com FOR D
|
|
|
65
65
|
<section>
|
|
66
66
|
<title><ph>Help for <codeph otherprops="nolang">{{id}}</codeph></ph></title>
|
|
67
67
|
{{#each help}}
|
|
68
|
-
{{#isCodeBlock this}}<codeblock otherprops="nolang">{{this}}</codeblock>{{else}}<p>{{this}}</p>{{/isCodeBlock}}
|
|
68
|
+
{{#isCodeBlock this}}<codeblock otherprops="nolang">{{removePrompt this}}</codeblock>{{else}}<p>{{this}}</p>{{/isCodeBlock}}
|
|
69
69
|
{{/each}}
|
|
70
70
|
</section>
|
|
71
71
|
{{/if}}
|
|
@@ -73,7 +73,7 @@ IF YOU WANT TO CHANGE THIS CONTENT, CONTACT juliet.shackell@salesforce.com FOR D
|
|
|
73
73
|
<section>
|
|
74
74
|
<title><ph>Examples for <codeph otherprops="nolang">{{id}}</codeph></ph></title>
|
|
75
75
|
{{#each examples}}
|
|
76
|
-
{{#isCodeBlock this}}<codeblock otherprops="nolang">{{this}}</codeblock>{{else}}<p>{{this}}</p>{{/isCodeBlock}}
|
|
76
|
+
{{#isCodeBlock this}}<codeblock otherprops="nolang">{{removePrompt this}}</codeblock>{{else}}<p>{{this}}</p>{{/isCodeBlock}}
|
|
77
77
|
{{/each}}
|
|
78
78
|
</section>
|
|
79
79
|
{{/if}}
|