@salesforce/plugin-command-reference 1.3.18 → 1.4.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 +14 -1
- package/LICENSE.txt +1 -1
- package/README.md +1 -1
- package/lib/commands/commandreference/generate.js +6 -3
- package/lib/commands/commandreference/generate.js.map +1 -1
- package/lib/ditamap/command.js +8 -1
- package/lib/ditamap/command.js.map +1 -1
- package/lib/ditamap/ditamap.js +10 -6
- package/lib/ditamap/ditamap.js.map +1 -1
- package/lib/docs.js +2 -2
- package/lib/docs.js.map +1 -1
- package/lib/utils.js +3 -4
- package/lib/utils.js.map +1 -1
- package/oclif.manifest.json +1 -1
- package/package.json +24 -26
- package/templates/command.hbs +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -2,7 +2,20 @@
|
|
|
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
|
+
## [1.4.0](https://github.com/forcedotcom/plugin-command-reference/compare/v1.3.20...v1.4.0) (2022-06-29)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
- parking orbit ([be2adf1](https://github.com/forcedotcom/plugin-command-reference/commit/be2adf1a49364feead6290fa384184fdf7793f13))
|
|
10
|
+
|
|
11
|
+
### [1.3.20](https://github.com/forcedotcom/plugin-command-reference/compare/v1.3.19...v1.3.20) (2022-05-24)
|
|
12
|
+
|
|
13
|
+
### [1.3.19](https://github.com/forcedotcom/plugin-command-reference/compare/v1.3.17...v1.3.19) (2022-05-17)
|
|
14
|
+
|
|
15
|
+
### Bug Fixes
|
|
16
|
+
|
|
17
|
+
- add dependabot and versioning strategy ([6a13574](https://github.com/forcedotcom/plugin-command-reference/commit/6a13574724f9e317a0624bc0bb92e9f1dc7a689c))
|
|
18
|
+
- remove '$' in codeblocks ([79e2b7b](https://github.com/forcedotcom/plugin-command-reference/commit/79e2b7b8bb5eacfad43319e1ca7ed42d2705f419))
|
|
6
19
|
|
|
7
20
|
### [1.3.17](https://github.com/forcedotcom/plugin-command-reference/compare/v1.3.16...v1.3.17) (2021-11-19)
|
|
8
21
|
|
package/LICENSE.txt
CHANGED
package/README.md
CHANGED
|
@@ -97,6 +97,6 @@ OPTIONS
|
|
|
97
97
|
this command invocation
|
|
98
98
|
```
|
|
99
99
|
|
|
100
|
-
_See code: [src/commands/commandreference/generate.ts](https://github.com/forcedotcom/plugin-command-reference/blob/v1.3.
|
|
100
|
+
_See code: [src/commands/commandreference/generate.ts](https://github.com/forcedotcom/plugin-command-reference/blob/v1.3.20/src/commands/commandreference/generate.ts)_
|
|
101
101
|
|
|
102
102
|
<!-- commandsstop -->
|
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
*/
|
|
8
8
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
9
|
const os = require("os");
|
|
10
|
+
const fs = require("fs");
|
|
10
11
|
const path = require("path");
|
|
11
12
|
const command_1 = require("@salesforce/command");
|
|
12
13
|
const core_1 = require("@salesforce/core");
|
|
@@ -25,8 +26,8 @@ class CommandReferenceGenerate extends command_1.SfdxCommand {
|
|
|
25
26
|
let pluginNames;
|
|
26
27
|
if (!this.flags.plugins) {
|
|
27
28
|
const pJsonPath = path.join(process.cwd(), 'package.json');
|
|
28
|
-
if (
|
|
29
|
-
const packageJson = await
|
|
29
|
+
if (fs.existsSync(pJsonPath)) {
|
|
30
|
+
const packageJson = JSON.parse(await fs.promises.readFile(pJsonPath, 'utf8'));
|
|
30
31
|
pluginNames = [ts_types_1.getString(packageJson, 'name')];
|
|
31
32
|
}
|
|
32
33
|
else {
|
|
@@ -50,7 +51,9 @@ class CommandReferenceGenerate extends command_1.SfdxCommand {
|
|
|
50
51
|
}
|
|
51
52
|
return pluginName;
|
|
52
53
|
});
|
|
53
|
-
this.ux.log(`Generating command reference for the following plugins:${plugins
|
|
54
|
+
this.ux.log(`Generating command reference for the following plugins:${plugins
|
|
55
|
+
.map((name) => `${os.EOL} - ${name}`)
|
|
56
|
+
.join(', ')}`);
|
|
54
57
|
ditamap_1.Ditamap.outputDir = this.flags.outputdir;
|
|
55
58
|
ditamap_1.Ditamap.cliVersion = this.config.version.replace(/-[0-9a-zA-Z]+$/, '');
|
|
56
59
|
ditamap_1.Ditamap.plugins = this.pluginMap(plugins);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../../src/commands/commandreference/generate.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAEH,yBAAyB;AACzB,6BAA6B;AAE7B,iDAAyD;AACzD,
|
|
1
|
+
{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../../src/commands/commandreference/generate.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAEH,yBAAyB;AACzB,yBAAyB;AACzB,6BAA6B;AAE7B,iDAAyD;AACzD,2CAAuD;AACvD,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,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;gBAC5B,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;gBAC9E,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,OAAmB,CAAC;SAC9C;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;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,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,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,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;;AA7JH,2CA8JC;AA7Je,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"}
|
package/lib/ditamap/command.js
CHANGED
|
@@ -42,10 +42,17 @@ class Command extends ditamap_1.Ditamap {
|
|
|
42
42
|
delete command.examples;
|
|
43
43
|
}
|
|
44
44
|
}
|
|
45
|
+
let examples;
|
|
46
|
+
const binary = 'sfdx';
|
|
47
|
+
if (command.examples) {
|
|
48
|
+
examples = Array.isArray(command.examples) ? command.examples : [command.examples];
|
|
49
|
+
examples = examples.map((example) => example.replace(/<%= config.bin %>/g, binary).replace(/<%= command.id %>/g, command.id));
|
|
50
|
+
}
|
|
45
51
|
const state = command.state || commandMeta.state;
|
|
46
52
|
this.data = Object.assign(command, {
|
|
47
|
-
binary
|
|
53
|
+
binary,
|
|
48
54
|
commandWithUnderscores,
|
|
55
|
+
examples,
|
|
49
56
|
help,
|
|
50
57
|
description,
|
|
51
58
|
parameters,
|
|
@@ -1 +1 @@
|
|
|
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
|
|
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,IAAI,QAAQ,CAAC;QACb,MAAM,MAAM,GAAG,MAAM,CAAC;QAEtB,IAAI,OAAO,CAAC,QAAQ,EAAE;YACpB,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YAEnF,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAClC,OAAO,CAAC,OAAO,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,oBAAoB,EAAE,OAAO,CAAC,EAAE,CAAC,CACxF,CAAC;SACH;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;YACN,sBAAsB;YACtB,QAAQ;YACR,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;AAhGD,0BAgGC"}
|
package/lib/ditamap/ditamap.js
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.Ditamap = void 0;
|
|
2
4
|
/*
|
|
3
5
|
* Copyright (c) 2018, salesforce.com, inc.
|
|
4
6
|
* All rights reserved.
|
|
5
7
|
* Licensed under the BSD 3-Clause license.
|
|
6
8
|
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
7
9
|
*/
|
|
8
|
-
|
|
9
|
-
exports.Ditamap = void 0;
|
|
10
|
+
const fs = require("fs");
|
|
10
11
|
const path_1 = require("path");
|
|
11
|
-
const core_1 = require("@salesforce/core");
|
|
12
12
|
const debugCreator = require("debug");
|
|
13
13
|
const handlebars_1 = require("handlebars");
|
|
14
14
|
const debug = debugCreator('commandreference');
|
|
@@ -25,6 +25,10 @@ class Ditamap {
|
|
|
25
25
|
handlebars_1.registerHelper('isCodeBlock', function (val, options) {
|
|
26
26
|
return val.indexOf('$ sfdx') >= 0 || val.indexOf('>>') >= 0 ? options.fn(this) : options.inverse(this);
|
|
27
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));
|
|
28
32
|
handlebars_1.registerHelper('nextVersion', (value) => parseInt(value, 2) + 1);
|
|
29
33
|
this.source = path_1.join(Ditamap.templatesDir, this.getTemplateFileName());
|
|
30
34
|
this.destination = path_1.join(Ditamap.outputDir, filename);
|
|
@@ -36,9 +40,9 @@ class Ditamap {
|
|
|
36
40
|
return this.destination;
|
|
37
41
|
}
|
|
38
42
|
async write() {
|
|
39
|
-
await
|
|
43
|
+
await fs.promises.mkdir(path_1.dirname(this.destination), { recursive: true });
|
|
40
44
|
const output = await this.transformToDitamap();
|
|
41
|
-
await
|
|
45
|
+
await fs.promises.writeFile(this.destination, output);
|
|
42
46
|
}
|
|
43
47
|
formatParagraphs(textToFormat) {
|
|
44
48
|
return textToFormat ? textToFormat.split('\n').filter((n) => n !== '') : [];
|
|
@@ -52,7 +56,7 @@ class Ditamap {
|
|
|
52
56
|
*/
|
|
53
57
|
async transformToDitamap() {
|
|
54
58
|
debug(`Generating ${this.destination} from ${this.getTemplateFileName()}`);
|
|
55
|
-
const src = await
|
|
59
|
+
const src = await fs.promises.readFile(this.source, 'utf8');
|
|
56
60
|
const template = handlebars_1.compile(src);
|
|
57
61
|
return template(this.data);
|
|
58
62
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ditamap.js","sourceRoot":"","sources":["../../src/ditamap/ditamap.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"ditamap.js","sourceRoot":"","sources":["../../src/ditamap/ditamap.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACH,yBAAyB;AACzB,+BAAqC;AAErC,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,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAO,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACxE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAE/C,MAAM,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IACxD,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,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAC5D,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"}
|
package/lib/docs.js
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
9
|
exports.Docs = void 0;
|
|
10
10
|
const path_1 = require("path");
|
|
11
|
-
const
|
|
11
|
+
const fs = require("fs");
|
|
12
12
|
const ts_types_1 = require("@salesforce/ts-types");
|
|
13
13
|
const chalk = require("chalk");
|
|
14
14
|
const base_ditamap_1 = require("./ditamap/base-ditamap");
|
|
@@ -29,7 +29,7 @@ class Docs {
|
|
|
29
29
|
}
|
|
30
30
|
async build(commands) {
|
|
31
31
|
// Create if doesn't exist
|
|
32
|
-
await
|
|
32
|
+
await fs.promises.mkdir(this.outputDir, { recursive: true });
|
|
33
33
|
await this.populateTemplate(commands);
|
|
34
34
|
}
|
|
35
35
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
package/lib/docs.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"docs.js","sourceRoot":"","sources":["../src/docs.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,+BAA4B;
|
|
1
|
+
{"version":3,"file":"docs.js","sourceRoot":"","sources":["../src/docs.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,+BAA4B;AAC5B,yBAAyB;AAEzB,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,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAE7D,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.js
CHANGED
|
@@ -9,17 +9,16 @@
|
|
|
9
9
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
10
10
|
exports.helpFromDescription = exports.punctuate = exports.mergeDeep = exports.copyStaticFile = exports.events = void 0;
|
|
11
11
|
const events_1 = require("events");
|
|
12
|
-
const
|
|
12
|
+
const fs = require("fs");
|
|
13
13
|
const os_1 = require("os");
|
|
14
14
|
const path_1 = require("path");
|
|
15
15
|
const ts_types_1 = require("@salesforce/ts-types");
|
|
16
|
-
const core_1 = require("@salesforce/core");
|
|
17
16
|
exports.events = new events_1.EventEmitter();
|
|
18
17
|
async function copyStaticFile(outputDir, fileDir, fileName) {
|
|
19
18
|
const source = path_1.join(fileDir, fileName);
|
|
20
19
|
const dest = path_1.join(outputDir, fileName);
|
|
21
|
-
await
|
|
22
|
-
|
|
20
|
+
await fs.promises.mkdir(outputDir, { recursive: true });
|
|
21
|
+
await fs.promises.copyFile(source, dest);
|
|
23
22
|
}
|
|
24
23
|
exports.copyStaticFile = copyStaticFile;
|
|
25
24
|
function mergeDeep(target, source) {
|
package/lib/utils.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;AACH,sEAAsE;;;AAEtE,mCAAsC;AACtC,
|
|
1
|
+
{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;AACH,sEAAsE;;;AAEtE,mCAAsC;AACtC,yBAAyB;AACzB,2BAAyB;AACzB,+BAA4B;AAC5B,mDAA4D;AAE/C,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,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACxD,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AAC3C,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"}
|
package/oclif.manifest.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":"1.
|
|
1
|
+
{"version":"1.4.0","commands":{"commandreference:generate":{"id":"commandreference:generate","description":"generate the command reference guide located","strict":true,"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","pluginAlias":"@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)","multiple":false,"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","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":false},"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"}],"flagsConfig":{"outputdir":{"kind":"string","char":"d","description":"output directory to put generated files","default":"./tmp/root","input":[],"multiple":false,"type":"option"},"plugins":{"kind":"array","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","input":[],"multiple":false,"type":"option"},"hidden":{"kind":"boolean","description":"show hidden commands","allowNo":false,"type":"boolean"},"erroronwarnings":{"kind":"boolean","description":"fail the command if there are any warnings","allowNo":false,"type":"boolean"}}}}}
|
package/package.json
CHANGED
|
@@ -1,56 +1,52 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@salesforce/plugin-command-reference",
|
|
3
3
|
"description": "Generate the Salesforce CLI command reference guide",
|
|
4
|
-
"version": "1.
|
|
5
|
-
"author": "
|
|
4
|
+
"version": "1.4.0",
|
|
5
|
+
"author": "Salesforce",
|
|
6
6
|
"bugs": "https://github.com/forcedotcom/plugin-command-reference/issues",
|
|
7
7
|
"dependencies": {
|
|
8
|
-
"@
|
|
9
|
-
"@
|
|
10
|
-
"@oclif/errors": "^1.3.5",
|
|
11
|
-
"@salesforce/command": "^4.1.5",
|
|
12
|
-
"@salesforce/core": "^2.29.0",
|
|
8
|
+
"@salesforce/command": "^5.1.3",
|
|
9
|
+
"@salesforce/core": "^3.19.5",
|
|
13
10
|
"chalk": "^3.0.0",
|
|
14
11
|
"handlebars": "4.7.7",
|
|
15
|
-
"shelljs": "^0.8.
|
|
12
|
+
"shelljs": "^0.8.5",
|
|
16
13
|
"tslib": "^1"
|
|
17
14
|
},
|
|
18
15
|
"devDependencies": {
|
|
19
|
-
"@
|
|
20
|
-
"@
|
|
21
|
-
"@
|
|
22
|
-
"@salesforce/
|
|
23
|
-
"@salesforce/dev-scripts": "^1.0.2",
|
|
16
|
+
"@salesforce/dev-config": "^3.0.1",
|
|
17
|
+
"@salesforce/dev-scripts": "^2.0.2",
|
|
18
|
+
"@salesforce/plugin-alias": "^2.0.1",
|
|
19
|
+
"@salesforce/plugin-signups": "^1.1.2",
|
|
24
20
|
"@salesforce/prettier-config": "^0.0.2",
|
|
25
21
|
"@semantic-release/changelog": "^5.0.0",
|
|
26
|
-
"@semantic-release/git": "^9.0.
|
|
27
|
-
"@types/
|
|
28
|
-
"@types/shelljs": "^0.8.9",
|
|
22
|
+
"@semantic-release/git": "^9.0.1",
|
|
23
|
+
"@types/shelljs": "^0.8.11",
|
|
29
24
|
"@typescript-eslint/eslint-plugin": "^4.2.0",
|
|
30
25
|
"@typescript-eslint/parser": "^4.2.0",
|
|
31
|
-
"chai": "^4.
|
|
26
|
+
"chai": "^4.3.6",
|
|
32
27
|
"eslint": "^7.27.0",
|
|
33
28
|
"eslint-config-prettier": "^6.11.0",
|
|
34
29
|
"eslint-config-salesforce": "^0.1.6",
|
|
35
30
|
"eslint-config-salesforce-license": "^0.1.6",
|
|
36
31
|
"eslint-config-salesforce-typescript": "^0.2.7",
|
|
37
32
|
"eslint-plugin-header": "^3.0.0",
|
|
38
|
-
"eslint-plugin-import": "2.
|
|
33
|
+
"eslint-plugin-import": "2.26.0",
|
|
39
34
|
"eslint-plugin-jsdoc": "^35.1.2",
|
|
40
35
|
"eslint-plugin-prettier": "^3.1.3",
|
|
41
36
|
"husky": "^7.0.4",
|
|
42
|
-
"mocha": "^
|
|
37
|
+
"mocha": "^9.1.3",
|
|
43
38
|
"nyc": "^15.1.0",
|
|
44
|
-
"
|
|
45
|
-
"
|
|
46
|
-
"
|
|
47
|
-
"
|
|
39
|
+
"oclif": "^3.0.1",
|
|
40
|
+
"prettier": "^2.6.2",
|
|
41
|
+
"pretty-quick": "^3.1.3",
|
|
42
|
+
"salesforce-alm": "^54.4.0",
|
|
43
|
+
"semantic-release": "^17.4.7",
|
|
48
44
|
"sinon": "10.0.0",
|
|
49
|
-
"ts-node": "^10.
|
|
45
|
+
"ts-node": "^10.8.0",
|
|
50
46
|
"typescript": "4.3"
|
|
51
47
|
},
|
|
52
48
|
"engines": {
|
|
53
|
-
"node": ">=
|
|
49
|
+
"node": ">=14.0.0"
|
|
54
50
|
},
|
|
55
51
|
"files": [
|
|
56
52
|
"/lib",
|
|
@@ -75,7 +71,9 @@
|
|
|
75
71
|
},
|
|
76
72
|
"devPlugins": [
|
|
77
73
|
"@oclif/plugin-help",
|
|
78
|
-
"
|
|
74
|
+
"salesforce-alm",
|
|
75
|
+
"@salesforce/plugin-alias",
|
|
76
|
+
"@salesforce/plugin-signups"
|
|
79
77
|
]
|
|
80
78
|
},
|
|
81
79
|
"repository": "forcedotcom/plugin-command-reference",
|
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}}
|