@salesforce/plugin-command-reference 2.2.5 → 2.2.6
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 +6 -0
- package/lib/ditamap/command.d.ts +5 -7
- package/lib/ditamap/command.js +35 -9
- package/lib/ditamap/command.js.map +1 -1
- package/lib/ditamap/ditamap.d.ts +1 -1
- package/lib/ditamap/ditamap.js +2 -37
- package/lib/ditamap/ditamap.js.map +1 -1
- package/oclif.manifest.json +1 -1
- package/package.json +3 -4
- package/templates/command.hbs +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,12 @@
|
|
|
2
2
|
|
|
3
3
|
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
|
|
4
4
|
|
|
5
|
+
### [2.2.6](https://github.com/salesforcecli/plugin-command-reference/compare/v2.2.5...v2.2.6) (2022-03-30)
|
|
6
|
+
|
|
7
|
+
### Bug Fixes
|
|
8
|
+
|
|
9
|
+
- remove async handlebars ([2c91d7a](https://github.com/salesforcecli/plugin-command-reference/commit/2c91d7a6b42e1698876209e776d925898fe87007))
|
|
10
|
+
|
|
5
11
|
### [2.2.5](https://github.com/salesforcecli/plugin-command-reference/compare/v2.2.4...v2.2.5) (2022-03-29)
|
|
6
12
|
|
|
7
13
|
### Bug Fixes
|
package/lib/ditamap/command.d.ts
CHANGED
|
@@ -7,15 +7,13 @@ export declare type CommandHelpInfo = {
|
|
|
7
7
|
required: boolean;
|
|
8
8
|
kind: string;
|
|
9
9
|
type: string;
|
|
10
|
+
defaultHelpValue?: string;
|
|
11
|
+
default: string | (() => Promise<string>);
|
|
10
12
|
};
|
|
11
13
|
export declare class Command extends Ditamap {
|
|
14
|
+
private flags;
|
|
12
15
|
constructor(topic: string, subtopic: string, command: Dictionary, commandMeta?: JsonMap);
|
|
13
|
-
getParametersForTemplate(flags: Dictionary<CommandHelpInfo>):
|
|
14
|
-
name: string;
|
|
15
|
-
description: string[];
|
|
16
|
-
optional: boolean;
|
|
17
|
-
kind: string;
|
|
18
|
-
hasValue: boolean;
|
|
19
|
-
})[];
|
|
16
|
+
getParametersForTemplate(flags: Dictionary<CommandHelpInfo>): Promise<CommandHelpInfo[]>;
|
|
20
17
|
getTemplateFileName(): string;
|
|
18
|
+
protected transformToDitamap(): Promise<string>;
|
|
21
19
|
}
|
package/lib/ditamap/command.js
CHANGED
|
@@ -11,13 +11,29 @@ const path_1 = require("path");
|
|
|
11
11
|
const ts_types_1 = require("@salesforce/ts-types");
|
|
12
12
|
const utils_1 = require("../utils");
|
|
13
13
|
const ditamap_1 = require("./ditamap");
|
|
14
|
+
const getDefault = async (flag) => {
|
|
15
|
+
if (typeof flag.default !== 'function') {
|
|
16
|
+
return flag.default;
|
|
17
|
+
}
|
|
18
|
+
else if (typeof flag.default === 'function') {
|
|
19
|
+
try {
|
|
20
|
+
const help = await flag.default();
|
|
21
|
+
return help || '';
|
|
22
|
+
}
|
|
23
|
+
catch {
|
|
24
|
+
return '';
|
|
25
|
+
}
|
|
26
|
+
}
|
|
27
|
+
else {
|
|
28
|
+
return '';
|
|
29
|
+
}
|
|
30
|
+
};
|
|
14
31
|
class Command extends ditamap_1.Ditamap {
|
|
15
32
|
constructor(topic, subtopic, command, commandMeta = {}) {
|
|
16
33
|
const commandWithUnderscores = (0, ts_types_1.ensureString)(command.id).replace(/:/g, '_');
|
|
17
34
|
const filename = ditamap_1.Ditamap.file(`cli_reference_${commandWithUnderscores}`, 'xml');
|
|
18
35
|
super(filename, {});
|
|
19
|
-
|
|
20
|
-
const parameters = this.getParametersForTemplate(flags);
|
|
36
|
+
this.flags = (0, ts_types_1.ensureObject)(command.flags);
|
|
21
37
|
const summary = (0, utils_1.punctuate)((0, ts_types_1.asString)(command.summary));
|
|
22
38
|
const description = (0, ts_types_1.asString)(command.description);
|
|
23
39
|
// Help are all the lines after the first line in the description. Before oclif, there was a 'help' property so continue to
|
|
@@ -57,7 +73,6 @@ class Command extends ditamap_1.Ditamap {
|
|
|
57
73
|
summary,
|
|
58
74
|
description,
|
|
59
75
|
help,
|
|
60
|
-
parameters,
|
|
61
76
|
isClosedPilotCommand: state === 'closedPilot',
|
|
62
77
|
isOpenPilotCommand: state === 'openPilot',
|
|
63
78
|
isBetaCommand: state === 'beta',
|
|
@@ -66,24 +81,35 @@ class Command extends ditamap_1.Ditamap {
|
|
|
66
81
|
});
|
|
67
82
|
this.destination = (0, path_1.join)(ditamap_1.Ditamap.outputDir, topic, filename);
|
|
68
83
|
}
|
|
69
|
-
getParametersForTemplate(flags) {
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
84
|
+
async getParametersForTemplate(flags) {
|
|
85
|
+
const final = [];
|
|
86
|
+
for (const [flagName, flag] of Object.entries(flags)) {
|
|
87
|
+
if (flag.hidden)
|
|
88
|
+
continue;
|
|
73
89
|
const description = Array.isArray(flag.description) ? flag.description.join('\n') : flag.description || '';
|
|
74
90
|
const entireDescription = flag.summary ? `${flag.summary}\n${description}` : description;
|
|
75
|
-
|
|
91
|
+
const updated = Object.assign(flag, {
|
|
76
92
|
name: flagName,
|
|
77
93
|
description: this.formatParagraphs(entireDescription),
|
|
78
94
|
optional: !flag.required,
|
|
79
95
|
kind: flag.kind || flag.type,
|
|
80
96
|
hasValue: flag.type !== 'boolean',
|
|
97
|
+
defaultFlagValue: await getDefault(flag),
|
|
81
98
|
});
|
|
82
|
-
|
|
99
|
+
final.push(updated);
|
|
100
|
+
}
|
|
101
|
+
return final;
|
|
83
102
|
}
|
|
84
103
|
getTemplateFileName() {
|
|
85
104
|
return 'command.hbs';
|
|
86
105
|
}
|
|
106
|
+
async transformToDitamap() {
|
|
107
|
+
// eslint-disable-next-line no-console
|
|
108
|
+
console.log('transformToDitamap');
|
|
109
|
+
const parameters = await this.getParametersForTemplate(this.flags);
|
|
110
|
+
this.data = Object.assign({}, this.data, { parameters });
|
|
111
|
+
return super.transformToDitamap();
|
|
112
|
+
}
|
|
87
113
|
}
|
|
88
114
|
exports.Command = Command;
|
|
89
115
|
//# sourceMappingURL=command.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"command.js","sourceRoot":"","sources":["../../src/ditamap/command.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,+BAA4B;AAC5B,mDAQ8B;AAC9B,oCAA6C;AAC7C,uCAAoC;
|
|
1
|
+
{"version":3,"file":"command.js","sourceRoot":"","sources":["../../src/ditamap/command.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,+BAA4B;AAC5B,mDAQ8B;AAC9B,oCAA6C;AAC7C,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,OAAmB,EAAE,cAAuB,EAAE;QAChG,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,EAAC,IAAA,mBAAQ,EAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;QAErD,MAAM,WAAW,GAAG,IAAA,mBAAQ,EAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAElD,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,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,CAAY,CAAC;QAEd,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,IAAI,EAAE;gBAClC,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,sCAAsC;QACtC,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;QAClC,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;AArGD,0BAqGC"}
|
package/lib/ditamap/ditamap.d.ts
CHANGED
package/lib/ditamap/ditamap.js
CHANGED
|
@@ -11,29 +11,8 @@ const path_1 = require("path");
|
|
|
11
11
|
const fs = require("fs/promises");
|
|
12
12
|
const mkdirp = require("mkdirp");
|
|
13
13
|
const debugCreator = require("debug");
|
|
14
|
-
const
|
|
15
|
-
const asyncHelpers = require("handlebars-async-helpers");
|
|
16
|
-
const hb = asyncHelpers(handlebars);
|
|
14
|
+
const hb = require("handlebars");
|
|
17
15
|
const debug = debugCreator('commandreference');
|
|
18
|
-
const getDefault = async (flag) => {
|
|
19
|
-
if (typeof flag.default !== 'function') {
|
|
20
|
-
return new hb.SafeString(`<dd>Default value: ${flag.default}</dd>`);
|
|
21
|
-
}
|
|
22
|
-
else if (typeof flag.default === 'function') {
|
|
23
|
-
try {
|
|
24
|
-
const help = await flag.default();
|
|
25
|
-
if (!help)
|
|
26
|
-
return '';
|
|
27
|
-
return new hb.SafeString(`<dd>Default value: ${help}</dd>`);
|
|
28
|
-
}
|
|
29
|
-
catch {
|
|
30
|
-
return '';
|
|
31
|
-
}
|
|
32
|
-
}
|
|
33
|
-
else {
|
|
34
|
-
return '';
|
|
35
|
-
}
|
|
36
|
-
};
|
|
37
16
|
hb.registerHelper('toUpperCase', (str) => str.toUpperCase());
|
|
38
17
|
hb.registerHelper('join', (array) => array.join(', '));
|
|
39
18
|
hb.registerHelper('xmlFile', (...strings) => {
|
|
@@ -44,20 +23,6 @@ hb.registerHelper('uniqueId', (...strings) => {
|
|
|
44
23
|
const parts = strings.filter((s) => typeof s === 'string');
|
|
45
24
|
return Ditamap.file(parts.join('_'), 'xml').replace('.xml', '');
|
|
46
25
|
});
|
|
47
|
-
hb.registerHelper('getDefault', async function (flag) {
|
|
48
|
-
return getDefault(flag);
|
|
49
|
-
});
|
|
50
|
-
hb.registerHelper('hasDefault', async function (flag) {
|
|
51
|
-
if (!flag.default) {
|
|
52
|
-
return false;
|
|
53
|
-
}
|
|
54
|
-
else if (Array.isArray(flag.default)) {
|
|
55
|
-
return flag.default.length > 0;
|
|
56
|
-
}
|
|
57
|
-
else {
|
|
58
|
-
return !!flag.default && !!(await getDefault(flag));
|
|
59
|
-
}
|
|
60
|
-
});
|
|
61
26
|
/*
|
|
62
27
|
* Returns true if the string should be formatted as code block in docs
|
|
63
28
|
*/
|
|
@@ -108,7 +73,7 @@ class Ditamap {
|
|
|
108
73
|
async transformToDitamap() {
|
|
109
74
|
debug(`Generating ${this.destination} from ${this.getTemplateFileName()}`);
|
|
110
75
|
const src = await fs.readFile(this.source, 'utf8');
|
|
111
|
-
const template = hb.compile(src);
|
|
76
|
+
const template = hb.compile(src, { noEscape: false });
|
|
112
77
|
return template(this.data);
|
|
113
78
|
}
|
|
114
79
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ditamap.js","sourceRoot":"","sources":["../../src/ditamap/ditamap.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,+BAAqC;AACrC,kCAAkC;AAClC,iCAAiC;AAEjC,sCAAsC;AACtC,
|
|
1
|
+
{"version":3,"file":"ditamap.js","sourceRoot":"","sources":["../../src/ditamap/ditamap.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,+BAAqC;AACrC,kCAAkC;AAClC,iCAAiC;AAEjC,sCAAsC;AACtC,iCAAiC;AAEjC,MAAM,KAAK,GAAG,YAAY,CAAC,kBAAkB,CAAC,CAAC;AAE/C,EAAE,CAAC,cAAc,CAAC,aAAa,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC;AAC7D,EAAE,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;AACvD,EAAE,CAAC,cAAc,CAAC,SAAS,EAAE,CAAC,GAAG,OAAO,EAAE,EAAE;IAC1C,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC;IAC3D,OAAO,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC;AAC9C,CAAC,CAAC,CAAC;AACH,EAAE,CAAC,cAAc,CAAC,UAAU,EAAE,CAAC,GAAG,OAAO,EAAE,EAAE;IAC3C,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC;IAC3D,OAAO,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AAClE,CAAC,CAAC,CAAC;AAEH;;GAEG;AACH,mCAAmC;AACnC,EAAE,CAAC,cAAc,CAAC,aAAa,EAAE,UAAqB,GAAG,EAAE,OAAO;IAChE,OAAO,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC;QAC5G,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC;QAClB,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAC5B,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,cAAc,CAAC,aAAa,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;AAEpE,MAAsB,OAAO;IAkC3B,YAA2B,QAAgB,EAAY,IAAa;QAAzC,aAAQ,GAAR,QAAQ,CAAQ;QAAY,SAAI,GAAJ,IAAI,CAAS;QAClE,IAAI,CAAC,MAAM,GAAG,IAAA,WAAI,EAAC,OAAO,CAAC,YAAY,EAAE,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC;QACrE,IAAI,CAAC,WAAW,GAAG,IAAA,WAAI,EAAC,OAAO,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IACvD,CAAC;IArBM,MAAM,KAAK,MAAM;QACtB,OAAO,OAAO,CAAC,OAAO,CAAC;IACzB,CAAC;IAEM,MAAM,KAAK,MAAM,CAAC,MAAc;QACrC,OAAO,CAAC,OAAO,GAAG,MAAM,CAAC;IAC3B,CAAC;IAEM,MAAM,CAAC,IAAI,CAAC,IAAY,EAAE,GAAW;QAC1C,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,OAAO,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,GAAG,EAAE,CAAC;IAChF,CAAC;IAeM,WAAW;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAEM,iBAAiB;QACtB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAEM,KAAK,CAAC,KAAK;QAChB,MAAM,MAAM,CAAC,IAAA,cAAO,EAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;QACxC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAE/C,MAAM,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IAC/C,CAAC;IAES,gBAAgB,CAAC,YAAqB;QAC9C,OAAO,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC9E,CAAC;IAED;;;;;;OAMG;IACO,KAAK,CAAC,kBAAkB;QAChC,KAAK,CAAC,cAAc,IAAI,CAAC,WAAW,SAAS,IAAI,CAAC,mBAAmB,EAAE,EAAE,CAAC,CAAC;QAC3E,MAAM,GAAG,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACnD,MAAM,QAAQ,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;QACtD,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;;AAxEH,0BAyEC;AAxEe,cAAM,GAAG,SAAS,CAAC;AAEnB,oBAAY,GAAG,IAAA,WAAI,EAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC"}
|
package/oclif.manifest.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":"2.2.
|
|
1
|
+
{"version":"2.2.6","commands":{"commandreference:generate":{"id":"commandreference:generate","description":"generate the command reference guide located","strict":true,"pluginName":"@salesforce/plugin-command-reference","pluginAlias":"@salesforce/plugin-command-reference","pluginType":"core","aliases":[],"flags":{"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"outputdir":{"name":"outputdir","type":"option","char":"d","description":"output directory to put generated files","multiple":false,"default":"./tmp/root"},"plugins":{"name":"plugins","type":"option","char":"p","description":"comma separated list of plugin names to be part of the generation. Defaults to the oclif plugin in the current working directory","multiple":true,"exclusive":["all"]},"all":{"name":"all","type":"boolean","char":"a","description":"include all relevant plugins in the generation","allowNo":false,"exclusive":["plugins"]},"ditamap-suffix":{"name":"ditamap-suffix","type":"option","char":"s","description":"unique suffix to append to generated ditamap","multiple":false,"default":"unified"},"hidden":{"name":"hidden","type":"boolean","description":"show hidden commands","allowNo":false},"erroronwarnings":{"name":"erroronwarnings","type":"boolean","description":"fail the command if there are any warnings","allowNo":false}},"args":[],"_globalFlags":{"json":{"description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false,"type":"boolean"}}}}}
|
package/package.json
CHANGED
|
@@ -1,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.2.
|
|
4
|
+
"version": "2.2.6",
|
|
5
5
|
"author": "Salesforce",
|
|
6
6
|
"bugs": "https://github.com/salesforcecli/plugin-command-reference/issues",
|
|
7
7
|
"dependencies": {
|
|
@@ -13,7 +13,6 @@
|
|
|
13
13
|
"chalk": "^3.0.0",
|
|
14
14
|
"fs-extra": "^10.0.1",
|
|
15
15
|
"handlebars": "^4.7.7",
|
|
16
|
-
"handlebars-async-helpers": "^1.0.3",
|
|
17
16
|
"lodash.uniqby": "^4.7.0",
|
|
18
17
|
"mkdirp": "^1.0.4",
|
|
19
18
|
"tslib": "^2"
|
|
@@ -103,7 +102,7 @@
|
|
|
103
102
|
},
|
|
104
103
|
"main": "lib/index.js",
|
|
105
104
|
"sfdx": {
|
|
106
|
-
"publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-command-reference/2.2.
|
|
107
|
-
"signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-command-reference/2.2.
|
|
105
|
+
"publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-command-reference/2.2.6.crt",
|
|
106
|
+
"signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-command-reference/2.2.6.sig"
|
|
108
107
|
}
|
|
109
108
|
}
|
package/templates/command.hbs
CHANGED
|
@@ -100,8 +100,8 @@ IF YOU WANT TO CHANGE THIS CONTENT, CONTACT juliet.shackell@salesforce.com FOR D
|
|
|
100
100
|
{{/if}}<dd>{{#if optional}}Optional{{else}}Required{{/if}}</dd>
|
|
101
101
|
<dd>{{#each description}}<p>{{[]}}</p>{{/each}}</dd>{{#if kind}}
|
|
102
102
|
<dd>Type: {{kind}}</dd>{{/if}}{{#if options}}
|
|
103
|
-
<dd>Permissible values are: {{join options}}</dd>{{/if}}{{#if
|
|
104
|
-
{{
|
|
103
|
+
<dd>Permissible values are: {{join options}}</dd>{{/if}}{{#if defaultFlagValue}}
|
|
104
|
+
<dd>{{defaultFlagValue}}</dd>{{/if}}
|
|
105
105
|
</dlentry>
|
|
106
106
|
{{/each}}
|
|
107
107
|
</dl>
|