@salesforce/plugin-command-reference 2.4.2 → 2.4.4
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 +1 -1
- package/lib/commands/commandreference/generate.js +17 -27
- package/lib/commands/commandreference/generate.js.map +1 -1
- package/lib/commands/jit/install.js +1 -2
- package/lib/commands/jit/install.js.map +1 -1
- package/lib/ditamap/base-ditamap.js +0 -1
- package/lib/ditamap/base-ditamap.js.map +1 -1
- package/lib/ditamap/cli-reference-topic.js +0 -1
- package/lib/ditamap/cli-reference-topic.js.map +1 -1
- package/lib/ditamap/cli-reference.js +0 -1
- package/lib/ditamap/cli-reference.js.map +1 -1
- package/lib/ditamap/command.d.ts +2 -2
- package/lib/ditamap/command.js +24 -32
- package/lib/ditamap/command.js.map +1 -1
- package/lib/ditamap/ditamap.d.ts +8 -7
- package/lib/ditamap/ditamap.js +10 -10
- package/lib/ditamap/ditamap.js.map +1 -1
- package/lib/ditamap/help-reference.js +0 -1
- package/lib/ditamap/help-reference.js.map +1 -1
- package/lib/ditamap/main-topic-intro.d.ts +2 -1
- package/lib/ditamap/main-topic-intro.js +3 -4
- package/lib/ditamap/main-topic-intro.js.map +1 -1
- package/lib/ditamap/topic-commands.d.ts +2 -1
- package/lib/ditamap/topic-commands.js +0 -1
- package/lib/ditamap/topic-commands.js.map +1 -1
- package/lib/ditamap/topic-ditamap.js +0 -1
- package/lib/ditamap/topic-ditamap.js.map +1 -1
- package/lib/docs.d.ts +3 -3
- package/lib/docs.js +27 -33
- package/lib/docs.js.map +1 -1
- package/lib/utils.d.ts +4 -2
- package/lib/utils.js +15 -2
- package/lib/utils.js.map +1 -1
- package/oclif.manifest.json +1 -1
- package/package.json +34 -138
|
@@ -5,7 +5,7 @@ export default class CommandReferenceGenerate extends SfCommand<AnyJson> {
|
|
|
5
5
|
static description: string;
|
|
6
6
|
static flags: {
|
|
7
7
|
outputdir: Interfaces.OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
|
|
8
|
-
plugins: Interfaces.OptionFlag<string[]
|
|
8
|
+
plugins: Interfaces.OptionFlag<string[], import("@oclif/core/lib/interfaces/parser").CustomOptions>;
|
|
9
9
|
all: Interfaces.BooleanFlag<boolean>;
|
|
10
10
|
'ditamap-suffix': Interfaces.OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
|
|
11
11
|
hidden: Interfaces.BooleanFlag<boolean>;
|
|
@@ -6,19 +6,19 @@
|
|
|
6
6
|
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
7
7
|
*/
|
|
8
8
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
|
-
const fs = require("fs/promises");
|
|
10
|
-
const fs_1 = require("fs");
|
|
11
9
|
const os = require("os");
|
|
12
10
|
const path = require("path");
|
|
11
|
+
const fs_extra_1 = require("fs-extra");
|
|
13
12
|
const sf_plugins_core_1 = require("@salesforce/sf-plugins-core");
|
|
14
13
|
const core_1 = require("@oclif/core");
|
|
15
14
|
const core_2 = require("@salesforce/core");
|
|
16
15
|
const ts_types_1 = require("@salesforce/ts-types");
|
|
17
16
|
const chalk = require("chalk");
|
|
18
|
-
const kit_1 = require("@salesforce/kit");
|
|
19
17
|
const ditamap_1 = require("../../ditamap/ditamap");
|
|
20
18
|
const docs_1 = require("../../docs");
|
|
21
19
|
const utils_1 = require("../../utils");
|
|
20
|
+
// eslint-disable-next-line @typescript-eslint/no-var-requires
|
|
21
|
+
const uniqBy = require('lodash.uniqby');
|
|
22
22
|
// Initialize Messages with the current plugin directory
|
|
23
23
|
core_2.Messages.importMessagesDirectory(__dirname);
|
|
24
24
|
const messages = core_2.Messages.loadMessages('@salesforce/plugin-command-reference', 'main');
|
|
@@ -29,9 +29,9 @@ class CommandReferenceGenerate extends sf_plugins_core_1.SfCommand {
|
|
|
29
29
|
let pluginNames;
|
|
30
30
|
if (!flags.plugins && !flags.all) {
|
|
31
31
|
const pJsonPath = path.join(process.cwd(), 'package.json');
|
|
32
|
-
if ((0,
|
|
33
|
-
const packageJson = (0,
|
|
34
|
-
pluginNames = [(0, ts_types_1.
|
|
32
|
+
if (await (0, fs_extra_1.pathExists)(pJsonPath)) {
|
|
33
|
+
const packageJson = await (0, fs_extra_1.readJSON)(pJsonPath);
|
|
34
|
+
pluginNames = [(0, ts_types_1.getString)(packageJson, 'name')];
|
|
35
35
|
}
|
|
36
36
|
else {
|
|
37
37
|
throw new core_2.SfError("No plugins provided. Provide the '--plugins' flag or cd into a directory that contains a valid oclif plugin.");
|
|
@@ -48,7 +48,7 @@ class CommandReferenceGenerate extends sf_plugins_core_1.SfCommand {
|
|
|
48
48
|
pluginNames = this.config.plugins.map((p) => p.name).filter((p) => !ignore.some((i) => i.test(p)));
|
|
49
49
|
}
|
|
50
50
|
else {
|
|
51
|
-
pluginNames = flags.plugins
|
|
51
|
+
pluginNames = flags.plugins;
|
|
52
52
|
}
|
|
53
53
|
const plugins = pluginNames
|
|
54
54
|
.map((plugin) => plugin.trim())
|
|
@@ -72,7 +72,7 @@ class CommandReferenceGenerate extends sf_plugins_core_1.SfCommand {
|
|
|
72
72
|
ditamap_1.Ditamap.plugins = this.pluginMap(plugins);
|
|
73
73
|
ditamap_1.Ditamap.pluginVersions = plugins.map((name) => {
|
|
74
74
|
const plugin = this.getPlugin(name);
|
|
75
|
-
const version = plugin
|
|
75
|
+
const version = plugin && plugin.version;
|
|
76
76
|
if (!version)
|
|
77
77
|
throw new Error(`No version found for plugin ${name}`);
|
|
78
78
|
return { name, version };
|
|
@@ -83,12 +83,10 @@ class CommandReferenceGenerate extends sf_plugins_core_1.SfCommand {
|
|
|
83
83
|
});
|
|
84
84
|
const warnings = [];
|
|
85
85
|
utils_1.events.on('warning', (msg) => {
|
|
86
|
-
// eslint-disable-next-line @typescript-eslint/restrict-template-expressions
|
|
87
86
|
process.stderr.write(chalk.yellow(`> ${msg}\n`));
|
|
88
87
|
warnings.push(msg);
|
|
89
88
|
});
|
|
90
|
-
|
|
91
|
-
await docs.build(cmnds);
|
|
89
|
+
await docs.build(await this.loadCommands());
|
|
92
90
|
this.log(`\nWrote generated doc to ${ditamap_1.Ditamap.outputDir}`);
|
|
93
91
|
if (flags.erroronwarnings && warnings.length > 0) {
|
|
94
92
|
throw new core_2.SfError(`Found ${warnings.length} warnings.`);
|
|
@@ -98,7 +96,7 @@ class CommandReferenceGenerate extends sf_plugins_core_1.SfCommand {
|
|
|
98
96
|
pluginMap(plugins) {
|
|
99
97
|
const pluginToParentPlugin = {};
|
|
100
98
|
const resolveChildPlugins = (parentPlugin) => {
|
|
101
|
-
for (const childPlugin of parentPlugin.pjson.oclif.plugins
|
|
99
|
+
for (const childPlugin of parentPlugin.pjson.oclif.plugins || []) {
|
|
102
100
|
pluginToParentPlugin[childPlugin] = parentPlugin.name;
|
|
103
101
|
resolveChildPlugins((0, ts_types_1.ensure)(this.getPlugin(childPlugin)));
|
|
104
102
|
}
|
|
@@ -122,10 +120,9 @@ class CommandReferenceGenerate extends sf_plugins_core_1.SfCommand {
|
|
|
122
120
|
for (const cmd of this.config.commands) {
|
|
123
121
|
// Only load topics for each plugin once
|
|
124
122
|
if (cmd.pluginName && !plugins[cmd.pluginName]) {
|
|
125
|
-
// eslint-disable-next-line no-await-in-loop
|
|
126
123
|
const commandClass = await this.loadCommand(cmd);
|
|
127
|
-
if (commandClass.plugin
|
|
128
|
-
|
|
124
|
+
if (commandClass.plugin && commandClass.plugin.pjson.oclif.topics) {
|
|
125
|
+
(0, utils_1.mergeDeep)(topicsMeta, commandClass.plugin.pjson.oclif.topics);
|
|
129
126
|
plugins[commandClass.plugin.name] = true;
|
|
130
127
|
}
|
|
131
128
|
}
|
|
@@ -141,33 +138,26 @@ class CommandReferenceGenerate extends sf_plugins_core_1.SfCommand {
|
|
|
141
138
|
});
|
|
142
139
|
// Load all properties on all extending classes.
|
|
143
140
|
while (commandClass !== undefined) {
|
|
144
|
-
commandClass =
|
|
141
|
+
commandClass = Object.getPrototypeOf(commandClass) || undefined;
|
|
145
142
|
obj = Object.assign({}, commandClass, obj, {
|
|
146
|
-
flags: Object.assign({}, commandClass
|
|
143
|
+
flags: Object.assign({}, commandClass && commandClass.flags, obj.flags),
|
|
147
144
|
});
|
|
148
145
|
}
|
|
149
146
|
return obj;
|
|
150
147
|
}
|
|
151
148
|
catch (error) {
|
|
152
|
-
return cmd;
|
|
149
|
+
return Object.assign({}, cmd);
|
|
153
150
|
}
|
|
154
151
|
});
|
|
155
152
|
const commands = await Promise.all(promises);
|
|
156
|
-
return
|
|
157
|
-
.reduce((acc, cmd) => {
|
|
158
|
-
acc.set(cmd.id, cmd);
|
|
159
|
-
return acc;
|
|
160
|
-
}, new Map())
|
|
161
|
-
.values());
|
|
153
|
+
return uniqBy(commands, 'id');
|
|
162
154
|
}
|
|
163
|
-
// eslint-disable-next-line class-methods-use-this
|
|
164
155
|
async loadCommand(command) {
|
|
165
|
-
// eslint-disable-next-line @typescript-eslint/return-await
|
|
166
156
|
return command.load.constructor.name === 'AsyncFunction' ? await command.load() : command.load();
|
|
167
157
|
}
|
|
168
158
|
loadCliMeta() {
|
|
169
159
|
return {
|
|
170
|
-
binary: this.config.pjson.oclif.bin
|
|
160
|
+
binary: this.config.pjson.oclif.bin || 'sfdx',
|
|
171
161
|
topicSeparator: this.config.pjson.oclif.topicSeparator,
|
|
172
162
|
state: this.config.pjson.oclif.state,
|
|
173
163
|
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../../src/commands/commandreference/generate.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAEH,
|
|
1
|
+
{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../../src/commands/commandreference/generate.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAEH,yBAAyB;AACzB,6BAA6B;AAC7B,uCAAgD;AAChD,iEAAwD;AACxD,sCAAyD;AACzD,2CAAqD;AACrD,mDAAuF;AACvF,+BAAgC;AAChC,mDAAgD;AAChD,qCAAkC;AAClC,uCAA8D;AAE9D,8DAA8D;AAC9D,MAAM,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;AAExC,wDAAwD;AACxD,eAAQ,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;AAC5C,MAAM,QAAQ,GAAG,eAAQ,CAAC,YAAY,CAAC,sCAAsC,EAAE,MAAM,CAAC,CAAC;AAEvF,MAAqB,wBAAyB,SAAQ,2BAAkB;IA6B/D,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAE7D,iBAAO,CAAC,MAAM,GAAG,KAAK,CAAC,gBAAgB,CAAC,CAAC;QAEzC,IAAI,WAAqB,CAAC;QAC1B,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE;YAChC,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,cAAc,CAAC,CAAC;YAC3D,IAAI,MAAM,IAAA,qBAAU,EAAC,SAAS,CAAC,EAAE;gBAC/B,MAAM,WAAW,GAAG,MAAM,IAAA,mBAAQ,EAAC,SAAS,CAAC,CAAC;gBAC9C,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,IAAI,KAAK,CAAC,GAAG,EAAE;YACpB,MAAM,MAAM,GAAG;gBACb,QAAQ;gBACR,kBAAkB;gBAClB,yBAAyB;gBACzB,+BAA+B;gBAC/B,uCAAuC;aACxC,CAAC;YACF,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SACpG;aAAM;YACL,WAAW,GAAG,KAAK,CAAC,OAAO,CAAC;SAC7B;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,GAAG,CACN,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,KAAK,CAAC,SAAS,CAAC;QAEpC,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,CACnB,iBAAO,CAAC,SAAS,EACjB,iBAAO,CAAC,OAAO,EACf,KAAK,CAAC,MAAM,EACZ,MAAM,IAAI,CAAC,iBAAiB,EAAE,EAC9B,IAAI,CAAC,WAAW,EAAE,CACnB,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,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,KAAK,CAAC,eAAe,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;YAChD,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,YAA+B,EAAE,EAAE;YAC9D,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,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,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,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,EAAE,EAAE,GAAG,CAAC,CAAC;aAC/B;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;IAEO,KAAK,CAAC,WAAW,CAAC,OAAyB;QACjD,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;IAEO,WAAW;QACjB,OAAO;YACL,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,IAAI,MAAM;YAC7C,cAAc,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,cAAc;YACtD,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK;SACrC,CAAC;IACJ,CAAC;;AAnMH,2CAoMC;AAnMe,oCAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAC;AAExD,8BAAK,GAAG;IACpB,SAAS,EAAE,YAAK,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,YAAK,CAAC,MAAM,CAAC;QACpB,IAAI,EAAE,GAAG;QACT,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,uBAAuB,CAAC;QACzD,QAAQ,EAAE,IAAI;QACd,SAAS,EAAE,CAAC,KAAK,CAAC;KACnB,CAAC;IACF,GAAG,EAAE,YAAK,CAAC,OAAO,CAAC;QACjB,IAAI,EAAE,GAAG;QACT,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,oBAAoB,CAAC;QACtD,SAAS,EAAE,CAAC,SAAS,CAAC;KACvB,CAAC;IACF,gBAAgB,EAAE,YAAK,CAAC,MAAM,CAAC;QAC7B,IAAI,EAAE,GAAG;QACT,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,8BAA8B,CAAC;QAChE,OAAO,EAAE,iBAAO,CAAC,MAAM;KACxB,CAAC;IACF,MAAM,EAAE,YAAK,CAAC,OAAO,CAAC,EAAE,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,uBAAuB,CAAC,EAAE,CAAC;IACpF,eAAe,EAAE,YAAK,CAAC,OAAO,CAAC,EAAE,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,+BAA+B,CAAC,EAAE,CAAC;CACtG,CAAC"}
|
|
@@ -19,12 +19,11 @@ class JitInstall extends sf_plugins_core_1.SfCommand {
|
|
|
19
19
|
async run() {
|
|
20
20
|
const { flags } = await this.parse(JitInstall);
|
|
21
21
|
this.styledHeader(`Install all JIT Plugins${flags['dry-run'] ? ' (dry-run)' : ''}`);
|
|
22
|
-
for (const [plugin, version] of Object.entries(this.config.pjson.oclif.jitPlugins
|
|
22
|
+
for (const [plugin, version] of Object.entries(this.config.pjson.oclif.jitPlugins)) {
|
|
23
23
|
this.log(`• ${plugin} ${chalk.dim(version)}`);
|
|
24
24
|
if (flags['dry-run'])
|
|
25
25
|
continue;
|
|
26
26
|
try {
|
|
27
|
-
// eslint-disable-next-line no-await-in-loop
|
|
28
27
|
await this.config.runCommand('plugins:install', [`${plugin}@${version}`]);
|
|
29
28
|
}
|
|
30
29
|
catch {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"install.js","sourceRoot":"","sources":["../../../src/commands/jit/install.ts"],"names":[],"mappings":";;AAAA;;;;;GAKG;AACH,iEAA+D;AAC/D,2CAA4C;AAC5C,+BAA+B;AAE/B,eAAQ,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;AAC5C,MAAM,QAAQ,GAAG,eAAQ,CAAC,IAAI,CAAC,sCAAsC,EAAE,aAAa,EAAE;IACpF,SAAS;IACT,UAAU;IACV,uBAAuB;CACxB,CAAC,CAAC;AAEH,MAAqB,UAAW,SAAQ,2BAAe;IAW9C,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAE/C,IAAI,CAAC,YAAY,CAAC,0BAA0B,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACpF,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,UAAU,
|
|
1
|
+
{"version":3,"file":"install.js","sourceRoot":"","sources":["../../../src/commands/jit/install.ts"],"names":[],"mappings":";;AAAA;;;;;GAKG;AACH,iEAA+D;AAC/D,2CAA4C;AAC5C,+BAA+B;AAE/B,eAAQ,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;AAC5C,MAAM,QAAQ,GAAG,eAAQ,CAAC,IAAI,CAAC,sCAAsC,EAAE,aAAa,EAAE;IACpF,SAAS;IACT,UAAU;IACV,uBAAuB;CACxB,CAAC,CAAC;AAEH,MAAqB,UAAW,SAAQ,2BAAe;IAW9C,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAE/C,IAAI,CAAC,YAAY,CAAC,0BAA0B,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACpF,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE;YAClF,IAAI,CAAC,GAAG,CAAC,KAAK,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;YAC9C,IAAI,KAAK,CAAC,SAAS,CAAC;gBAAE,SAAS;YAC/B,IAAI;gBACF,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAC,GAAG,MAAM,IAAI,OAAO,EAAE,CAAC,CAAC,CAAC;aAC3E;YAAC,MAAM;gBACN,IAAI,CAAC,GAAG,CAAC,qBAAqB,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;aAChE;SACF;IACH,CAAC;;AAxBH,6BAyBC;AAxBwB,kBAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;AACzC,mBAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;AAE5C,gBAAK,GAAG;IAC7B,SAAS,EAAE,uBAAK,CAAC,OAAO,CAAC;QACvB,IAAI,EAAE,GAAG;QACT,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,uBAAuB,CAAC;KACtD,CAAC;CACH,CAAC"}
|
|
@@ -15,7 +15,6 @@ class BaseDitamap extends ditamap_1.Ditamap {
|
|
|
15
15
|
namespaceDitamapFiles: topics.sort().map((topic) => ditamap_1.Ditamap.file(`${topic}/cli_reference_${topic}`, 'ditamap')),
|
|
16
16
|
});
|
|
17
17
|
}
|
|
18
|
-
// eslint-disable-next-line class-methods-use-this
|
|
19
18
|
getTemplateFileName() {
|
|
20
19
|
return 'base_ditamap.hbs';
|
|
21
20
|
}
|
|
@@ -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,iBAAO,CAAC,IAAI,CAAC,eAAe,EAAE,SAAS,CAAC,EAAE;YAC9C,qBAAqB,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,iBAAO,CAAC,IAAI,CAAC,GAAG,KAAK,kBAAkB,KAAK,EAAE,EAAE,SAAS,CAAC,CAAC;SAChH,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,iBAAO,CAAC,IAAI,CAAC,eAAe,EAAE,SAAS,CAAC,EAAE;YAC9C,qBAAqB,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,iBAAO,CAAC,IAAI,CAAC,GAAG,KAAK,kBAAkB,KAAK,EAAE,EAAE,SAAS,CAAC,CAAC;SAChH,CAAC,CAAC;IACL,CAAC;IAEM,mBAAmB;QACxB,OAAO,kBAAkB,CAAC;IAC5B,CAAC;CACF;AAXD,kCAWC"}
|
|
@@ -20,7 +20,6 @@ class CLIReferenceTopic extends ditamap_1.Ditamap {
|
|
|
20
20
|
// Override destination to include topic and subtopic
|
|
21
21
|
this.destination = (0, path_1.join)(ditamap_1.Ditamap.outputDir, topic, filename);
|
|
22
22
|
}
|
|
23
|
-
// eslint-disable-next-line class-methods-use-this
|
|
24
23
|
getTemplateFileName() {
|
|
25
24
|
return 'cli_reference_topic.hbs';
|
|
26
25
|
}
|
|
@@ -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,iBAAO,CAAC,IAAI,CAAC,iBAAiB,KAAK,EAAE,EAAE,KAAK,CAAC,CAAC;QAC/D,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;
|
|
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,iBAAO,CAAC,IAAI,CAAC,iBAAiB,KAAK,EAAE,EAAE,KAAK,CAAC,CAAC;QAC/D,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;IAEM,mBAAmB;QACxB,OAAO,yBAAyB,CAAC;IACnC,CAAC;CACF;AAhBD,8CAgBC"}
|
|
@@ -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,iBAAO,CAAC,IAAI,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;QAEtD,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,iBAAO,CAAC,IAAI,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;QAEtD,KAAK,CAAC,QAAQ,EAAE;YACd,UAAU,EAAE,iBAAO,CAAC,UAAU;YAC9B,cAAc,EAAE,iBAAO,CAAC,cAAc;SACvC,CAAC,CAAC;IACL,CAAC;IAEM,mBAAmB;QACxB,OAAO,uBAAuB,CAAC;IACjC,CAAC;CACF;AAbD,oCAaC"}
|
package/lib/ditamap/command.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { Dictionary } from '@salesforce/ts-types';
|
|
1
|
+
import { Dictionary, JsonMap } from '@salesforce/ts-types';
|
|
2
2
|
import { CommandClass } from '../utils';
|
|
3
3
|
import { Ditamap } from './ditamap';
|
|
4
4
|
export type CommandHelpInfo = {
|
|
@@ -13,7 +13,7 @@ export type CommandHelpInfo = {
|
|
|
13
13
|
};
|
|
14
14
|
export declare class Command extends Ditamap {
|
|
15
15
|
private flags;
|
|
16
|
-
constructor(topic: string, subtopic: string
|
|
16
|
+
constructor(topic: string, subtopic: string, command: CommandClass, commandMeta?: JsonMap);
|
|
17
17
|
getParametersForTemplate(flags: Dictionary<CommandHelpInfo>): Promise<CommandHelpInfo[]>;
|
|
18
18
|
getTemplateFileName(): string;
|
|
19
19
|
protected transformToDitamap(): Promise<string>;
|
package/lib/ditamap/command.js
CHANGED
|
@@ -12,10 +12,10 @@ const ts_types_1 = require("@salesforce/ts-types");
|
|
|
12
12
|
const utils_1 = require("../utils");
|
|
13
13
|
const ditamap_1 = require("./ditamap");
|
|
14
14
|
const getDefault = async (flag) => {
|
|
15
|
-
if (
|
|
16
|
-
return
|
|
15
|
+
if (typeof flag.default !== 'function') {
|
|
16
|
+
return flag.default;
|
|
17
17
|
}
|
|
18
|
-
if (typeof flag.default === 'function') {
|
|
18
|
+
else if (typeof flag.default === 'function') {
|
|
19
19
|
try {
|
|
20
20
|
const help = await flag.default();
|
|
21
21
|
return help || '';
|
|
@@ -25,7 +25,7 @@ const getDefault = async (flag) => {
|
|
|
25
25
|
}
|
|
26
26
|
}
|
|
27
27
|
else {
|
|
28
|
-
return
|
|
28
|
+
return '';
|
|
29
29
|
}
|
|
30
30
|
};
|
|
31
31
|
class Command extends ditamap_1.Ditamap {
|
|
@@ -42,31 +42,25 @@ class Command extends ditamap_1.Ditamap {
|
|
|
42
42
|
let trailblazerCommunityUrl;
|
|
43
43
|
let trailblazerCommunityName;
|
|
44
44
|
if (commandMeta.trailblazerCommunityLink) {
|
|
45
|
-
const community = commandMeta.trailblazerCommunityLink;
|
|
46
|
-
trailblazerCommunityUrl = community.url
|
|
47
|
-
trailblazerCommunityName = community.name
|
|
45
|
+
const community = (0, ts_types_1.ensureJsonMap)(commandMeta.trailblazerCommunityLink);
|
|
46
|
+
trailblazerCommunityUrl = community.url;
|
|
47
|
+
trailblazerCommunityName = community.name;
|
|
48
48
|
}
|
|
49
|
-
const commandName = command.id.replace(/:/g, (0, ts_types_1.asString)(commandMeta.topicSeparator
|
|
50
|
-
const examples = (command.examples
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
const parts = example.split('\n');
|
|
55
|
-
desc = parts.length > 1 ? parts[0] : null;
|
|
56
|
-
commands = parts.length > 1 ? parts.slice(1) : [parts[0]];
|
|
57
|
-
}
|
|
58
|
-
else {
|
|
59
|
-
desc = example.description;
|
|
60
|
-
commands = [example.command];
|
|
61
|
-
}
|
|
49
|
+
const commandName = (0, ts_types_1.asString)(command.id).replace(/:/g, (0, ts_types_1.asString)(commandMeta.topicSeparator));
|
|
50
|
+
const examples = (command.examples || []).map((example) => {
|
|
51
|
+
const parts = example.split('\n');
|
|
52
|
+
const desc = parts.length > 1 ? parts[0] : null;
|
|
53
|
+
const commands = parts.length > 1 ? parts.slice(1) : [parts[0]];
|
|
62
54
|
return {
|
|
63
55
|
description: desc,
|
|
64
|
-
commands: commands.map((c) =>
|
|
65
|
-
|
|
66
|
-
|
|
56
|
+
commands: commands.map((c) => {
|
|
57
|
+
return c
|
|
58
|
+
.replace(/<%= config.bin %>/g, (0, ts_types_1.asString)(commandMeta.binary))
|
|
59
|
+
.replace(/<%= command.id %>/g, commandName);
|
|
60
|
+
}),
|
|
67
61
|
};
|
|
68
62
|
});
|
|
69
|
-
const state = command.state
|
|
63
|
+
const state = command.state || commandMeta.state;
|
|
70
64
|
this.data = Object.assign(command, {
|
|
71
65
|
name: commandName,
|
|
72
66
|
binary: commandMeta.binary,
|
|
@@ -87,24 +81,22 @@ class Command extends ditamap_1.Ditamap {
|
|
|
87
81
|
async getParametersForTemplate(flags) {
|
|
88
82
|
const final = [];
|
|
89
83
|
for (const [flagName, flag] of Object.entries(flags)) {
|
|
90
|
-
if (flag
|
|
84
|
+
if (flag.hidden)
|
|
91
85
|
continue;
|
|
92
|
-
const description = Array.isArray(flag
|
|
93
|
-
const entireDescription = flag
|
|
86
|
+
const description = Array.isArray(flag.description) ? flag.description.join('\n') : flag.description || '';
|
|
87
|
+
const entireDescription = flag.summary ? `${flag.summary}\n${description}` : description;
|
|
94
88
|
const updated = Object.assign({}, flag, {
|
|
95
89
|
name: flagName,
|
|
96
90
|
description: this.formatParagraphs(entireDescription),
|
|
97
|
-
optional: !flag
|
|
98
|
-
kind: flag
|
|
99
|
-
hasValue: flag
|
|
100
|
-
// eslint-disable-next-line no-await-in-loop
|
|
91
|
+
optional: !flag.required,
|
|
92
|
+
kind: flag.kind || flag.type,
|
|
93
|
+
hasValue: flag.type !== 'boolean',
|
|
101
94
|
defaultFlagValue: await getDefault(flag),
|
|
102
95
|
});
|
|
103
96
|
final.push(updated);
|
|
104
97
|
}
|
|
105
98
|
return final;
|
|
106
99
|
}
|
|
107
|
-
// eslint-disable-next-line class-methods-use-this
|
|
108
100
|
getTemplateFileName() {
|
|
109
101
|
return 'command.hbs';
|
|
110
102
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"command.js","sourceRoot":"","sources":["../../src/ditamap/command.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,+BAA4B;AAC5B,
|
|
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,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,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;AA/FD,0BA+FC"}
|
package/lib/ditamap/ditamap.d.ts
CHANGED
|
@@ -1,22 +1,24 @@
|
|
|
1
|
+
import { JsonMap } from '@salesforce/ts-types';
|
|
1
2
|
export declare abstract class Ditamap {
|
|
2
3
|
private filename;
|
|
3
|
-
protected data:
|
|
4
|
+
protected data: JsonMap;
|
|
4
5
|
static SUFFIX: string;
|
|
5
6
|
static templatesDir: string;
|
|
6
7
|
static outputDir: string;
|
|
7
8
|
static cliVersion: string;
|
|
8
|
-
static plugins:
|
|
9
|
+
static plugins: JsonMap;
|
|
9
10
|
static pluginVersions: Array<{
|
|
10
11
|
name: string;
|
|
11
12
|
version: string;
|
|
12
13
|
}>;
|
|
13
|
-
private static _suffix;
|
|
14
|
-
protected destination: string;
|
|
15
|
-
private readonly source;
|
|
16
|
-
constructor(filename: string, data: Record<string, unknown>);
|
|
17
14
|
static get suffix(): string;
|
|
18
15
|
static set suffix(suffix: string);
|
|
19
16
|
static file(name: string, ext: string): string;
|
|
17
|
+
private static _suffix;
|
|
18
|
+
protected destination: string;
|
|
19
|
+
private source;
|
|
20
|
+
constructor(filename: string, data: JsonMap);
|
|
21
|
+
abstract getTemplateFileName(): string;
|
|
20
22
|
getFilename(): string;
|
|
21
23
|
getOutputFilePath(): string;
|
|
22
24
|
write(): Promise<void>;
|
|
@@ -29,5 +31,4 @@ export declare abstract class Ditamap {
|
|
|
29
31
|
* @returns {object}
|
|
30
32
|
*/
|
|
31
33
|
protected transformToDitamap(): Promise<string>;
|
|
32
|
-
abstract getTemplateFileName(): string;
|
|
33
34
|
}
|
package/lib/ditamap/ditamap.js
CHANGED
|
@@ -9,6 +9,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
9
9
|
exports.Ditamap = void 0;
|
|
10
10
|
const path_1 = require("path");
|
|
11
11
|
const fs = require("fs/promises");
|
|
12
|
+
const mkdirp = require("mkdirp");
|
|
12
13
|
const debugCreator = require("debug");
|
|
13
14
|
const hb = require("handlebars");
|
|
14
15
|
const debug = debugCreator('commandreference');
|
|
@@ -25,20 +26,14 @@ hb.registerHelper('uniqueId', (...strings) => {
|
|
|
25
26
|
/*
|
|
26
27
|
* Returns true if the string should be formatted as code block in docs
|
|
27
28
|
*/
|
|
28
|
-
//
|
|
29
|
+
// tslint:disable-next-line: no-any
|
|
29
30
|
hb.registerHelper('isCodeBlock', function (val, options) {
|
|
30
|
-
return val.
|
|
31
|
+
return val.indexOf('sf') === 0 || val.indexOf('sfdx') === 0 || val.indexOf('$') >= 0 || val.indexOf('>>') >= 0
|
|
31
32
|
? options.fn(this)
|
|
32
33
|
: options.inverse(this);
|
|
33
34
|
});
|
|
34
35
|
hb.registerHelper('nextVersion', (value) => parseInt(value, 2) + 1);
|
|
35
36
|
class Ditamap {
|
|
36
|
-
constructor(filename, data) {
|
|
37
|
-
this.filename = filename;
|
|
38
|
-
this.data = data;
|
|
39
|
-
this.source = (0, path_1.join)(Ditamap.templatesDir, this.getTemplateFileName());
|
|
40
|
-
this.destination = (0, path_1.join)(Ditamap.outputDir, filename);
|
|
41
|
-
}
|
|
42
37
|
static get suffix() {
|
|
43
38
|
return Ditamap._suffix;
|
|
44
39
|
}
|
|
@@ -48,6 +43,12 @@ class Ditamap {
|
|
|
48
43
|
static file(name, ext) {
|
|
49
44
|
return Ditamap.suffix ? `${name}_${Ditamap.suffix}.${ext}` : `${name}.${ext}`;
|
|
50
45
|
}
|
|
46
|
+
constructor(filename, data) {
|
|
47
|
+
this.filename = filename;
|
|
48
|
+
this.data = data;
|
|
49
|
+
this.source = (0, path_1.join)(Ditamap.templatesDir, this.getTemplateFileName());
|
|
50
|
+
this.destination = (0, path_1.join)(Ditamap.outputDir, filename);
|
|
51
|
+
}
|
|
51
52
|
getFilename() {
|
|
52
53
|
return this.filename;
|
|
53
54
|
}
|
|
@@ -55,11 +56,10 @@ class Ditamap {
|
|
|
55
56
|
return this.destination;
|
|
56
57
|
}
|
|
57
58
|
async write() {
|
|
58
|
-
await
|
|
59
|
+
await mkdirp((0, path_1.dirname)(this.destination));
|
|
59
60
|
const output = await this.transformToDitamap();
|
|
60
61
|
await fs.writeFile(this.destination, output);
|
|
61
62
|
}
|
|
62
|
-
// eslint-disable-next-line class-methods-use-this
|
|
63
63
|
formatParagraphs(textToFormat) {
|
|
64
64
|
return textToFormat ? textToFormat.split('\n').filter((n) => n !== '') : [];
|
|
65
65
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ditamap.js","sourceRoot":"","sources":["../../src/ditamap/ditamap.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,+BAAqC;AACrC,kCAAkC;AAClC,sCAAsC;AACtC,iCAAiC;
|
|
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;IAgBpB,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;IAQD,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;IAIM,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"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"help-reference.js","sourceRoot":"","sources":["../../src/ditamap/help-reference.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,uCAAoC;AAEpC,MAAa,aAAc,SAAQ,iBAAO;IACxC;QACE,sCAAsC;QACtC,MAAM,QAAQ,GAAG,iBAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,KAAK,CAAC,CAAC;QAC3D,KAAK,CAAC,QAAQ,EAAE;YACd,EAAE,EAAE,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;SACjC,CAAC,CAAC;IACL,CAAC;
|
|
1
|
+
{"version":3,"file":"help-reference.js","sourceRoot":"","sources":["../../src/ditamap/help-reference.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,uCAAoC;AAEpC,MAAa,aAAc,SAAQ,iBAAO;IACxC;QACE,sCAAsC;QACtC,MAAM,QAAQ,GAAG,iBAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,KAAK,CAAC,CAAC;QAC3D,KAAK,CAAC,QAAQ,EAAE;YACd,EAAE,EAAE,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;SACjC,CAAC,CAAC;IACL,CAAC;IAEM,mBAAmB;QACxB,OAAO,wBAAwB,CAAC;IAClC,CAAC;CACF;AAZD,sCAYC"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
|
+
import { JsonMap } from '@salesforce/ts-types';
|
|
1
2
|
import { Ditamap } from './ditamap';
|
|
2
3
|
export declare class MainTopicIntro extends Ditamap {
|
|
3
|
-
constructor(topic: string, subtopic: string, subTopicMeta:
|
|
4
|
+
constructor(topic: string, subtopic: string, subTopicMeta: JsonMap);
|
|
4
5
|
getTemplateFileName(): string;
|
|
5
6
|
}
|
|
@@ -17,9 +17,9 @@ class MainTopicIntro extends ditamap_1.Ditamap {
|
|
|
17
17
|
let trailblazerCommunityUrl;
|
|
18
18
|
let trailblazerCommunityName;
|
|
19
19
|
if (subTopicMeta.trailblazerCommunityLink) {
|
|
20
|
-
const community = (0, ts_types_1.
|
|
21
|
-
trailblazerCommunityUrl = community.url
|
|
22
|
-
trailblazerCommunityName = community.name
|
|
20
|
+
const community = (0, ts_types_1.ensureJsonMap)(subTopicMeta.trailblazerCommunityLink);
|
|
21
|
+
trailblazerCommunityUrl = community.url;
|
|
22
|
+
trailblazerCommunityName = community.name;
|
|
23
23
|
}
|
|
24
24
|
if (!subTopicMeta.longDescription && !subTopicMeta.external) {
|
|
25
25
|
subTopicMeta.longDescription = (0, utils_1.punctuate)((0, ts_types_1.asString)(subTopicMeta.description));
|
|
@@ -35,7 +35,6 @@ class MainTopicIntro extends ditamap_1.Ditamap {
|
|
|
35
35
|
});
|
|
36
36
|
this.destination = (0, path_1.join)(ditamap_1.Ditamap.outputDir, topic, filename);
|
|
37
37
|
}
|
|
38
|
-
// eslint-disable-next-line class-methods-use-this
|
|
39
38
|
getTemplateFileName() {
|
|
40
39
|
return 'main_topic_intro.hbs';
|
|
41
40
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"main-topic-intro.js","sourceRoot":"","sources":["../../src/ditamap/main-topic-intro.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,+BAA4B;AAC5B,
|
|
1
|
+
{"version":3,"file":"main-topic-intro.js","sourceRoot":"","sources":["../../src/ditamap/main-topic-intro.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,+BAA4B;AAC5B,mDAAiF;AACjF,oCAAqC;AACrC,uCAAoC;AAEpC,MAAa,cAAe,SAAQ,iBAAO;IACzC,YAAmB,KAAa,EAAE,QAAgB,EAAE,YAAqB;QACvE,MAAM,QAAQ,GAAG,iBAAO,CAAC,IAAI,CAAC,iBAAiB,KAAK,IAAI,QAAQ,EAAE,EAAE,KAAK,CAAC,CAAC;QAE3E,IAAI,uBAAgC,CAAC;QACrC,IAAI,wBAAiC,CAAC;QACtC,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,IAAI,CAAC,WAAW,GAAG,IAAA,WAAI,EAAC,iBAAO,CAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC9D,CAAC;IAEM,mBAAmB;QACxB,OAAO,sBAAsB,CAAC;IAChC,CAAC;CACF;AAhCD,wCAgCC"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
|
+
import { JsonMap } from '@salesforce/ts-types';
|
|
1
2
|
import { Ditamap } from './ditamap';
|
|
2
3
|
export declare class TopicCommands extends Ditamap {
|
|
3
|
-
constructor(topic: string, topicMeta:
|
|
4
|
+
constructor(topic: string, topicMeta: JsonMap);
|
|
4
5
|
getTemplateFileName(): string;
|
|
5
6
|
}
|
|
@@ -17,7 +17,6 @@ class TopicCommands extends ditamap_1.Ditamap {
|
|
|
17
17
|
// Override destination to include topic and subtopic
|
|
18
18
|
this.destination = (0, path_1.join)(ditamap_1.Ditamap.outputDir, topic, filename);
|
|
19
19
|
}
|
|
20
|
-
// eslint-disable-next-line class-methods-use-this
|
|
21
20
|
getTemplateFileName() {
|
|
22
21
|
return 'cli_reference_topic_commands.hbs';
|
|
23
22
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"topic-commands.js","sourceRoot":"","sources":["../../src/ditamap/topic-commands.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,+BAA4B;
|
|
1
|
+
{"version":3,"file":"topic-commands.js","sourceRoot":"","sources":["../../src/ditamap/topic-commands.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,+BAA4B;AAE5B,uCAAoC;AAEpC,MAAa,aAAc,SAAQ,iBAAO;IACxC,YAAmB,KAAa,EAAE,SAAkB;QAClD,MAAM,QAAQ,GAAG,iBAAO,CAAC,IAAI,CAAC,iBAAiB,KAAK,WAAW,EAAE,KAAK,CAAC,CAAC;QACxE,sCAAsC;QACtC,KAAK,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QAE3B,qDAAqD;QACrD,IAAI,CAAC,WAAW,GAAG,IAAA,WAAI,EAAC,iBAAO,CAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC9D,CAAC;IAEM,mBAAmB;QACxB,OAAO,kCAAkC,CAAC;IAC5C,CAAC;CACF;AAbD,sCAaC"}
|
|
@@ -18,7 +18,6 @@ class TopicDitamap extends ditamap_1.Ditamap {
|
|
|
18
18
|
// Override destination to include topic and subtopic
|
|
19
19
|
this.destination = (0, path_1.join)(ditamap_1.Ditamap.outputDir, topic, filename);
|
|
20
20
|
}
|
|
21
|
-
// eslint-disable-next-line class-methods-use-this
|
|
22
21
|
getTemplateFileName() {
|
|
23
22
|
return 'topic_ditamap.hbs';
|
|
24
23
|
}
|
|
@@ -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,UAAoB;QACpD,MAAM,QAAQ,GAAG,iBAAO,CAAC,IAAI,CAAC,iBAAiB,KAAK,EAAE,EAAE,SAAS,CAAC,CAAC;QACnE,sCAAsC;QACtC,MAAM,QAAQ,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;QACnF,KAAK,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;QAErC,qDAAqD;QACrD,IAAI,CAAC,WAAW,GAAG,IAAA,WAAI,EAAC,iBAAO,CAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC9D,CAAC;
|
|
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,UAAoB;QACpD,MAAM,QAAQ,GAAG,iBAAO,CAAC,IAAI,CAAC,iBAAiB,KAAK,EAAE,EAAE,SAAS,CAAC,CAAC;QACnE,sCAAsC;QACtC,MAAM,QAAQ,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;QACnF,KAAK,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;QAErC,qDAAqD;QACrD,IAAI,CAAC,WAAW,GAAG,IAAA,WAAI,EAAC,iBAAO,CAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC9D,CAAC;IAEM,mBAAmB;QACxB,OAAO,mBAAmB,CAAC;IAC7B,CAAC;CACF;AAdD,oCAcC"}
|
package/lib/docs.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { Dictionary, JsonMap } from '@salesforce/ts-types';
|
|
2
2
|
import { CommandClass } from './utils';
|
|
3
3
|
export declare class Docs {
|
|
4
4
|
private outputDir;
|
|
@@ -6,9 +6,9 @@ export declare class Docs {
|
|
|
6
6
|
private hidden;
|
|
7
7
|
private topicMeta;
|
|
8
8
|
private cliMeta;
|
|
9
|
-
constructor(outputDir: string, plugins:
|
|
9
|
+
constructor(outputDir: string, plugins: JsonMap, hidden: boolean, topicMeta: JsonMap, cliMeta: JsonMap);
|
|
10
10
|
build(commands: CommandClass[]): Promise<void>;
|
|
11
|
-
populateTopic(topic: string, subtopics: Dictionary<CommandClass | CommandClass[]>): Promise<
|
|
11
|
+
populateTopic(topic: string, subtopics: Dictionary<CommandClass | CommandClass[]>): Promise<any[]>;
|
|
12
12
|
/**
|
|
13
13
|
* Group all commands by the top level topic and then subtopic. e.g. force, analytics, evergreen, etc
|
|
14
14
|
* then org, apex, etc within the force namespace.
|
package/lib/docs.js
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
*/
|
|
8
8
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
9
|
exports.Docs = void 0;
|
|
10
|
-
const
|
|
10
|
+
const mkdirp = require("mkdirp");
|
|
11
11
|
const ts_types_1 = require("@salesforce/ts-types");
|
|
12
12
|
const chalk = require("chalk");
|
|
13
13
|
const base_ditamap_1 = require("./ditamap/base-ditamap");
|
|
@@ -30,21 +30,17 @@ class Docs {
|
|
|
30
30
|
}
|
|
31
31
|
async build(commands) {
|
|
32
32
|
// Create if doesn't exist
|
|
33
|
-
await
|
|
33
|
+
await mkdirp(this.outputDir);
|
|
34
34
|
await this.populateTemplate(commands);
|
|
35
35
|
}
|
|
36
36
|
async populateTopic(topic, subtopics) {
|
|
37
|
-
|
|
38
|
-
throw new Error(`No topic meta for ${topic} - add this topic to the oclif section of the package.json.`);
|
|
39
|
-
}
|
|
40
|
-
const topicMeta = (this.topicMeta[topic] ?? {});
|
|
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.`);
|
|
41
38
|
let description = (0, ts_types_1.asString)(topicMeta.description);
|
|
42
39
|
if (!description && !topicMeta.external) {
|
|
43
|
-
// TODO: check why the same property is used again when it is already used above
|
|
44
40
|
description = (0, utils_1.punctuate)((0, ts_types_1.asString)(topicMeta.description));
|
|
45
41
|
if (!description) {
|
|
46
42
|
utils_1.events.emit('warning', `No description for topic ${chalk.bold(topic)}. Skipping until topic owner adds topic metadata in the oclif section in the package.json file within their plugin.`);
|
|
47
|
-
return
|
|
43
|
+
return;
|
|
48
44
|
}
|
|
49
45
|
}
|
|
50
46
|
const subTopicNames = [];
|
|
@@ -58,12 +54,11 @@ class Docs {
|
|
|
58
54
|
// If it is not subtopic (array) it is a command in the top-level topic
|
|
59
55
|
const command = Object.assign({}, subtopicOrCommand);
|
|
60
56
|
const commandMeta = this.resolveCommandMeta((0, ts_types_1.ensureString)(command.id), command, 1);
|
|
61
|
-
// eslint-disable-next-line no-await-in-loop
|
|
62
57
|
await this.populateCommand(topic, null, command, commandMeta);
|
|
63
58
|
commandIds.push(command.id);
|
|
64
59
|
continue;
|
|
65
60
|
}
|
|
66
|
-
const subTopicsMeta = (0, ts_types_1.
|
|
61
|
+
const subTopicsMeta = (0, ts_types_1.ensureJsonMap)(topicMeta.subtopics);
|
|
67
62
|
if (!subTopicsMeta[subtopic]) {
|
|
68
63
|
emitNoTopicMetadataWarning(`${topic}:${subtopic}`);
|
|
69
64
|
continue;
|
|
@@ -72,20 +67,18 @@ class Docs {
|
|
|
72
67
|
// Commands within the sub topic
|
|
73
68
|
for (const command of subtopicOrCommand) {
|
|
74
69
|
const fullTopic = (0, ts_types_1.ensureString)(command.id).replace(/:\w+$/, '');
|
|
75
|
-
const commandsInFullTopic = subtopicOrCommand.filter((cmd) => (0, ts_types_1.ensureString)(cmd.id).
|
|
70
|
+
const commandsInFullTopic = subtopicOrCommand.filter((cmd) => (0, ts_types_1.ensureString)(cmd.id).indexOf(fullTopic) === 0);
|
|
76
71
|
const commandMeta = this.resolveCommandMeta((0, ts_types_1.ensureString)(command.id), command, commandsInFullTopic.length);
|
|
77
|
-
// eslint-disable-next-line no-await-in-loop
|
|
78
72
|
await this.populateCommand(topic, subtopic, command, commandMeta);
|
|
79
73
|
commandIds.push(command.id);
|
|
80
74
|
}
|
|
81
75
|
}
|
|
82
76
|
catch (error) {
|
|
83
|
-
|
|
84
|
-
if (err.name === 'UnexpectedValueTypeError') {
|
|
77
|
+
if (error.name === 'UnexpectedValueTypeError') {
|
|
85
78
|
emitNoTopicMetadataWarning(`${topic}:${subtopic}`);
|
|
86
79
|
}
|
|
87
80
|
else {
|
|
88
|
-
utils_1.events.emit('warning', `Can't create topic for ${topic}:${subtopic}: ${
|
|
81
|
+
utils_1.events.emit('warning', `Can't create topic for ${topic}:${subtopic}: ${error.message}\n`);
|
|
89
82
|
}
|
|
90
83
|
}
|
|
91
84
|
}
|
|
@@ -114,7 +107,7 @@ class Docs {
|
|
|
114
107
|
if (plugin && this.plugins[plugin.name]) {
|
|
115
108
|
// Also include the namespace on the commands so we don't need to do the split at other times in the code.
|
|
116
109
|
command.topic = topLevelTopic;
|
|
117
|
-
const topics = topLevelTopics[topLevelTopic]
|
|
110
|
+
const topics = topLevelTopics[topLevelTopic] || {};
|
|
118
111
|
if (commandParts.length === 1) {
|
|
119
112
|
// This is a top-level topic that is also a command
|
|
120
113
|
topics[commandParts[0]] = command;
|
|
@@ -126,20 +119,18 @@ class Docs {
|
|
|
126
119
|
else {
|
|
127
120
|
const subtopic = commandParts[1];
|
|
128
121
|
try {
|
|
129
|
-
const topicMeta = (0, ts_types_1.
|
|
130
|
-
const subTopicsMeta = (0, ts_types_1.
|
|
122
|
+
const topicMeta = (0, ts_types_1.ensureJsonMap)(this.topicMeta[topLevelTopic]);
|
|
123
|
+
const subTopicsMeta = (0, ts_types_1.ensureJsonMap)(topicMeta.subtopics);
|
|
131
124
|
if (subTopicsMeta.hidden && !this.hidden) {
|
|
132
125
|
continue;
|
|
133
126
|
}
|
|
134
127
|
}
|
|
135
|
-
catch (e) {
|
|
136
|
-
// It means no meta so it isn't hidden, although it should always fail before here with no meta found
|
|
137
|
-
}
|
|
128
|
+
catch (e) { } // It means no meta so it isn't hidden, although it should always fail before here with no meta found
|
|
138
129
|
command.subtopic = subtopic;
|
|
139
130
|
const existingSubTopics = topics[subtopic];
|
|
140
131
|
let subtopicCommands = [];
|
|
141
132
|
if (existingSubTopics) {
|
|
142
|
-
subtopicCommands = (0, ts_types_1.
|
|
133
|
+
subtopicCommands = (0, ts_types_1.isArray)(existingSubTopics) ? existingSubTopics : [existingSubTopics];
|
|
143
134
|
}
|
|
144
135
|
(0, ts_types_1.ensureArray)(subtopicCommands);
|
|
145
136
|
subtopicCommands.push(command);
|
|
@@ -160,7 +151,6 @@ class Docs {
|
|
|
160
151
|
for (const topic of topics) {
|
|
161
152
|
utils_1.events.emit('topic', { topic });
|
|
162
153
|
const subtopics = (0, ts_types_1.ensure)(topicsAndSubtopics[topic]);
|
|
163
|
-
// eslint-disable-next-line no-await-in-loop
|
|
164
154
|
await this.populateTopic(topic, subtopics);
|
|
165
155
|
}
|
|
166
156
|
}
|
|
@@ -173,28 +163,32 @@ class Docs {
|
|
|
173
163
|
let currentMeta;
|
|
174
164
|
for (part of commandParts) {
|
|
175
165
|
if (currentMeta) {
|
|
176
|
-
const subtopics = (0, ts_types_1.
|
|
177
|
-
currentMeta = (0, ts_types_1.
|
|
166
|
+
const subtopics = (0, ts_types_1.ensureJsonMap)(currentMeta.subtopics);
|
|
167
|
+
currentMeta = (0, ts_types_1.ensureJsonMap)(subtopics[part]);
|
|
178
168
|
}
|
|
179
169
|
else {
|
|
180
|
-
currentMeta = (0, ts_types_1.
|
|
170
|
+
currentMeta = (0, ts_types_1.ensureJsonMap)(this.topicMeta[part]);
|
|
181
171
|
}
|
|
182
172
|
// Collect all tiers of the meta, so the command will also pick up the topic state (isPilot, etc) if applicable
|
|
183
173
|
Object.assign({}, commandMeta, currentMeta);
|
|
184
174
|
}
|
|
185
175
|
}
|
|
186
176
|
catch (error) {
|
|
187
|
-
// @ts-expect-error: part may be undefined
|
|
188
177
|
if (commandId.endsWith(part)) {
|
|
189
178
|
// This means there wasn't meta information going all the way down to the command, which is ok.
|
|
190
179
|
return commandMeta;
|
|
191
180
|
}
|
|
192
|
-
else
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
181
|
+
else {
|
|
182
|
+
if (commandsInTopic !== 1) {
|
|
183
|
+
utils_1.events.emit('warning', `subtopic "${part}" meta not found for command ${commandId}`);
|
|
184
|
+
}
|
|
185
|
+
else {
|
|
186
|
+
// Since there is no command meta, just use the command description since that is what oclif does.
|
|
187
|
+
if (!commandMeta.description) {
|
|
188
|
+
commandMeta.description = command.description;
|
|
189
|
+
commandMeta.longDescription = command.longDescription || (0, utils_1.punctuate)(command.description);
|
|
190
|
+
}
|
|
191
|
+
}
|
|
198
192
|
}
|
|
199
193
|
}
|
|
200
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,
|
|
1
|
+
{"version":3,"file":"docs.js","sourceRoot":"","sources":["../src/docs.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,iCAAiC;AACjC,mDAS8B;AAC9B,+BAA+B;AAC/B,yDAAqD;AACrD,2DAAuD;AACvD,+CAA4C;AAC5C,6DAAyD;AACzD,2DAAuD;AACvD,mCAA0D;AAC1D,6DAAyD;AAEzD,SAAS,0BAA0B,CAAC,KAAa;IAC/C,cAAM,CAAC,IAAI,CACT,SAAS,EACT,yBAAyB,KAAK,CAAC,IAAI,CACjC,KAAK,CACN,+GAA+G,CACjH,CAAC;AACJ,CAAC;AAED,MAAa,IAAI;IACf,YACU,SAAiB,EACjB,OAAgB,EAChB,MAAe,EACf,SAAkB,EAClB,OAAgB;QAJhB,cAAS,GAAT,SAAS,CAAQ;QACjB,YAAO,GAAP,OAAO,CAAS;QAChB,WAAM,GAAN,MAAM,CAAS;QACf,cAAS,GAAT,SAAS,CAAS;QAClB,YAAO,GAAP,OAAO,CAAS;IACvB,CAAC;IAEG,KAAK,CAAC,KAAK,CAAC,QAAwB;QACzC,0BAA0B;QAC1B,MAAM,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAE7B,MAAM,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IACxC,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,KAAa,EAAE,SAAoD;QAC5F,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,WAAW,CAAC,CAAC;QAClD,IAAI,CAAC,WAAW,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE;YACvC,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,qHAAqH,CACvH,CAAC;gBACF,OAAO;aACR;SACF;QAED,MAAM,aAAa,GAAG,EAAE,CAAC;QACzB,MAAM,UAAU,GAAG,EAAE,CAAC;QAEtB,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;YAC7C,MAAM,iBAAiB,GAAG,IAAA,kBAAO,EAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;gBACpD,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC;gBACxC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;YAE3C,IAAI;gBACF,IAAI,CAAC,IAAA,kBAAO,EAAC,iBAAiB,CAAC,EAAE;oBAC/B,uEAAuE;oBACvE,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,iBAAiB,CAAC,CAAC;oBACrD,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAA,uBAAY,EAAC,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,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,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,0BAA0B,CAAC,GAAG,KAAK,IAAI,QAAQ,EAAE,CAAC,CAAC;oBACnD,SAAS;iBACV;gBAED,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAE7B,gCAAgC;gBAChC,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,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;oBAC7G,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAA,uBAAY,EAAC,OAAO,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,mBAAmB,CAAC,MAAM,CAAC,CAAC;oBAE3G,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;oBAClE,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;iBAC7B;aACF;YAAC,OAAO,KAAK,EAAE;gBACd,IAAI,KAAK,CAAC,IAAI,KAAK,0BAA0B,EAAE;oBAC7C,0BAA0B,CAAC,GAAG,KAAK,IAAI,QAAQ,EAAE,CAAC,CAAC;iBACpD;qBAAM;oBACL,cAAM,CAAC,IAAI,CAAC,SAAS,EAAE,0BAA0B,KAAK,IAAI,QAAQ,KAAK,KAAK,CAAC,OAAO,IAAI,CAAC,CAAC;iBAC3F;aACF;SACF;QAED,oDAAoD;QACpD,cAAM,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,EAAE,aAAa,CAAC,CAAC;QAE/C,MAAM,IAAI,8BAAa,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC,KAAK,EAAE,CAAC;QAClD,MAAM,IAAI,4BAAY,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC,KAAK,EAAE,CAAC;QAClD,OAAO,aAAa,CAAC;IACvB,CAAC;IAED;;;;;;OAMG;IACK,uBAAuB,CAAC,QAAwB;QACtD,MAAM,cAAc,GAA0D,EAAE,CAAC;QAEjF,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,MAAM,aAAa,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;YAEtC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;YAC9B,IAAI,MAAM,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;gBACvC,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,mDAAmD;oBACnD,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC;iBACnC;qBAAM,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE;oBACpC,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,GAAE,CAAC,qGAAqG;oBAEpH,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;oBAE5B,MAAM,iBAAiB,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;oBAC3C,IAAI,gBAAgB,GAAG,EAAE,CAAC;oBAC1B,IAAI,iBAAiB,EAAE;wBACrB,gBAAgB,GAAG,IAAA,kBAAO,EAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC;qBACzF;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,QAAwB;QACrD,MAAM,kBAAkB,GAAG,IAAI,CAAC,uBAAuB,CAAC,QAAQ,CAAC,CAAC;QAElE,MAAM,IAAI,4BAAY,EAAE,CAAC,KAAK,EAAE,CAAC;QACjC,MAAM,IAAI,8BAAa,EAAE,CAAC,KAAK,EAAE,CAAC;QAElC,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,IAAA,iBAAM,EAAC,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,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACpD,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,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,EAAE,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC;aAC7C;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,IAAA,iBAAS,EAAC,OAAO,CAAC,WAAW,CAAC,CAAC;qBACzF;iBACF;aACF;SACF;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;IAEO,KAAK,CAAC,eAAe,CAAC,KAAa,EAAE,QAAgB,EAAE,OAAqB,EAAE,WAAoB;QACxG,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;AApND,oBAoNC"}
|
package/lib/utils.d.ts
CHANGED
|
@@ -1,10 +1,12 @@
|
|
|
1
1
|
/// <reference types="node" />
|
|
2
2
|
import { EventEmitter } from 'events';
|
|
3
|
+
import { Dictionary, JsonMap } from '@salesforce/ts-types';
|
|
3
4
|
import { Command } from '@oclif/core';
|
|
4
5
|
export type CommandClass = Command.Class & {
|
|
5
6
|
topic: string;
|
|
6
7
|
subtopic: string;
|
|
7
|
-
} &
|
|
8
|
+
} & JsonMap;
|
|
8
9
|
export declare const events: EventEmitter;
|
|
9
|
-
export declare function
|
|
10
|
+
export declare function mergeDeep(target: Dictionary, source: Dictionary): Dictionary;
|
|
11
|
+
export declare function punctuate(description: string): string;
|
|
10
12
|
export declare function helpFromDescription(description: string): string;
|
package/lib/utils.js
CHANGED
|
@@ -6,17 +6,30 @@
|
|
|
6
6
|
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
7
7
|
*/
|
|
8
8
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
|
-
exports.helpFromDescription = exports.punctuate = exports.events = void 0;
|
|
9
|
+
exports.helpFromDescription = exports.punctuate = exports.mergeDeep = exports.events = void 0;
|
|
10
10
|
const events_1 = require("events");
|
|
11
11
|
const os_1 = require("os");
|
|
12
|
+
const ts_types_1 = require("@salesforce/ts-types");
|
|
12
13
|
exports.events = new events_1.EventEmitter();
|
|
14
|
+
function mergeDeep(target, source) {
|
|
15
|
+
Object.keys(source).forEach((key) => {
|
|
16
|
+
if ((0, ts_types_1.isObject)(target[key]) && (0, ts_types_1.isObject)(source[key])) {
|
|
17
|
+
mergeDeep(target[key], source[key]);
|
|
18
|
+
}
|
|
19
|
+
else {
|
|
20
|
+
target[key] = source[key];
|
|
21
|
+
}
|
|
22
|
+
});
|
|
23
|
+
return target;
|
|
24
|
+
}
|
|
25
|
+
exports.mergeDeep = mergeDeep;
|
|
13
26
|
function punctuate(description) {
|
|
14
27
|
if (!description)
|
|
15
28
|
return description;
|
|
16
29
|
const lines = description.split(os_1.EOL);
|
|
17
30
|
let mainDescription = lines[0];
|
|
18
31
|
mainDescription = mainDescription.charAt(0).toUpperCase() + mainDescription.substring(1);
|
|
19
|
-
if (
|
|
32
|
+
if (mainDescription.charAt(mainDescription.length - 1) !== '.') {
|
|
20
33
|
mainDescription += '.';
|
|
21
34
|
}
|
|
22
35
|
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;;;AAEH,mCAAsC;AACtC,2BAAyB;
|
|
1
|
+
{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,mCAAsC;AACtC,2BAAyB;AACzB,mDAAqE;AAKxD,QAAA,MAAM,GAAG,IAAI,qBAAY,EAAE,CAAC;AAEzC,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,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
package/package.json
CHANGED
|
@@ -1,52 +1,52 @@
|
|
|
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.4",
|
|
5
5
|
"author": "Salesforce",
|
|
6
6
|
"bugs": "https://github.com/salesforcecli/plugin-command-reference/issues",
|
|
7
7
|
"dependencies": {
|
|
8
|
-
"@oclif/core": "^2.
|
|
9
|
-
"@salesforce/core": "^3.
|
|
10
|
-
"@salesforce/kit": "^1.
|
|
11
|
-
"@salesforce/sf-plugins-core": "^2.
|
|
8
|
+
"@oclif/core": "^2.0.7",
|
|
9
|
+
"@salesforce/core": "^3.32.12",
|
|
10
|
+
"@salesforce/kit": "^1.8.2",
|
|
11
|
+
"@salesforce/sf-plugins-core": "^2.0.1",
|
|
12
12
|
"@salesforce/ts-types": "^1.7.1",
|
|
13
13
|
"chalk": "^3.0.0",
|
|
14
|
+
"fs-extra": "^10.0.1",
|
|
14
15
|
"handlebars": "^4.7.7",
|
|
15
16
|
"lodash.uniqby": "^4.7.0",
|
|
16
17
|
"mkdirp": "^1.0.4",
|
|
17
18
|
"tslib": "^2"
|
|
18
19
|
},
|
|
19
20
|
"devDependencies": {
|
|
20
|
-
"@oclif/plugin-help": "^5.
|
|
21
|
+
"@oclif/plugin-help": "^5.1.1",
|
|
21
22
|
"@salesforce/dev-config": "^3.1.0",
|
|
22
|
-
"@salesforce/dev-scripts": "^
|
|
23
|
-
"@salesforce/plugin-
|
|
23
|
+
"@salesforce/dev-scripts": "^2.0.4",
|
|
24
|
+
"@salesforce/plugin-login": "^1.1.15",
|
|
24
25
|
"@salesforce/prettier-config": "^0.0.2",
|
|
25
|
-
"@types/debug": "^4.1.7",
|
|
26
26
|
"@types/fs-extra": "^9.0.13",
|
|
27
27
|
"@types/lodash.uniqby": "^4.7.6",
|
|
28
|
-
"@typescript-eslint/eslint-plugin": "^
|
|
29
|
-
"@typescript-eslint/parser": "^
|
|
28
|
+
"@typescript-eslint/eslint-plugin": "^4.2.0",
|
|
29
|
+
"@typescript-eslint/parser": "^4.2.0",
|
|
30
30
|
"chai": "^4.2.0",
|
|
31
|
-
"eslint": "^
|
|
32
|
-
"eslint-config-prettier": "^
|
|
33
|
-
"eslint-config-salesforce": "^1.
|
|
34
|
-
"eslint-config-salesforce-license": "^0.
|
|
35
|
-
"eslint-config-salesforce-typescript": "^
|
|
31
|
+
"eslint": "^7.27.0",
|
|
32
|
+
"eslint-config-prettier": "^6.11.0",
|
|
33
|
+
"eslint-config-salesforce": "^0.1.6",
|
|
34
|
+
"eslint-config-salesforce-license": "^0.1.6",
|
|
35
|
+
"eslint-config-salesforce-typescript": "^0.2.8",
|
|
36
36
|
"eslint-plugin-header": "^3.0.0",
|
|
37
|
-
"eslint-plugin-import": "
|
|
38
|
-
"eslint-plugin-jsdoc": "^
|
|
37
|
+
"eslint-plugin-import": "2.24.2",
|
|
38
|
+
"eslint-plugin-jsdoc": "^35.1.2",
|
|
39
|
+
"eslint-plugin-prettier": "^3.1.3",
|
|
39
40
|
"husky": "^7.0.4",
|
|
40
|
-
"mocha": "^
|
|
41
|
+
"mocha": "^9.1.3",
|
|
41
42
|
"nyc": "^15.1.0",
|
|
42
|
-
"oclif": "^3.
|
|
43
|
-
"prettier": "^2.
|
|
43
|
+
"oclif": "^3.6.1",
|
|
44
|
+
"prettier": "^2.0.5",
|
|
44
45
|
"pretty-quick": "^3.1.0",
|
|
45
46
|
"shx": "^0.3.3",
|
|
46
47
|
"sinon": "10.0.0",
|
|
47
48
|
"ts-node": "^10.0.0",
|
|
48
|
-
"typescript": "^4.
|
|
49
|
-
"wireit": "^0.9.5"
|
|
49
|
+
"typescript": "^4.1.3"
|
|
50
50
|
},
|
|
51
51
|
"engines": {
|
|
52
52
|
"node": ">=14.0.0"
|
|
@@ -78,134 +78,30 @@
|
|
|
78
78
|
},
|
|
79
79
|
"devPlugins": [
|
|
80
80
|
"@oclif/plugin-help",
|
|
81
|
-
"@salesforce/plugin-
|
|
81
|
+
"@salesforce/plugin-login"
|
|
82
82
|
]
|
|
83
83
|
},
|
|
84
84
|
"repository": "salesforcecli/plugin-command-reference",
|
|
85
85
|
"scripts": {
|
|
86
|
-
"build": "
|
|
86
|
+
"build": "sf-build",
|
|
87
87
|
"clean": "sf-clean",
|
|
88
88
|
"clean-all": "sf-clean all",
|
|
89
|
-
"clean:lib": "shx rm -rf lib && shx rm -rf coverage && shx rm -rf .nyc_output && shx rm -
|
|
90
|
-
"
|
|
89
|
+
"clean:lib": "shx rm -rf lib && shx rm -rf coverage && shx rm -rf .nyc_output && shx rm -f oclif.manifest.json",
|
|
90
|
+
"command-reference": "./bin/dev commandreference:generate --plugins login --outputdir test/tmp",
|
|
91
|
+
"compile": "sf-compile",
|
|
91
92
|
"docs": "sf-docs",
|
|
92
|
-
"format": "
|
|
93
|
-
"lint": "
|
|
93
|
+
"format": "sf-format",
|
|
94
|
+
"lint": "sf-lint",
|
|
94
95
|
"postpack": "shx rm -f oclif.manifest.json",
|
|
96
|
+
"posttest": "yarn lint",
|
|
95
97
|
"prepack": "sf-prepack",
|
|
96
98
|
"prepare": "sf-install",
|
|
97
|
-
"
|
|
98
|
-
"test
|
|
99
|
+
"pretest": "sf-compile-test && yarn command-reference",
|
|
100
|
+
"test": "sf-test",
|
|
99
101
|
"version": "oclif readme"
|
|
100
102
|
},
|
|
101
103
|
"publishConfig": {
|
|
102
104
|
"access": "public"
|
|
103
105
|
},
|
|
104
|
-
"main": "lib/index.js"
|
|
105
|
-
"wireit": {
|
|
106
|
-
"build": {
|
|
107
|
-
"dependencies": [
|
|
108
|
-
"compile",
|
|
109
|
-
"lint"
|
|
110
|
-
]
|
|
111
|
-
},
|
|
112
|
-
"compile": {
|
|
113
|
-
"command": "tsc -p . --pretty --incremental",
|
|
114
|
-
"files": [
|
|
115
|
-
"src/**/*.ts",
|
|
116
|
-
"**/tsconfig.json",
|
|
117
|
-
"messages/**"
|
|
118
|
-
],
|
|
119
|
-
"output": [
|
|
120
|
-
"lib/**",
|
|
121
|
-
"*.tsbuildinfo"
|
|
122
|
-
],
|
|
123
|
-
"clean": "if-file-deleted"
|
|
124
|
-
},
|
|
125
|
-
"format": {
|
|
126
|
-
"command": "prettier --write \"+(src|test|schemas)/**/*.+(ts|js|json)|command-snapshot.json\"",
|
|
127
|
-
"files": [
|
|
128
|
-
"src/**/*.ts",
|
|
129
|
-
"test/**/*.ts",
|
|
130
|
-
"schemas/**/*.json",
|
|
131
|
-
"command-snapshot.json",
|
|
132
|
-
".prettier*"
|
|
133
|
-
],
|
|
134
|
-
"output": []
|
|
135
|
-
},
|
|
136
|
-
"lint": {
|
|
137
|
-
"command": "eslint src test --color --cache --cache-location .eslintcache",
|
|
138
|
-
"files": [
|
|
139
|
-
"src/**/*.ts",
|
|
140
|
-
"test/**/*.ts",
|
|
141
|
-
"messages/**",
|
|
142
|
-
"**/.eslint*",
|
|
143
|
-
"**/tsconfig.json"
|
|
144
|
-
],
|
|
145
|
-
"output": []
|
|
146
|
-
},
|
|
147
|
-
"test:compile": {
|
|
148
|
-
"command": "tsc -p \"./test\" --pretty",
|
|
149
|
-
"files": [
|
|
150
|
-
"test/**/*.ts",
|
|
151
|
-
"**/tsconfig.json"
|
|
152
|
-
],
|
|
153
|
-
"output": []
|
|
154
|
-
},
|
|
155
|
-
"test": {
|
|
156
|
-
"dependencies": [
|
|
157
|
-
"test:only",
|
|
158
|
-
"lint"
|
|
159
|
-
]
|
|
160
|
-
},
|
|
161
|
-
"test:only": {
|
|
162
|
-
"command": "nyc mocha \"test/**/*.test.ts\"",
|
|
163
|
-
"env": {
|
|
164
|
-
"FORCE_COLOR": "2"
|
|
165
|
-
},
|
|
166
|
-
"dependencies": [
|
|
167
|
-
"test:compile",
|
|
168
|
-
"test:command-reference"
|
|
169
|
-
],
|
|
170
|
-
"files": [
|
|
171
|
-
"test/**/*.ts",
|
|
172
|
-
"src/**/*.ts",
|
|
173
|
-
"**/tsconfig.json",
|
|
174
|
-
".mocha*",
|
|
175
|
-
"!*.nut.ts",
|
|
176
|
-
".nycrc",
|
|
177
|
-
"tmp/test/**"
|
|
178
|
-
],
|
|
179
|
-
"output": []
|
|
180
|
-
},
|
|
181
|
-
"test:command-reference": {
|
|
182
|
-
"command": "\"./bin/dev\" commandreference:generate --plugins auth --outputdir ./tmp/test",
|
|
183
|
-
"files": [
|
|
184
|
-
"src/**/*.ts",
|
|
185
|
-
"messages/**",
|
|
186
|
-
"package.json"
|
|
187
|
-
],
|
|
188
|
-
"output": [
|
|
189
|
-
"tmp/test/**"
|
|
190
|
-
]
|
|
191
|
-
},
|
|
192
|
-
"test:deprecation-policy": {
|
|
193
|
-
"command": "\"./bin/dev\" snapshot:compare",
|
|
194
|
-
"files": [
|
|
195
|
-
"src/**/*.ts"
|
|
196
|
-
],
|
|
197
|
-
"output": [],
|
|
198
|
-
"dependencies": [
|
|
199
|
-
"compile"
|
|
200
|
-
]
|
|
201
|
-
},
|
|
202
|
-
"test:json-schema": {
|
|
203
|
-
"command": "\"./bin/dev\" schema:compare",
|
|
204
|
-
"files": [
|
|
205
|
-
"src/**/*.ts",
|
|
206
|
-
"schemas"
|
|
207
|
-
],
|
|
208
|
-
"output": []
|
|
209
|
-
}
|
|
210
|
-
}
|
|
106
|
+
"main": "lib/index.js"
|
|
211
107
|
}
|