@salesforce/plugin-command-reference 1.4.2 → 1.4.3
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/commands/commandreference/generate.d.ts +0 -1
- package/lib/commands/commandreference/generate.js +16 -16
- package/lib/commands/commandreference/generate.js.map +1 -1
- package/lib/ditamap/base-ditamap.js +1 -0
- 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 +1 -0
- package/lib/ditamap/cli-reference.js.map +1 -1
- package/lib/ditamap/command.js +12 -10
- package/lib/ditamap/command.js.map +1 -1
- package/lib/ditamap/ditamap.js +13 -11
- package/lib/ditamap/ditamap.js.map +1 -1
- package/lib/ditamap/main-topic-intro.js +4 -3
- 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 +2 -1
- package/lib/ditamap/topic-ditamap.js.map +1 -1
- package/lib/docs.js +35 -35
- package/lib/docs.js.map +1 -1
- package/lib/utils.js +4 -4
- package/lib/utils.js.map +1 -1
- package/oclif.manifest.json +1 -1
- package/package.json +13 -14
|
@@ -30,10 +30,10 @@ class CommandReferenceGenerate extends command_1.SfdxCommand {
|
|
|
30
30
|
const pJsonPath = path.join(process.cwd(), 'package.json');
|
|
31
31
|
if (fs.existsSync(pJsonPath)) {
|
|
32
32
|
const packageJson = JSON.parse(await fs.promises.readFile(pJsonPath, 'utf8'));
|
|
33
|
-
pluginNames = [ts_types_1.getString(packageJson, 'name')];
|
|
33
|
+
pluginNames = [(0, ts_types_1.getString)(packageJson, 'name')];
|
|
34
34
|
}
|
|
35
35
|
else {
|
|
36
|
-
throw new core_1.
|
|
36
|
+
throw new core_1.SfError("No plugins provided. Provide the '--plugins' flag or cd into a directory that contains a valid oclif plugin.");
|
|
37
37
|
}
|
|
38
38
|
}
|
|
39
39
|
else {
|
|
@@ -48,7 +48,7 @@ class CommandReferenceGenerate extends command_1.SfdxCommand {
|
|
|
48
48
|
pluginName = `@salesforce/plugin-${pluginName}`;
|
|
49
49
|
plugin = this.getPlugin(pluginName);
|
|
50
50
|
if (!plugin) {
|
|
51
|
-
throw new core_1.
|
|
51
|
+
throw new core_1.SfError(`Plugin ${name} or ${pluginName} not found. Is it installed?`);
|
|
52
52
|
}
|
|
53
53
|
}
|
|
54
54
|
return pluginName;
|
|
@@ -61,7 +61,7 @@ class CommandReferenceGenerate extends command_1.SfdxCommand {
|
|
|
61
61
|
ditamap_1.Ditamap.plugins = this.pluginMap(plugins);
|
|
62
62
|
ditamap_1.Ditamap.pluginVersions = plugins.map((name) => {
|
|
63
63
|
const plugin = this.getPlugin(name);
|
|
64
|
-
const version = plugin
|
|
64
|
+
const version = plugin?.version;
|
|
65
65
|
if (!version)
|
|
66
66
|
throw new Error(`No version found for plugin ${name}`);
|
|
67
67
|
return { name, version };
|
|
@@ -75,25 +75,26 @@ class CommandReferenceGenerate extends command_1.SfdxCommand {
|
|
|
75
75
|
process.stderr.write(chalk.yellow(`> ${msg}\n`));
|
|
76
76
|
warnings.push(msg);
|
|
77
77
|
});
|
|
78
|
+
// eslint-disable-next-line @typescript-eslint/no-unsafe-argument
|
|
78
79
|
await docs.build(await this.loadCommands());
|
|
79
80
|
this.log(`\nWrote generated doc to ${ditamap_1.Ditamap.outputDir}`);
|
|
80
81
|
if (this.flags.erroronwarnings && warnings.length > 0) {
|
|
81
|
-
throw new core_1.
|
|
82
|
+
throw new core_1.SfError(`Found ${warnings.length} warnings.`);
|
|
82
83
|
}
|
|
83
84
|
return { warnings };
|
|
84
85
|
}
|
|
85
86
|
pluginMap(plugins) {
|
|
86
87
|
const pluginToParentPlugin = {};
|
|
87
88
|
const resolveChildPlugins = (parentPlugin) => {
|
|
88
|
-
for (const childPlugin of parentPlugin.pjson.oclif.plugins
|
|
89
|
+
for (const childPlugin of parentPlugin.pjson.oclif.plugins ?? []) {
|
|
89
90
|
pluginToParentPlugin[childPlugin] = parentPlugin.name;
|
|
90
|
-
resolveChildPlugins(ts_types_1.ensure(this.getPlugin(childPlugin)));
|
|
91
|
+
resolveChildPlugins((0, ts_types_1.ensure)(this.getPlugin(childPlugin)));
|
|
91
92
|
}
|
|
92
93
|
};
|
|
93
94
|
for (const plugin of plugins) {
|
|
94
95
|
const masterPlugin = this.getPlugin(plugin);
|
|
95
96
|
if (!masterPlugin) {
|
|
96
|
-
throw new core_1.
|
|
97
|
+
throw new core_1.SfError(`Plugin ${plugin} not found. Is it installed?`);
|
|
97
98
|
}
|
|
98
99
|
pluginToParentPlugin[masterPlugin.name] = masterPlugin.name;
|
|
99
100
|
resolveChildPlugins(masterPlugin);
|
|
@@ -109,9 +110,10 @@ class CommandReferenceGenerate extends command_1.SfdxCommand {
|
|
|
109
110
|
for (const cmd of this.config.commands) {
|
|
110
111
|
// Only load topics for each plugin once
|
|
111
112
|
if (cmd.pluginName && !plugins[cmd.pluginName]) {
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
113
|
+
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, no-await-in-loop
|
|
114
|
+
const commandClass = await loadCommand(cmd);
|
|
115
|
+
if (commandClass.plugin?.pjson.oclif.topics) {
|
|
116
|
+
(0, utils_1.mergeDeep)(topicsMeta, commandClass.plugin.pjson.oclif.topics);
|
|
115
117
|
plugins[commandClass.plugin.name] = true;
|
|
116
118
|
}
|
|
117
119
|
}
|
|
@@ -121,7 +123,7 @@ class CommandReferenceGenerate extends command_1.SfdxCommand {
|
|
|
121
123
|
async loadCommands() {
|
|
122
124
|
const promises = this.config.commands.map(async (cmd) => {
|
|
123
125
|
try {
|
|
124
|
-
let commandClass = await
|
|
126
|
+
let commandClass = await loadCommand(cmd);
|
|
125
127
|
let obj = Object.assign({}, cmd, commandClass, {
|
|
126
128
|
flags: Object.assign({}, cmd.flags, commandClass.flags),
|
|
127
129
|
});
|
|
@@ -129,7 +131,7 @@ class CommandReferenceGenerate extends command_1.SfdxCommand {
|
|
|
129
131
|
while (commandClass !== undefined) {
|
|
130
132
|
commandClass = Object.getPrototypeOf(commandClass) || undefined;
|
|
131
133
|
obj = Object.assign({}, commandClass, obj, {
|
|
132
|
-
flags: Object.assign({}, commandClass
|
|
134
|
+
flags: Object.assign({}, commandClass?.flags, obj.flags),
|
|
133
135
|
});
|
|
134
136
|
}
|
|
135
137
|
return obj;
|
|
@@ -141,9 +143,6 @@ class CommandReferenceGenerate extends command_1.SfdxCommand {
|
|
|
141
143
|
const commands = await Promise.all(promises);
|
|
142
144
|
return uniqBy(commands, 'id');
|
|
143
145
|
}
|
|
144
|
-
async loadCommand(command) {
|
|
145
|
-
return command.load.constructor.name === 'AsyncFunction' ? await command.load() : command.load();
|
|
146
|
-
}
|
|
147
146
|
}
|
|
148
147
|
exports.default = CommandReferenceGenerate;
|
|
149
148
|
CommandReferenceGenerate.description = messages.getMessage('commandDescription');
|
|
@@ -161,4 +160,5 @@ CommandReferenceGenerate.flagsConfig = {
|
|
|
161
160
|
hidden: command_1.flags.boolean({ description: messages.getMessage('hiddenFlagDescription') }),
|
|
162
161
|
erroronwarnings: command_1.flags.boolean({ description: messages.getMessage('erroronwarningFlagDescription') }),
|
|
163
162
|
};
|
|
163
|
+
const loadCommand = async (command) => command.load.constructor.name === 'AsyncFunction' ? command.load() : command.load();
|
|
164
164
|
//# sourceMappingURL=generate.js.map
|
|
@@ -1 +1 @@
|
|
|
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,
|
|
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,2CAAqD;AACrD,mDAAuF;AACvF,+BAAgC;AAChC,mDAAgD;AAChD,qCAAkC;AAClC,uCAAgD;AAEhD,8DAA8D;AAC9D,MAAM,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;AAExC,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,IAAA,oBAAS,EAAC,WAAW,EAAE,MAAM,CAAC,CAAC,CAAC;aAChD;iBAAM;gBACL,MAAM,IAAI,cAAO,CACf,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,cAAO,CAAC,UAAU,IAAI,OAAO,UAAU,8BAA8B,CAAC,CAAC;iBAClF;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,SAAmB,CAAC;QAEnD,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,EAAE,OAAO,CAAC;YAChC,IAAI,CAAC,OAAO;gBAAE,MAAM,IAAI,KAAK,CAAC,+BAA+B,IAAI,EAAE,CAAC,CAAC;YACrE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;QAC3B,CAAC,CAAC,CAAC;QAEH,MAAM,IAAI,GAAG,IAAI,WAAI,CACnB,iBAAO,CAAC,SAAS,EACjB,iBAAO,CAAC,OAAO,EACf,IAAI,CAAC,KAAK,CAAC,MAAiB,EAC5B,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAC/B,CAAC;QAEF,cAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE;YAC/B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,qBAAqB,KAAK,GAAG,CAAC,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,EAAE,CAAC;QACpB,cAAM,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,GAAG,EAAE,EAAE;YAC3B,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC;YACjD,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACrB,CAAC,CAAC,CAAC;QAEH,iEAAiE;QACjE,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,cAAO,CAAC,SAAS,QAAQ,CAAC,MAAM,YAAY,CAAC,CAAC;SACzD;QAED,OAAO,EAAE,QAAQ,EAAE,CAAC;IACtB,CAAC;IAEO,SAAS,CAAC,OAAiB;QACjC,MAAM,oBAAoB,GAAY,EAAE,CAAC;QAEzC,MAAM,mBAAmB,GAAG,CAAC,YAAoB,EAAE,EAAE;YACnD,KAAK,MAAM,WAAW,IAAI,YAAY,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,IAAI,EAAE,EAAE;gBAChE,oBAAoB,CAAC,WAAW,CAAC,GAAG,YAAY,CAAC,IAAI,CAAC;gBACtD,mBAAmB,CAAC,IAAA,iBAAM,EAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;aAC1D;QACH,CAAC,CAAC;QAEF,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;YAC5B,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;YAC5C,IAAI,CAAC,YAAY,EAAE;gBACjB,MAAM,IAAI,cAAO,CAAC,UAAU,MAAM,8BAA8B,CAAC,CAAC;aACnE;YACD,oBAAoB,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,IAAI,CAAC;YAC5D,mBAAmB,CAAC,YAAY,CAAC,CAAC;SACnC;QACD,OAAO,oBAAoB,CAAC;IAC9B,CAAC;IAEO,SAAS,CAAC,UAAkB;QAClC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC;IACtE,CAAC;IAEO,KAAK,CAAC,iBAAiB;QAC7B,MAAM,OAAO,GAAwB,EAAE,CAAC;QACxC,MAAM,UAAU,GAAG,EAAE,CAAC;QAEtB,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE;YACtC,wCAAwC;YACxC,IAAI,GAAG,CAAC,UAAU,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE;gBAC9C,qFAAqF;gBACrF,MAAM,YAAY,GAAG,MAAM,WAAW,CAAC,GAAG,CAAC,CAAC;gBAE5C,IAAI,YAAY,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE;oBAC3C,IAAA,iBAAS,EAAC,UAAU,EAAE,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAAoB,CAAC,CAAC;oBAC5E,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;iBAC1C;aACF;SACF;QACD,OAAO,UAAU,CAAC;IACpB,CAAC;IAEO,KAAK,CAAC,YAAY;QACxB,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;YACtD,IAAI;gBACF,IAAI,YAAY,GAAG,MAAM,WAAW,CAAC,GAAG,CAAC,CAAC;gBAC1C,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,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,CAAC;qBACzD,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,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC7C,OAAO,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IAChC,CAAC;;AAjKH,2CAkKC;AAjKe,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;AAmJJ,MAAM,WAAW,GAAG,KAAK,EAAE,OAAyB,EAA0B,EAAE,CAC9E,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,KAAK,eAAe,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC"}
|
|
@@ -15,6 +15,7 @@ class BaseDitamap extends ditamap_1.Ditamap {
|
|
|
15
15
|
namespaceDitamapFiles: topics.sort().map((topic) => `${topic}/cli_reference_${topic}.ditamap`),
|
|
16
16
|
});
|
|
17
17
|
}
|
|
18
|
+
// eslint-disable-next-line class-methods-use-this
|
|
18
19
|
getTemplateFileName() {
|
|
19
20
|
return 'base_ditamap.hbs';
|
|
20
21
|
}
|
|
@@ -1 +1 @@
|
|
|
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;
|
|
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;IAED,kDAAkD;IAC3C,mBAAmB;QACxB,OAAO,kBAAkB,CAAC;IAC5B,CAAC;CACF;AAZD,kCAYC"}
|
|
@@ -18,8 +18,9 @@ class CLIReferenceTopic extends ditamap_1.Ditamap {
|
|
|
18
18
|
longDescription,
|
|
19
19
|
});
|
|
20
20
|
// Override destination to include topic and subtopic
|
|
21
|
-
this.destination = path_1.join(ditamap_1.Ditamap.outputDir, topic, filename);
|
|
21
|
+
this.destination = (0, path_1.join)(ditamap_1.Ditamap.outputDir, topic, filename);
|
|
22
22
|
}
|
|
23
|
+
// eslint-disable-next-line class-methods-use-this
|
|
23
24
|
getTemplateFileName() {
|
|
24
25
|
return 'cli_reference_topic.hbs';
|
|
25
26
|
}
|
|
@@ -1 +1 @@
|
|
|
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,
|
|
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,IAAA,WAAI,EAAC,iBAAO,CAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC9D,CAAC;IAED,kDAAkD;IAC3C,mBAAmB;QACxB,OAAO,yBAAyB,CAAC;IACnC,CAAC;CACF;AAjBD,8CAiBC"}
|
|
@@ -1 +1 @@
|
|
|
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;
|
|
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;IAED,kDAAkD;IAC3C,mBAAmB;QACxB,OAAO,uBAAuB,CAAC;IACjC,CAAC;CACF;AAdD,oCAcC"}
|
package/lib/ditamap/command.js
CHANGED
|
@@ -13,29 +13,30 @@ const utils_1 = require("../utils");
|
|
|
13
13
|
const ditamap_1 = require("./ditamap");
|
|
14
14
|
class Command extends ditamap_1.Ditamap {
|
|
15
15
|
constructor(topic, subtopic, command, commandMeta = {}) {
|
|
16
|
-
const commandWithUnderscores = ts_types_1.ensureString(command.id).replace(/:/g, '_');
|
|
16
|
+
const commandWithUnderscores = (0, ts_types_1.ensureString)(command.id).replace(/:/g, '_');
|
|
17
17
|
const filename = `cli_reference_${commandWithUnderscores}.xml`;
|
|
18
18
|
super(filename, {});
|
|
19
|
-
const flags = ts_types_1.ensureObject(command.flags);
|
|
19
|
+
const flags = (0, ts_types_1.ensureObject)(command.flags);
|
|
20
20
|
const parameters = this.getParametersForTemplate(flags);
|
|
21
21
|
// The template only expects a oneline description. Punctuate the first line of either the lingDescription or description.
|
|
22
|
-
const fullDescription = ts_types_1.asString(command.longDescription) || ts_types_1.asString(command.description);
|
|
23
|
-
const description = utils_1.punctuate(fullDescription);
|
|
22
|
+
const fullDescription = (0, ts_types_1.asString)(command.longDescription) || (0, ts_types_1.asString)(command.description);
|
|
23
|
+
const description = (0, utils_1.punctuate)(fullDescription);
|
|
24
24
|
// Help are all the lines after the first line in the description. Before oclif, there was a 'help' property so continue to
|
|
25
25
|
// support that.
|
|
26
26
|
if (!description) {
|
|
27
27
|
utils_1.events.emit('warning', `Missing description for ${command.id}\n`);
|
|
28
28
|
}
|
|
29
|
-
const help = this.formatParagraphs(ts_types_1.asString(command.help) || utils_1.helpFromDescription(fullDescription));
|
|
29
|
+
const help = this.formatParagraphs((0, ts_types_1.asString)(command.help) || (0, utils_1.helpFromDescription)(fullDescription));
|
|
30
30
|
let trailblazerCommunityUrl;
|
|
31
31
|
let trailblazerCommunityName;
|
|
32
32
|
if (commandMeta.trailblazerCommunityLink) {
|
|
33
|
-
const community = ts_types_1.ensureJsonMap(commandMeta.trailblazerCommunityLink);
|
|
33
|
+
const community = (0, ts_types_1.ensureJsonMap)(commandMeta.trailblazerCommunityLink);
|
|
34
34
|
trailblazerCommunityUrl = community.url;
|
|
35
35
|
trailblazerCommunityName = community.name;
|
|
36
36
|
}
|
|
37
37
|
if (Array.isArray(command.examples)) {
|
|
38
38
|
if (help.includes('Examples:') &&
|
|
39
|
+
// eslint-disable-next-line @typescript-eslint/no-unsafe-argument
|
|
39
40
|
command.examples.map((example, foundAll) => foundAll && help.includes(example), true)) {
|
|
40
41
|
// Examples are already in the help, so don't duplicate.
|
|
41
42
|
// This is legacy support for ToolbeltCommand in salesforce-alm.
|
|
@@ -64,19 +65,19 @@ class Command extends ditamap_1.Ditamap {
|
|
|
64
65
|
});
|
|
65
66
|
// Override destination to include topic and subtopic
|
|
66
67
|
if (subtopic) {
|
|
67
|
-
this.destination = path_1.join(ditamap_1.Ditamap.outputDir, topic, subtopic, filename);
|
|
68
|
+
this.destination = (0, path_1.join)(ditamap_1.Ditamap.outputDir, topic, subtopic, filename);
|
|
68
69
|
}
|
|
69
70
|
else {
|
|
70
|
-
this.destination = path_1.join(ditamap_1.Ditamap.outputDir, topic, filename);
|
|
71
|
+
this.destination = (0, path_1.join)(ditamap_1.Ditamap.outputDir, topic, filename);
|
|
71
72
|
}
|
|
72
73
|
}
|
|
73
74
|
getParametersForTemplate(flags) {
|
|
74
75
|
return Object.entries(flags)
|
|
75
76
|
.filter(([, flag]) => !flag.hidden)
|
|
76
77
|
.map(([flagName, flag]) => {
|
|
77
|
-
const description = this.formatParagraphs(flag.longDescription || utils_1.punctuate(flag.description));
|
|
78
|
+
const description = this.formatParagraphs(flag.longDescription || (0, utils_1.punctuate)(flag.description));
|
|
78
79
|
if (!flag.longDescription) {
|
|
79
|
-
flag.longDescription = utils_1.punctuate(flag.description);
|
|
80
|
+
flag.longDescription = (0, utils_1.punctuate)(flag.description);
|
|
80
81
|
}
|
|
81
82
|
return Object.assign(flag, {
|
|
82
83
|
name: flagName,
|
|
@@ -87,6 +88,7 @@ class Command extends ditamap_1.Ditamap {
|
|
|
87
88
|
});
|
|
88
89
|
});
|
|
89
90
|
}
|
|
91
|
+
// eslint-disable-next-line class-methods-use-this
|
|
90
92
|
getTemplateFileName() {
|
|
91
93
|
return 'command.hbs';
|
|
92
94
|
}
|
|
@@ -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,
|
|
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,IAAA,uBAAY,EAAC,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,IAAA,uBAAY,EAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC1C,MAAM,UAAU,GAAG,IAAI,CAAC,wBAAwB,CAAC,KAAoC,CAAC,CAAC;QAEvF,0HAA0H;QAC1H,MAAM,eAAe,GAAG,IAAA,mBAAQ,EAAC,OAAO,CAAC,eAAe,CAAC,IAAI,IAAA,mBAAQ,EAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAC3F,MAAM,WAAW,GAAG,IAAA,iBAAS,EAAC,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,IAAA,mBAAQ,EAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAA,2BAAmB,EAAC,eAAe,CAAC,CAAC,CAAC;QACnG,IAAI,uBAAuB,CAAC;QAC5B,IAAI,wBAAwB,CAAC;QAE7B,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,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;YACnC,IACE,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC;gBAC1B,iEAAiE;gBACjE,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,IAAA,WAAI,EAAC,iBAAO,CAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;SACvE;aAAM;YACL,IAAI,CAAC,WAAW,GAAG,IAAA,WAAI,EAAC,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,IAAA,iBAAS,EAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;YAC/F,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE;gBACzB,IAAI,CAAC,eAAe,GAAG,IAAA,iBAAS,EAAC,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;IAED,kDAAkD;IAC3C,mBAAmB;QACxB,OAAO,aAAa,CAAC;IACvB,CAAC;CACF;AAlGD,0BAkGC"}
|
package/lib/ditamap/ditamap.js
CHANGED
|
@@ -10,28 +10,29 @@ exports.Ditamap = void 0;
|
|
|
10
10
|
const fs = require("fs");
|
|
11
11
|
const path_1 = require("path");
|
|
12
12
|
const debugCreator = require("debug");
|
|
13
|
-
|
|
13
|
+
// import { compile, registerHelper } from 'handlebars';
|
|
14
|
+
const handlebars = require("handlebars");
|
|
14
15
|
const debug = debugCreator('commandreference');
|
|
15
16
|
class Ditamap {
|
|
16
17
|
constructor(filename, data) {
|
|
17
18
|
this.filename = filename;
|
|
18
19
|
this.data = data;
|
|
19
|
-
|
|
20
|
-
|
|
20
|
+
handlebars.registerHelper('toUpperCase', (str) => str.toUpperCase());
|
|
21
|
+
handlebars.registerHelper('join', (array) => array.join(', '));
|
|
21
22
|
/*
|
|
22
23
|
* Returns true if the string should be formatted as code block in docs
|
|
23
24
|
*/
|
|
24
25
|
// tslint:disable-next-line: no-any
|
|
25
|
-
|
|
26
|
+
handlebars.registerHelper('isCodeBlock', function (val, options) {
|
|
26
27
|
return val.indexOf('$ sfdx') >= 0 || val.indexOf('>>') >= 0 ? options.fn(this) : options.inverse(this);
|
|
27
28
|
});
|
|
28
29
|
/*
|
|
29
30
|
* Remove OS prompt in codeblocks, as per CCX style guidelines in our published docs
|
|
30
31
|
*/
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
this.source = path_1.join(Ditamap.templatesDir, this.getTemplateFileName());
|
|
34
|
-
this.destination = path_1.join(Ditamap.outputDir, filename);
|
|
32
|
+
handlebars.registerHelper('removePrompt', (codeblock) => codeblock.substring(codeblock.indexOf('$') + 1));
|
|
33
|
+
handlebars.registerHelper('nextVersion', (value) => parseInt(value, 2) + 1);
|
|
34
|
+
this.source = (0, path_1.join)(Ditamap.templatesDir, this.getTemplateFileName());
|
|
35
|
+
this.destination = (0, path_1.join)(Ditamap.outputDir, filename);
|
|
35
36
|
}
|
|
36
37
|
getFilename() {
|
|
37
38
|
return this.filename;
|
|
@@ -40,10 +41,11 @@ class Ditamap {
|
|
|
40
41
|
return this.destination;
|
|
41
42
|
}
|
|
42
43
|
async write() {
|
|
43
|
-
await fs.promises.mkdir(path_1.dirname(this.destination), { recursive: true });
|
|
44
|
+
await fs.promises.mkdir((0, path_1.dirname)(this.destination), { recursive: true });
|
|
44
45
|
const output = await this.transformToDitamap();
|
|
45
46
|
await fs.promises.writeFile(this.destination, output);
|
|
46
47
|
}
|
|
48
|
+
// eslint-disable-next-line class-methods-use-this
|
|
47
49
|
formatParagraphs(textToFormat) {
|
|
48
50
|
return textToFormat ? textToFormat.split('\n').filter((n) => n !== '') : [];
|
|
49
51
|
}
|
|
@@ -57,10 +59,10 @@ class Ditamap {
|
|
|
57
59
|
async transformToDitamap() {
|
|
58
60
|
debug(`Generating ${this.destination} from ${this.getTemplateFileName()}`);
|
|
59
61
|
const src = await fs.promises.readFile(this.source, 'utf8');
|
|
60
|
-
const template =
|
|
62
|
+
const template = handlebars.compile(src);
|
|
61
63
|
return template(this.data);
|
|
62
64
|
}
|
|
63
65
|
}
|
|
64
66
|
exports.Ditamap = Ditamap;
|
|
65
|
-
Ditamap.templatesDir = path_1.join(__dirname, '..', '..', 'templates');
|
|
67
|
+
Ditamap.templatesDir = (0, path_1.join)(__dirname, '..', '..', 'templates');
|
|
66
68
|
//# sourceMappingURL=ditamap.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ditamap.js","sourceRoot":"","sources":["../../src/ditamap/ditamap.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACH,yBAAyB;AACzB,+BAAqC;AAErC,sCAAsC;AACtC,
|
|
1
|
+
{"version":3,"file":"ditamap.js","sourceRoot":"","sources":["../../src/ditamap/ditamap.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACH,yBAAyB;AACzB,+BAAqC;AAErC,sCAAsC;AACtC,wDAAwD;AACxD,yCAAyC;AAEzC,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,UAAU,CAAC,cAAc,CAAC,aAAa,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC;QACrE,UAAU,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAE/D;;WAEG;QACH,mCAAmC;QACnC,UAAU,CAAC,cAAc,CAAC,aAAa,EAAE,UAAqB,GAAG,EAAE,OAAO;YACxE,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,UAAU,CAAC,cAAc,CAAC,cAAc,EAAE,CAAC,SAAS,EAAE,EAAE,CACtD,SAAS,CAAC,SAAS,CAAE,SAAS,CAAC,OAAO,CAAC,GAAG,CAAY,GAAG,CAAC,CAAC,CAC5D,CAAC;QACF,UAAU,CAAC,cAAc,CAAC,aAAa,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAe,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QACtF,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;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,IAAA,cAAO,EAAC,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;IAED,kDAAkD;IACxC,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,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACzC,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;;AAzEH,0BA4EC;AA3Ee,oBAAY,GAAG,IAAA,WAAI,EAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC"}
|
|
@@ -18,12 +18,12 @@ class MainTopicIntro extends ditamap_1.Ditamap {
|
|
|
18
18
|
let trailblazerCommunityUrl;
|
|
19
19
|
let trailblazerCommunityName;
|
|
20
20
|
if (subTopicMeta.trailblazerCommunityLink) {
|
|
21
|
-
const community = ts_types_1.ensureJsonMap(subTopicMeta.trailblazerCommunityLink);
|
|
21
|
+
const community = (0, ts_types_1.ensureJsonMap)(subTopicMeta.trailblazerCommunityLink);
|
|
22
22
|
trailblazerCommunityUrl = community.url;
|
|
23
23
|
trailblazerCommunityName = community.name;
|
|
24
24
|
}
|
|
25
25
|
if (!subTopicMeta.longDescription && !subTopicMeta.external) {
|
|
26
|
-
subTopicMeta.longDescription = utils_1.punctuate(ts_types_1.asString(subTopicMeta.description));
|
|
26
|
+
subTopicMeta.longDescription = (0, utils_1.punctuate)((0, ts_types_1.asString)(subTopicMeta.description));
|
|
27
27
|
}
|
|
28
28
|
super(filename, {
|
|
29
29
|
topic: subtopic,
|
|
@@ -35,8 +35,9 @@ class MainTopicIntro extends ditamap_1.Ditamap {
|
|
|
35
35
|
trailblazerCommunityName,
|
|
36
36
|
});
|
|
37
37
|
// Override destination to include topic and subtopic
|
|
38
|
-
this.destination = path_1.join(ditamap_1.Ditamap.outputDir, topic, subtopic, filename);
|
|
38
|
+
this.destination = (0, path_1.join)(ditamap_1.Ditamap.outputDir, topic, subtopic, filename);
|
|
39
39
|
}
|
|
40
|
+
// eslint-disable-next-line class-methods-use-this
|
|
40
41
|
getTemplateFileName() {
|
|
41
42
|
return 'main_topic_intro.hbs';
|
|
42
43
|
}
|
|
@@ -1 +1 @@
|
|
|
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,
|
|
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,IAAA,wBAAa,EAAC,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,IAAA,iBAAS,EAAC,IAAA,mBAAQ,EAAC,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,IAAA,WAAI,EAAC,iBAAO,CAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACxE,CAAC;IAED,kDAAkD;IAC3C,mBAAmB;QACxB,OAAO,sBAAsB,CAAC;IAChC,CAAC;CACF;AAlCD,wCAkCC"}
|
|
@@ -20,8 +20,9 @@ class SubTopicDitamap extends ditamap_1.Ditamap {
|
|
|
20
20
|
commandFileNames,
|
|
21
21
|
});
|
|
22
22
|
// Override destination to include topic and subtopic
|
|
23
|
-
this.destination = path_1.join(ditamap_1.Ditamap.outputDir, topic, subtopic, filename);
|
|
23
|
+
this.destination = (0, path_1.join)(ditamap_1.Ditamap.outputDir, topic, subtopic, filename);
|
|
24
24
|
}
|
|
25
|
+
// eslint-disable-next-line class-methods-use-this
|
|
25
26
|
getTemplateFileName() {
|
|
26
27
|
return 'subtopic_ditamap.hbs';
|
|
27
28
|
}
|
|
@@ -1 +1 @@
|
|
|
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,
|
|
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,IAAA,WAAI,EAAC,iBAAO,CAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACxE,CAAC;IAED,kDAAkD;IAC3C,mBAAmB;QACxB,OAAO,sBAAsB,CAAC;IAChC,CAAC;CACF;AArBD,0CAqBC"}
|
|
@@ -19,8 +19,9 @@ class TopicDitamap extends ditamap_1.Ditamap {
|
|
|
19
19
|
commands: commandNames.sort().map((command) => ({ command })),
|
|
20
20
|
});
|
|
21
21
|
// Override destination to include topic and subtopic
|
|
22
|
-
this.destination = path_1.join(ditamap_1.Ditamap.outputDir, topic, filename);
|
|
22
|
+
this.destination = (0, path_1.join)(ditamap_1.Ditamap.outputDir, topic, filename);
|
|
23
23
|
}
|
|
24
|
+
// eslint-disable-next-line class-methods-use-this
|
|
24
25
|
getTemplateFileName() {
|
|
25
26
|
return 'topic_ditamap.hbs';
|
|
26
27
|
}
|
|
@@ -1 +1 @@
|
|
|
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,
|
|
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,IAAA,WAAI,EAAC,iBAAO,CAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC9D,CAAC;IAED,kDAAkD;IAC3C,mBAAmB;QACxB,OAAO,mBAAmB,CAAC;IAC7B,CAAC;CACF;AAlBD,oCAkBC"}
|
package/lib/docs.js
CHANGED
|
@@ -19,7 +19,7 @@ const main_topic_intro_1 = require("./ditamap/main-topic-intro");
|
|
|
19
19
|
const subtopic_ditamap_1 = require("./ditamap/subtopic-ditamap");
|
|
20
20
|
const topic_ditamap_1 = require("./ditamap/topic-ditamap");
|
|
21
21
|
const utils_1 = require("./utils");
|
|
22
|
-
const templatesDir = path_1.join(__dirname, '..', 'templates');
|
|
22
|
+
const templatesDir = (0, path_1.join)(__dirname, '..', 'templates');
|
|
23
23
|
class Docs {
|
|
24
24
|
constructor(outputDir, plugins, hidden, topicMeta) {
|
|
25
25
|
this.outputDir = outputDir;
|
|
@@ -34,11 +34,11 @@ class Docs {
|
|
|
34
34
|
}
|
|
35
35
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
36
36
|
async populateTopic(topic, subtopics) {
|
|
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.`);
|
|
38
|
-
let description = ts_types_1.asString(topicMeta.longDescription);
|
|
37
|
+
const topicMeta = (0, ts_types_1.ensureJsonMap)(this.topicMeta[topic], `No topic meta for ${topic} - add this topic to the oclif section of the package.json.`);
|
|
38
|
+
let description = (0, ts_types_1.asString)(topicMeta.longDescription);
|
|
39
39
|
if (!description && !topicMeta.external) {
|
|
40
40
|
// Punctuate the description in place of longDescription
|
|
41
|
-
description = utils_1.punctuate(ts_types_1.asString(topicMeta.description));
|
|
41
|
+
description = (0, utils_1.punctuate)((0, ts_types_1.asString)(topicMeta.description));
|
|
42
42
|
if (!description) {
|
|
43
43
|
utils_1.events.emit('warning', `No description for topic ${chalk.bold(topic)}. Skipping until topic owner adds topic metadata, that includes longDescription, in the oclif section in the package.json file within their plugin.`);
|
|
44
44
|
return;
|
|
@@ -50,32 +50,36 @@ class Docs {
|
|
|
50
50
|
for (const subtopic of Object.keys(subtopics)) {
|
|
51
51
|
const subtopicOrCommand = subtopics[subtopic];
|
|
52
52
|
try {
|
|
53
|
-
if (!ts_types_1.isArray(subtopicOrCommand)) {
|
|
53
|
+
if (!(0, ts_types_1.isArray)(subtopicOrCommand)) {
|
|
54
54
|
// If it is not subtopic (array) it is a command in the top-level topic
|
|
55
55
|
const command = subtopicOrCommand;
|
|
56
|
-
const commandMeta = this.resolveCommandMeta(ts_types_1.ensureString(command.id), command, 1);
|
|
56
|
+
const commandMeta = this.resolveCommandMeta((0, ts_types_1.ensureString)(command.id), command, 1);
|
|
57
|
+
// eslint-disable-next-line no-await-in-loop
|
|
57
58
|
await this.populateCommand(topic, null, command, commandMeta);
|
|
58
59
|
commandNames.push(subtopic);
|
|
59
60
|
continue;
|
|
60
61
|
}
|
|
61
|
-
const subTopicsMeta = ts_types_1.ensureJsonMap(topicMeta.subtopics);
|
|
62
|
+
const subTopicsMeta = (0, ts_types_1.ensureJsonMap)(topicMeta.subtopics);
|
|
62
63
|
if (!subTopicsMeta[subtopic]) {
|
|
63
64
|
const fullTopicPath = `${topic}:${subtopic}`;
|
|
64
65
|
utils_1.events.emit('warning', `No metadata for topic ${chalk.bold(fullTopicPath)}. That topic owner must add topic metadata in the oclif section in the package.json file within their plugin.`);
|
|
65
66
|
continue;
|
|
66
67
|
}
|
|
67
|
-
const subtopicMeta = ts_types_1.ensureJsonMap(subTopicsMeta[subtopic]);
|
|
68
|
+
const subtopicMeta = (0, ts_types_1.ensureJsonMap)(subTopicsMeta[subtopic]);
|
|
68
69
|
// The intro doc for this topic
|
|
70
|
+
// eslint-disable-next-line no-await-in-loop
|
|
69
71
|
await new main_topic_intro_1.MainTopicIntro(topic, subtopic, subtopicMeta).write();
|
|
70
72
|
subTopicNames.push(subtopic);
|
|
71
73
|
// Commands within the sub topic
|
|
72
74
|
const filenames = [];
|
|
73
75
|
for (const command of subtopicOrCommand) {
|
|
74
|
-
const fullTopic = ts_types_1.ensureString(command.id).replace(/:\w+$/, '');
|
|
75
|
-
const commandsInFullTopic = subtopicOrCommand.filter((cmd) => ts_types_1.ensureString(cmd.id).
|
|
76
|
-
const commandMeta = this.resolveCommandMeta(ts_types_1.ensureString(command.id), command, commandsInFullTopic.length);
|
|
76
|
+
const fullTopic = (0, ts_types_1.ensureString)(command.id).replace(/:\w+$/, '');
|
|
77
|
+
const commandsInFullTopic = subtopicOrCommand.filter((cmd) => (0, ts_types_1.ensureString)(cmd.id).startsWith(fullTopic));
|
|
78
|
+
const commandMeta = this.resolveCommandMeta((0, ts_types_1.ensureString)(command.id), command, commandsInFullTopic.length);
|
|
79
|
+
// eslint-disable-next-line no-await-in-loop
|
|
77
80
|
filenames.push(await this.populateCommand(topic, subtopic, command, commandMeta));
|
|
78
81
|
}
|
|
82
|
+
// eslint-disable-next-line no-await-in-loop
|
|
79
83
|
await new subtopic_ditamap_1.SubTopicDitamap(topic, subtopic, filenames).write();
|
|
80
84
|
}
|
|
81
85
|
catch (error) {
|
|
@@ -100,7 +104,7 @@ class Docs {
|
|
|
100
104
|
if (command.hidden && !this.hidden) {
|
|
101
105
|
continue;
|
|
102
106
|
}
|
|
103
|
-
const commandParts = ts_types_1.ensureString(command.id).split(':');
|
|
107
|
+
const commandParts = (0, ts_types_1.ensureString)(command.id).split(':');
|
|
104
108
|
if (commandParts.length === 1) {
|
|
105
109
|
continue; // Top level topic command. Just ignore for as it is usually help for the topic.
|
|
106
110
|
}
|
|
@@ -117,8 +121,8 @@ class Docs {
|
|
|
117
121
|
else {
|
|
118
122
|
const subtopic = commandParts[1];
|
|
119
123
|
try {
|
|
120
|
-
const topicMeta = ts_types_1.ensureJsonMap(this.topicMeta[topLevelTopic]);
|
|
121
|
-
const subTopicsMeta = ts_types_1.ensureJsonMap(topicMeta.subtopics);
|
|
124
|
+
const topicMeta = (0, ts_types_1.ensureJsonMap)(this.topicMeta[topLevelTopic]);
|
|
125
|
+
const subTopicsMeta = (0, ts_types_1.ensureJsonMap)(topicMeta.subtopics);
|
|
122
126
|
if (subTopicsMeta.hidden && !this.hidden) {
|
|
123
127
|
continue;
|
|
124
128
|
}
|
|
@@ -129,10 +133,10 @@ class Docs {
|
|
|
129
133
|
command.subtopic = subtopic;
|
|
130
134
|
const existingSubTopics = topics[subtopic];
|
|
131
135
|
let subtopicCommands = [];
|
|
132
|
-
if (ts_types_1.isArray(existingSubTopics)) {
|
|
136
|
+
if ((0, ts_types_1.isArray)(existingSubTopics)) {
|
|
133
137
|
subtopicCommands = existingSubTopics;
|
|
134
138
|
}
|
|
135
|
-
ts_types_1.ensureArray(subtopicCommands);
|
|
139
|
+
(0, ts_types_1.ensureArray)(subtopicCommands);
|
|
136
140
|
subtopicCommands.push(command);
|
|
137
141
|
topics[subtopic] = subtopicCommands;
|
|
138
142
|
}
|
|
@@ -144,15 +148,15 @@ class Docs {
|
|
|
144
148
|
async populateTemplate(commands) {
|
|
145
149
|
const topicsAndSubtopics = this.groupTopicsAndSubtopics(commands);
|
|
146
150
|
await new cli_reference_1.CLIReference().write();
|
|
147
|
-
await utils_1.copyStaticFile(this.outputDir, templatesDir, 'cli_reference_help.xml');
|
|
151
|
+
await (0, utils_1.copyStaticFile)(this.outputDir, templatesDir, 'cli_reference_help.xml');
|
|
148
152
|
const topics = Object.keys(topicsAndSubtopics);
|
|
149
153
|
// Generate one base file with all top-level topics.
|
|
150
154
|
await new base_ditamap_1.BaseDitamap(topics).write();
|
|
151
|
-
|
|
155
|
+
await Promise.all(topics.map((topic) => {
|
|
152
156
|
utils_1.events.emit('topic', { topic });
|
|
153
|
-
const subtopics = ts_types_1.ensure(topicsAndSubtopics[topic]);
|
|
154
|
-
|
|
155
|
-
}
|
|
157
|
+
const subtopics = (0, ts_types_1.ensure)(topicsAndSubtopics[topic]);
|
|
158
|
+
return this.populateTopic(topic, subtopics);
|
|
159
|
+
}));
|
|
156
160
|
}
|
|
157
161
|
resolveCommandMeta(commandId, command, commandsInTopic) {
|
|
158
162
|
const commandMeta = {};
|
|
@@ -163,11 +167,11 @@ class Docs {
|
|
|
163
167
|
let currentMeta;
|
|
164
168
|
for (part of commandParts) {
|
|
165
169
|
if (currentMeta) {
|
|
166
|
-
const subtopics = ts_types_1.ensureJsonMap(currentMeta.subtopics);
|
|
167
|
-
currentMeta = ts_types_1.ensureJsonMap(subtopics[part]);
|
|
170
|
+
const subtopics = (0, ts_types_1.ensureJsonMap)(currentMeta.subtopics);
|
|
171
|
+
currentMeta = (0, ts_types_1.ensureJsonMap)(subtopics[part]);
|
|
168
172
|
}
|
|
169
173
|
else {
|
|
170
|
-
currentMeta = ts_types_1.ensureJsonMap(this.topicMeta[part]);
|
|
174
|
+
currentMeta = (0, ts_types_1.ensureJsonMap)(this.topicMeta[part]);
|
|
171
175
|
}
|
|
172
176
|
// Collect all tiers of the meta, so the command will also pick up the topic state (isPilot, etc) if applicable
|
|
173
177
|
Object.assign(commandMeta, currentMeta);
|
|
@@ -178,17 +182,13 @@ class Docs {
|
|
|
178
182
|
// This means there wasn't meta information going all the way down to the command, which is ok.
|
|
179
183
|
return commandMeta;
|
|
180
184
|
}
|
|
181
|
-
else {
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
commandMeta.description = command.description;
|
|
189
|
-
commandMeta.longDescription = command.longDescription || utils_1.punctuate(command.description);
|
|
190
|
-
}
|
|
191
|
-
}
|
|
185
|
+
else if (commandsInTopic !== 1) {
|
|
186
|
+
utils_1.events.emit('warning', `subtopic "${part}" meta not found for command ${commandId}`);
|
|
187
|
+
}
|
|
188
|
+
else if (!commandMeta.description) {
|
|
189
|
+
// Since there is no command meta, just use the command description since that is what oclif does.
|
|
190
|
+
commandMeta.description = command.description;
|
|
191
|
+
commandMeta.longDescription = command.longDescription ?? (0, utils_1.punctuate)(command.description);
|
|
192
192
|
}
|
|
193
193
|
}
|
|
194
194
|
return commandMeta;
|
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;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,
|
|
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,IAAA,WAAI,EAAC,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,IAAA,wBAAa,EAC7B,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EACrB,qBAAqB,KAAK,6DAA6D,CACxF,CAAC;QACF,IAAI,WAAW,GAAG,IAAA,mBAAQ,EAAC,SAAS,CAAC,eAAe,CAAC,CAAC;QACtD,IAAI,CAAC,WAAW,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE;YACvC,wDAAwD;YACxD,WAAW,GAAG,IAAA,iBAAS,EAAC,IAAA,mBAAQ,EAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC;YACzD,IAAI,CAAC,WAAW,EAAE;gBAChB,cAAM,CAAC,IAAI,CACT,SAAS,EACT,4BAA4B,KAAK,CAAC,IAAI,CACpC,KAAK,CACN,qJAAqJ,CACvJ,CAAC;gBACF,OAAO;aACR;SACF;QACD,MAAM,IAAI,uCAAiB,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC,KAAK,EAAE,CAAC;QAExD,MAAM,aAAa,GAAa,EAAE,CAAC;QACnC,MAAM,YAAY,GAAa,EAAE,CAAC;QAClC,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;YAC7C,MAAM,iBAAiB,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;YAC9C,IAAI;gBACF,IAAI,CAAC,IAAA,kBAAO,EAAC,iBAAiB,CAAC,EAAE;oBAC/B,uEAAuE;oBACvE,MAAM,OAAO,GAAG,iBAAiB,CAAC;oBAClC,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAA,uBAAY,EAAC,OAAO,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;oBAClF,4CAA4C;oBAC5C,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,IAAA,wBAAa,EAAC,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,IAAA,wBAAa,EAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC;gBAE5D,+BAA+B;gBAC/B,4CAA4C;gBAC5C,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,IAAA,uBAAY,EAAC,OAAO,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;oBAChE,MAAM,mBAAmB,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAA,uBAAY,EAAC,GAAG,CAAC,EAAE,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC;oBAC1G,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAA,uBAAY,EAAC,OAAO,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,mBAAmB,CAAC,MAAM,CAAC,CAAC;oBAE3G,4CAA4C;oBAC5C,SAAS,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC;iBACnF;gBACD,4CAA4C;gBAC5C,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,IAAA,uBAAY,EAAC,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,IAAA,wBAAa,EAAC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAC;wBAC/D,MAAM,aAAa,GAAG,IAAA,wBAAa,EAAC,SAAS,CAAC,SAAS,CAAC,CAAC;wBACzD,IAAI,aAAa,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;4BACxC,SAAS;yBACV;qBACF;oBAAC,OAAO,CAAC,EAAE;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,IAAA,kBAAO,EAAC,iBAAiB,CAAC,EAAE;wBAC9B,gBAAgB,GAAG,iBAAiB,CAAC;qBACtC;oBACD,IAAA,sBAAW,EAAC,gBAAgB,CAAC,CAAC;oBAC9B,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;oBAC/B,MAAM,CAAC,QAAQ,CAAC,GAAG,gBAAgB,CAAC;iBACrC;gBAED,cAAc,CAAC,aAAa,CAAC,GAAG,MAAM,CAAC;aACxC;SACF;QACD,OAAO,cAAc,CAAC;IACxB,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAAC,QAAmB;QAChD,MAAM,kBAAkB,GAAG,IAAI,CAAC,uBAAuB,CAAC,QAAQ,CAAC,CAAC;QAElE,MAAM,IAAI,4BAAY,EAAE,CAAC,KAAK,EAAE,CAAC;QACjC,MAAM,IAAA,sBAAc,EAAC,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,MAAM,OAAO,CAAC,GAAG,CACf,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;YACnB,cAAM,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;YAChC,MAAM,SAAS,GAAG,IAAA,iBAAM,EAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC;YACpD,OAAO,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QAC9C,CAAC,CAAC,CACH,CAAC;IACJ,CAAC;IAEO,kBAAkB,CAAC,SAAiB,EAAE,OAAO,EAAE,eAAuB;QAC5E,MAAM,WAAW,GAAiE,EAAE,CAAC;QACrF,yEAAyE;QACzE,MAAM,YAAY,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC1C,IAAI,IAAY,CAAC;QACjB,IAAI;YACF,IAAI,WAAgC,CAAC;YACrC,KAAK,IAAI,IAAI,YAAY,EAAE;gBACzB,IAAI,WAAW,EAAE;oBACf,MAAM,SAAS,GAAG,IAAA,wBAAa,EAAC,WAAW,CAAC,SAAS,CAAC,CAAC;oBACvD,WAAW,GAAG,IAAA,wBAAa,EAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;iBAC9C;qBAAM;oBACL,WAAW,GAAG,IAAA,wBAAa,EAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;iBACnD;gBAED,+GAA+G;gBAC/G,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;aACzC;SACF;QAAC,OAAO,KAAK,EAAE;YACd,IAAI,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;gBAC5B,+FAA+F;gBAC/F,OAAO,WAAW,CAAC;aACpB;iBAAM,IAAI,eAAe,KAAK,CAAC,EAAE;gBAChC,cAAM,CAAC,IAAI,CAAC,SAAS,EAAE,aAAa,IAAI,gCAAgC,SAAS,EAAE,CAAC,CAAC;aACtF;iBAAM,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE;gBACnC,kGAAkG;gBAClG,WAAW,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;gBAC9C,WAAW,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,IAAI,IAAA,iBAAS,EAAC,OAAO,CAAC,WAAqB,CAAC,CAAC;aACnG;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;AApOD,oBAoOC"}
|
package/lib/utils.js
CHANGED
|
@@ -15,15 +15,15 @@ const path_1 = require("path");
|
|
|
15
15
|
const ts_types_1 = require("@salesforce/ts-types");
|
|
16
16
|
exports.events = new events_1.EventEmitter();
|
|
17
17
|
async function copyStaticFile(outputDir, fileDir, fileName) {
|
|
18
|
-
const source = path_1.join(fileDir, fileName);
|
|
19
|
-
const dest = path_1.join(outputDir, fileName);
|
|
18
|
+
const source = (0, path_1.join)(fileDir, fileName);
|
|
19
|
+
const dest = (0, path_1.join)(outputDir, fileName);
|
|
20
20
|
await fs.promises.mkdir(outputDir, { recursive: true });
|
|
21
21
|
await fs.promises.copyFile(source, dest);
|
|
22
22
|
}
|
|
23
23
|
exports.copyStaticFile = copyStaticFile;
|
|
24
24
|
function mergeDeep(target, source) {
|
|
25
25
|
Object.keys(source).forEach((key) => {
|
|
26
|
-
if (ts_types_1.isObject(target[key]) && ts_types_1.isObject(source[key])) {
|
|
26
|
+
if ((0, ts_types_1.isObject)(target[key]) && (0, ts_types_1.isObject)(source[key])) {
|
|
27
27
|
mergeDeep(target[key], source[key]);
|
|
28
28
|
}
|
|
29
29
|
else {
|
|
@@ -39,7 +39,7 @@ function punctuate(description) {
|
|
|
39
39
|
const lines = description.split(os_1.EOL);
|
|
40
40
|
let mainDescription = lines[0];
|
|
41
41
|
mainDescription = mainDescription.charAt(0).toUpperCase() + mainDescription.substring(1);
|
|
42
|
-
if (mainDescription.
|
|
42
|
+
if (!mainDescription.endsWith('.')) {
|
|
43
43
|
mainDescription += '.';
|
|
44
44
|
}
|
|
45
45
|
return mainDescription;
|
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,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,
|
|
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,IAAA,WAAI,EAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IACvC,MAAM,IAAI,GAAG,IAAA,WAAI,EAAC,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,IAAA,mBAAQ,EAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,IAAA,mBAAQ,EAAC,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,CAAC,eAAe,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;QAClC,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.4.
|
|
1
|
+
{"version":"1.4.3","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,40 +1,39 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@salesforce/plugin-command-reference",
|
|
3
3
|
"description": "Generate the Salesforce CLI command reference guide",
|
|
4
|
-
"version": "1.4.
|
|
4
|
+
"version": "1.4.3",
|
|
5
5
|
"author": "Salesforce",
|
|
6
6
|
"bugs": "https://github.com/forcedotcom/plugin-command-reference/issues",
|
|
7
7
|
"dependencies": {
|
|
8
|
-
"@salesforce/command": "^5.2.
|
|
9
|
-
"@salesforce/core": "^3.
|
|
8
|
+
"@salesforce/command": "^5.2.11",
|
|
9
|
+
"@salesforce/core": "^3.30.10",
|
|
10
10
|
"@types/lodash.uniqby": "^4.7.7",
|
|
11
11
|
"chalk": "^3.0.0",
|
|
12
12
|
"handlebars": "4.7.7",
|
|
13
13
|
"lodash.uniqby": "^4.7.0",
|
|
14
14
|
"shelljs": "^0.8.5",
|
|
15
|
-
"tslib": "^
|
|
15
|
+
"tslib": "^2"
|
|
16
16
|
},
|
|
17
17
|
"devDependencies": {
|
|
18
18
|
"@salesforce/dev-config": "^3.1.0",
|
|
19
|
-
"@salesforce/dev-scripts": "^
|
|
19
|
+
"@salesforce/dev-scripts": "^3.1.0",
|
|
20
20
|
"@salesforce/plugin-alias": "^2.1.0",
|
|
21
21
|
"@salesforce/plugin-signups": "^1.2.0",
|
|
22
22
|
"@salesforce/prettier-config": "^0.0.2",
|
|
23
23
|
"@semantic-release/changelog": "^5.0.0",
|
|
24
24
|
"@semantic-release/git": "^9.0.1",
|
|
25
25
|
"@types/shelljs": "^0.8.11",
|
|
26
|
-
"@typescript-eslint/eslint-plugin": "^
|
|
27
|
-
"@typescript-eslint/parser": "^
|
|
26
|
+
"@typescript-eslint/eslint-plugin": "^5.33.0",
|
|
27
|
+
"@typescript-eslint/parser": "^5.33.0",
|
|
28
28
|
"chai": "^4.3.6",
|
|
29
|
-
"eslint": "^
|
|
30
|
-
"eslint-config-prettier": "^
|
|
31
|
-
"eslint-config-salesforce": "^
|
|
29
|
+
"eslint": "^8.21.0",
|
|
30
|
+
"eslint-config-prettier": "^8.5.0",
|
|
31
|
+
"eslint-config-salesforce": "^1.1.0",
|
|
32
32
|
"eslint-config-salesforce-license": "^0.1.6",
|
|
33
|
-
"eslint-config-salesforce-typescript": "^
|
|
33
|
+
"eslint-config-salesforce-typescript": "^1.1.1",
|
|
34
34
|
"eslint-plugin-header": "^3.0.0",
|
|
35
35
|
"eslint-plugin-import": "2.26.0",
|
|
36
|
-
"eslint-plugin-jsdoc": "^
|
|
37
|
-
"eslint-plugin-prettier": "^3.1.3",
|
|
36
|
+
"eslint-plugin-jsdoc": "^39.3.6",
|
|
38
37
|
"husky": "^7.0.4",
|
|
39
38
|
"mocha": "^9.1.3",
|
|
40
39
|
"nyc": "^15.1.0",
|
|
@@ -45,7 +44,7 @@
|
|
|
45
44
|
"semantic-release": "^17.4.7",
|
|
46
45
|
"sinon": "10.0.0",
|
|
47
46
|
"ts-node": "^10.9.1",
|
|
48
|
-
"typescript": "4.
|
|
47
|
+
"typescript": "^4.8.4"
|
|
49
48
|
},
|
|
50
49
|
"engines": {
|
|
51
50
|
"node": ">=14.0.0"
|