@salesforce/plugin-command-reference 2.4.4 → 2.4.5
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/lib/ditamap/command.js +17 -2
- package/lib/ditamap/command.js.map +1 -1
- package/oclif.manifest.json +1 -1
- package/package.json +2 -1
package/lib/ditamap/command.js
CHANGED
|
@@ -9,6 +9,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
9
9
|
exports.Command = void 0;
|
|
10
10
|
const path_1 = require("path");
|
|
11
11
|
const ts_types_1 = require("@salesforce/ts-types");
|
|
12
|
+
const ejs = require("ejs");
|
|
12
13
|
const utils_1 = require("../utils");
|
|
13
14
|
const ditamap_1 = require("./ditamap");
|
|
14
15
|
const getDefault = async (flag) => {
|
|
@@ -33,9 +34,23 @@ class Command extends ditamap_1.Ditamap {
|
|
|
33
34
|
const commandWithUnderscores = (0, ts_types_1.ensureString)(command.id).replace(/:/g, '_');
|
|
34
35
|
const filename = ditamap_1.Ditamap.file(`cli_reference_${commandWithUnderscores}`, 'xml');
|
|
35
36
|
super(filename, {});
|
|
37
|
+
for (const flag of Object.keys(command.flags)) {
|
|
38
|
+
if (command.flags[flag].summary) {
|
|
39
|
+
command.flags[flag].summary = ejs.render(command.flags[flag].summary, {
|
|
40
|
+
command,
|
|
41
|
+
config: { bin: commandMeta.binary },
|
|
42
|
+
});
|
|
43
|
+
}
|
|
44
|
+
if (command.flags[flag].description) {
|
|
45
|
+
command.flags[flag].description = ejs.render(command.flags[flag].description, {
|
|
46
|
+
command,
|
|
47
|
+
config: { bin: commandMeta.binary },
|
|
48
|
+
});
|
|
49
|
+
}
|
|
50
|
+
}
|
|
36
51
|
this.flags = (0, ts_types_1.ensureObject)(command.flags);
|
|
37
|
-
const summary = (0, utils_1.punctuate)((0, ts_types_1.asString)(command.summary));
|
|
38
|
-
const description = (0, ts_types_1.asString)(command.description);
|
|
52
|
+
const summary = (0, utils_1.punctuate)((0, ts_types_1.asString)(ejs.render(command.summary || '', { command, config: { bin: commandMeta.binary } })));
|
|
53
|
+
const description = (0, ts_types_1.asString)(ejs.render(command.description || '', { command, config: { bin: commandMeta.binary } }));
|
|
39
54
|
// Help are all the lines after the first line in the description. Before oclif, there was a 'help' property so continue to
|
|
40
55
|
// support that.
|
|
41
56
|
const help = this.formatParagraphs(description);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"command.js","sourceRoot":"","sources":["../../src/ditamap/command.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,+BAA4B;AAC5B,mDAQ8B;AAC9B,oCAAmD;AACnD,uCAAoC;AAapC,MAAM,UAAU,GAAG,KAAK,EAAE,IAAqB,EAAmB,EAAE;IAClE,IAAI,OAAO,IAAI,CAAC,OAAO,KAAK,UAAU,EAAE;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC;KACrB;SAAM,IAAI,OAAO,IAAI,CAAC,OAAO,KAAK,UAAU,EAAE;QAC7C,IAAI;YACF,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;YAClC,OAAO,IAAI,IAAI,EAAE,CAAC;SACnB;QAAC,MAAM;YACN,OAAO,EAAE,CAAC;SACX;KACF;SAAM;QACL,OAAO,EAAE,CAAC;KACX;AACH,CAAC,CAAC;AAEF,MAAa,OAAQ,SAAQ,iBAAO;IAGlC,YAAmB,KAAa,EAAE,QAAgB,EAAE,OAAqB,EAAE,cAAuB,EAAE;QAClG,MAAM,sBAAsB,GAAG,IAAA,uBAAY,EAAC,OAAO,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAC3E,MAAM,QAAQ,GAAG,iBAAO,CAAC,IAAI,CAAC,iBAAiB,sBAAsB,EAAE,EAAE,KAAK,CAAC,CAAC;QAEhF,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QAEpB,IAAI,CAAC,KAAK,GAAG,IAAA,uBAAY,EAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAEzC,MAAM,OAAO,GAAG,IAAA,iBAAS,
|
|
1
|
+
{"version":3,"file":"command.js","sourceRoot":"","sources":["../../src/ditamap/command.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,+BAA4B;AAC5B,mDAQ8B;AAC9B,2BAA2B;AAC3B,oCAAmD;AACnD,uCAAoC;AAapC,MAAM,UAAU,GAAG,KAAK,EAAE,IAAqB,EAAmB,EAAE;IAClE,IAAI,OAAO,IAAI,CAAC,OAAO,KAAK,UAAU,EAAE;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC;KACrB;SAAM,IAAI,OAAO,IAAI,CAAC,OAAO,KAAK,UAAU,EAAE;QAC7C,IAAI;YACF,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;YAClC,OAAO,IAAI,IAAI,EAAE,CAAC;SACnB;QAAC,MAAM;YACN,OAAO,EAAE,CAAC;SACX;KACF;SAAM;QACL,OAAO,EAAE,CAAC;KACX;AACH,CAAC,CAAC;AAEF,MAAa,OAAQ,SAAQ,iBAAO;IAGlC,YAAmB,KAAa,EAAE,QAAgB,EAAE,OAAqB,EAAE,cAAuB,EAAE;QAClG,MAAM,sBAAsB,GAAG,IAAA,uBAAY,EAAC,OAAO,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAC3E,MAAM,QAAQ,GAAG,iBAAO,CAAC,IAAI,CAAC,iBAAiB,sBAAsB,EAAE,EAAE,KAAK,CAAC,CAAC;QAEhF,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QAEpB,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YAC7C,IAAI,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE;gBAC/B,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,GAAG,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE;oBACpE,OAAO;oBACP,MAAM,EAAE,EAAE,GAAG,EAAE,WAAW,CAAC,MAAM,EAAE;iBACpC,CAAC,CAAC;aACJ;YACD,IAAI,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE;gBACnC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,WAAW,GAAG,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE;oBAC5E,OAAO;oBACP,MAAM,EAAE,EAAE,GAAG,EAAE,WAAW,CAAC,MAAM,EAAE;iBACpC,CAAC,CAAC;aACJ;SACF;QAED,IAAI,CAAC,KAAK,GAAG,IAAA,uBAAY,EAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAEzC,MAAM,OAAO,GAAG,IAAA,iBAAS,EACvB,IAAA,mBAAQ,EAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,WAAW,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAC9F,CAAC;QAEF,MAAM,WAAW,GAAG,IAAA,mBAAQ,EAC1B,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,WAAW,IAAI,EAAE,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,WAAW,CAAC,MAAM,EAAE,EAAE,CAAC,CACxF,CAAC;QAEF,2HAA2H;QAC3H,gBAAgB;QAEhB,MAAM,IAAI,GAAG,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;QAEhD,IAAI,uBAAgC,CAAC;QACrC,IAAI,wBAAiC,CAAC;QAEtC,IAAI,WAAW,CAAC,wBAAwB,EAAE;YACxC,MAAM,SAAS,GAAG,IAAA,wBAAa,EAAC,WAAW,CAAC,wBAAwB,CAAC,CAAC;YACtE,uBAAuB,GAAG,SAAS,CAAC,GAAG,CAAC;YACxC,wBAAwB,GAAG,SAAS,CAAC,IAAI,CAAC;SAC3C;QAED,MAAM,WAAW,GAAG,IAAA,mBAAQ,EAAC,OAAO,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,IAAA,mBAAQ,EAAC,WAAW,CAAC,cAAc,CAAC,CAAC,CAAC;QAE7F,MAAM,QAAQ,GAAG,CAAE,OAAO,CAAC,QAAqB,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;YACtE,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAClC,MAAM,IAAI,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YAChD,MAAM,QAAQ,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YAEhE,OAAO;gBACL,WAAW,EAAE,IAAI;gBACjB,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;oBAC3B,OAAO,CAAC;yBACL,OAAO,CAAC,oBAAoB,EAAE,IAAA,mBAAQ,EAAC,WAAW,CAAC,MAAM,CAAC,CAAC;yBAC3D,OAAO,CAAC,oBAAoB,EAAE,WAAW,CAAC,CAAC;gBAChD,CAAC,CAAC;aACH,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,WAAW,CAAC,KAAK,CAAC;QACjD,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE;YACjC,IAAI,EAAE,WAAW;YACjB,MAAM,EAAE,WAAW,CAAC,MAAM;YAC1B,cAAc,EAAE,WAAW,CAAC,cAAc;YAC1C,sBAAsB;YACtB,QAAQ;YACR,OAAO;YACP,WAAW;YACX,IAAI;YACJ,oBAAoB,EAAE,KAAK,KAAK,aAAa;YAC7C,kBAAkB,EAAE,KAAK,KAAK,WAAW;YACzC,aAAa,EAAE,KAAK,KAAK,MAAM;YAC/B,uBAAuB;YACvB,wBAAwB;SACzB,CAAC,CAAC;QAEH,IAAI,CAAC,WAAW,GAAG,IAAA,WAAI,EAAC,iBAAO,CAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC9D,CAAC;IAEM,KAAK,CAAC,wBAAwB,CAAC,KAAkC;QACtE,MAAM,KAAK,GAAG,EAAuB,CAAC;QAEtC,KAAK,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YACpD,IAAI,IAAI,CAAC,MAAM;gBAAE,SAAS;YAC1B,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,IAAI,EAAE,CAAC;YAC3G,MAAM,iBAAiB,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,OAAO,KAAK,WAAW,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC;YACzF,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,EAAE;gBACtC,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,CAAC;gBACrD,QAAQ,EAAE,CAAC,IAAI,CAAC,QAAQ;gBACxB,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI;gBAC5B,QAAQ,EAAE,IAAI,CAAC,IAAI,KAAK,SAAS;gBACjC,gBAAgB,EAAE,MAAM,UAAU,CAAC,IAAI,CAAC;aACzC,CAAC,CAAC;YACH,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SACrB;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAEM,mBAAmB;QACxB,OAAO,aAAa,CAAC;IACvB,CAAC;IAES,KAAK,CAAC,kBAAkB;QAChC,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACnE,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,IAAI,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC;QACzD,OAAO,KAAK,CAAC,kBAAkB,EAAE,CAAC;IACpC,CAAC;CACF;AAlHD,0BAkHC"}
|
package/oclif.manifest.json
CHANGED
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@salesforce/plugin-command-reference",
|
|
3
3
|
"description": "Generate the Salesforce CLI command reference guide",
|
|
4
|
-
"version": "2.4.
|
|
4
|
+
"version": "2.4.5",
|
|
5
5
|
"author": "Salesforce",
|
|
6
6
|
"bugs": "https://github.com/salesforcecli/plugin-command-reference/issues",
|
|
7
7
|
"dependencies": {
|
|
@@ -23,6 +23,7 @@
|
|
|
23
23
|
"@salesforce/dev-scripts": "^2.0.4",
|
|
24
24
|
"@salesforce/plugin-login": "^1.1.15",
|
|
25
25
|
"@salesforce/prettier-config": "^0.0.2",
|
|
26
|
+
"@types/ejs": "^3.1.2",
|
|
26
27
|
"@types/fs-extra": "^9.0.13",
|
|
27
28
|
"@types/lodash.uniqby": "^4.7.6",
|
|
28
29
|
"@typescript-eslint/eslint-plugin": "^4.2.0",
|