@salesforce/plugin-command-reference 3.0.46 → 3.0.47
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/README.md
CHANGED
|
@@ -100,8 +100,8 @@ FLAGS
|
|
|
100
100
|
-p, --plugins=<value>... comma separated list of plugin names to be part of the generation. Defaults to the oclif
|
|
101
101
|
plugin in the current working directory
|
|
102
102
|
-s, --ditamap-suffix=<value> [default: unified] unique suffix to append to generated ditamap
|
|
103
|
-
|
|
104
|
-
|
|
103
|
+
--error-on-warnings fail the command if there are any warnings
|
|
104
|
+
--hidden show hidden commands
|
|
105
105
|
|
|
106
106
|
GLOBAL FLAGS
|
|
107
107
|
--json Format output as json.
|
|
@@ -129,7 +129,7 @@ EXAMPLES
|
|
|
129
129
|
$ sf commandreference generate --all --config-path /path/to/plugin --output-dir ./docs
|
|
130
130
|
```
|
|
131
131
|
|
|
132
|
-
_See code: [src/commands/commandreference/generate.ts](https://github.com/salesforcecli/plugin-command-reference/blob/3.0.
|
|
132
|
+
_See code: [src/commands/commandreference/generate.ts](https://github.com/salesforcecli/plugin-command-reference/blob/3.0.47/src/commands/commandreference/generate.ts)_
|
|
133
133
|
|
|
134
134
|
## `sf jit install`
|
|
135
135
|
|
|
@@ -149,6 +149,6 @@ EXAMPLES
|
|
|
149
149
|
$ sf jit install
|
|
150
150
|
```
|
|
151
151
|
|
|
152
|
-
_See code: [src/commands/jit/install.ts](https://github.com/salesforcecli/plugin-command-reference/blob/3.0.
|
|
152
|
+
_See code: [src/commands/jit/install.ts](https://github.com/salesforcecli/plugin-command-reference/blob/3.0.47/src/commands/jit/install.ts)_
|
|
153
153
|
|
|
154
154
|
<!-- commandsstop -->
|
|
@@ -9,13 +9,13 @@ export default class CommandReferenceGenerate extends SfCommand<CommandReference
|
|
|
9
9
|
static readonly description: string;
|
|
10
10
|
static readonly examples: string[];
|
|
11
11
|
static readonly flags: {
|
|
12
|
-
'output-dir': Interfaces.OptionFlag<string,
|
|
13
|
-
plugins: Interfaces.OptionFlag<string[] | undefined,
|
|
12
|
+
'output-dir': Interfaces.OptionFlag<string, Interfaces.CustomOptions>;
|
|
13
|
+
plugins: Interfaces.OptionFlag<string[] | undefined, Interfaces.CustomOptions>;
|
|
14
14
|
all: Interfaces.BooleanFlag<boolean>;
|
|
15
|
-
'ditamap-suffix': Interfaces.OptionFlag<string,
|
|
15
|
+
'ditamap-suffix': Interfaces.OptionFlag<string, Interfaces.CustomOptions>;
|
|
16
16
|
hidden: Interfaces.BooleanFlag<boolean>;
|
|
17
17
|
'error-on-warnings': Interfaces.BooleanFlag<boolean>;
|
|
18
|
-
'config-path': Interfaces.OptionFlag<string | undefined,
|
|
18
|
+
'config-path': Interfaces.OptionFlag<string | undefined, Interfaces.CustomOptions>;
|
|
19
19
|
};
|
|
20
20
|
private loadedConfig;
|
|
21
21
|
run(): Promise<CommandReferenceGenerateResults>;
|
|
@@ -27,7 +27,10 @@ class CommandReferenceGenerate extends sf_plugins_core_1.SfCommand {
|
|
|
27
27
|
this.loadedConfig = flags['config-path'] ? await core_1.Config.load((0, node_path_1.resolve)(flags['config-path'])) : this.config;
|
|
28
28
|
let pluginNames;
|
|
29
29
|
if (!flags.plugins && !flags.all) {
|
|
30
|
-
pluginNames = this.loadedConfig
|
|
30
|
+
pluginNames = this.loadedConfig
|
|
31
|
+
.getPluginsList()
|
|
32
|
+
.filter((p) => p.type !== 'dev')
|
|
33
|
+
.map((p) => p.name);
|
|
31
34
|
}
|
|
32
35
|
else if (flags.all) {
|
|
33
36
|
const ignore = [
|
|
@@ -37,7 +40,10 @@ class CommandReferenceGenerate extends sf_plugins_core_1.SfCommand {
|
|
|
37
40
|
/@salesforce\/plugin-telemetry/,
|
|
38
41
|
/@salesforce\/plugin-command-reference/,
|
|
39
42
|
];
|
|
40
|
-
pluginNames = this.loadedConfig
|
|
43
|
+
pluginNames = this.loadedConfig
|
|
44
|
+
.getPluginsList()
|
|
45
|
+
.map((p) => p.name)
|
|
46
|
+
.filter((p) => !ignore.some((i) => i.test(p)));
|
|
41
47
|
}
|
|
42
48
|
else {
|
|
43
49
|
pluginNames = flags.plugins ?? [];
|
|
@@ -113,7 +119,7 @@ class CommandReferenceGenerate extends sf_plugins_core_1.SfCommand {
|
|
|
113
119
|
return pluginToParentPlugin;
|
|
114
120
|
}
|
|
115
121
|
getPlugin(pluginName) {
|
|
116
|
-
return this.loadedConfig.plugins.
|
|
122
|
+
return this.loadedConfig.plugins.get(pluginName);
|
|
117
123
|
}
|
|
118
124
|
// eslint-disable-next-line class-methods-use-this
|
|
119
125
|
loadTopicMetadata(commands) {
|
|
@@ -141,7 +147,7 @@ class CommandReferenceGenerate extends sf_plugins_core_1.SfCommand {
|
|
|
141
147
|
...existing,
|
|
142
148
|
...topicInfo,
|
|
143
149
|
// TODO: this might need to be recursive if keys collide at lower levels
|
|
144
|
-
subtopics: existing.subtopics || topicInfo.subtopics
|
|
150
|
+
subtopics: Boolean(existing.subtopics) || Boolean(topicInfo.subtopics)
|
|
145
151
|
? new Map([...(existing.subtopics ?? []), ...(topicInfo.subtopics ?? [])])
|
|
146
152
|
: undefined,
|
|
147
153
|
});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../../src/commands/commandreference/generate.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAEH,8BAA8B;AAC9B,yCAAoC;AACpC,iEAA+D;AAC/D,mEAAmE;AACnE,sCAA0D;AAC1D,2CAAqD;AACrD,mDAAuD;AACvD,+BAAgC;AAEhC,mDAAgD;AAChD,qCAAkC;AAClC,uCAA+E;AAE/E,wDAAwD;AACxD,eAAQ,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;AAC5C,MAAM,QAAQ,GAAG,eAAQ,CAAC,YAAY,CAAC,sCAAsC,EAAE,MAAM,CAAC,CAAC;AAMvF,MAAqB,wBAAyB,SAAQ,2BAA0C;IA2CvF,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,CAAC,YAAY,GAAG,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,MAAM,aAAM,CAAC,IAAI,CAAC,IAAA,mBAAO,EAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;QAE1G,IAAI,WAAqB,CAAC;QAC1B,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE;YAChC,WAAW,GAAG,IAAI,CAAC,YAAY,
|
|
1
|
+
{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../../src/commands/commandreference/generate.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAEH,8BAA8B;AAC9B,yCAAoC;AACpC,iEAA+D;AAC/D,mEAAmE;AACnE,sCAA0D;AAC1D,2CAAqD;AACrD,mDAAuD;AACvD,+BAAgC;AAEhC,mDAAgD;AAChD,qCAAkC;AAClC,uCAA+E;AAE/E,wDAAwD;AACxD,eAAQ,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;AAC5C,MAAM,QAAQ,GAAG,eAAQ,CAAC,YAAY,CAAC,sCAAsC,EAAE,MAAM,CAAC,CAAC;AAMvF,MAAqB,wBAAyB,SAAQ,2BAA0C;IA2CvF,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,CAAC,YAAY,GAAG,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,MAAM,aAAM,CAAC,IAAI,CAAC,IAAA,mBAAO,EAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;QAE1G,IAAI,WAAqB,CAAC;QAC1B,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE;YAChC,WAAW,GAAG,IAAI,CAAC,YAAY;iBAC5B,cAAc,EAAE;iBAChB,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,KAAK,CAAC;iBAC/B,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;SACvB;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,YAAY;iBAC5B,cAAc,EAAE;iBAChB,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;iBAClB,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;SAClD;aAAM;YACL,WAAW,GAAG,KAAK,CAAC,OAAO,IAAI,EAAE,CAAC;SACnC;QAED,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE;YAC5B,MAAM,IAAI,cAAO,CACf,8GAA8G,CAC/G,CAAC;SACH;QAED,MAAM,OAAO,GAAG,WAAW;aACxB,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;aAC1B,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;QAEF,iBAAO,CAAC,SAAS,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC;QAExC,iBAAO,CAAC,UAAU,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC;QAC7E,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;QACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QAClD,MAAM,aAAa,GAAG,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QACvD,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QACnC,6DAA6D;QAC7D,aAAa;QACb,MAAM,IAAI,GAAG,IAAI,WAAI,CAAC,iBAAO,CAAC,SAAS,EAAE,KAAK,CAAC,MAAM,EAAE,aAAa,EAAE,OAAO,CAAC,CAAC;QAE/E,cAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,EAAE,KAAK,EAAqB,EAAE,EAAE;YAClD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,qBAAqB,KAAK,GAAG,CAAC,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAc,EAAE,CAAC;QAC/B,cAAM,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,GAAY,EAAE,EAAE;YACpC,4EAA4E;YAC5E,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,QAAQ,CAAC,CAAC;QAC3B,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,GAA2B,EAAE,CAAC;QAExD,MAAM,mBAAmB,GAAG,CAAC,YAA+B,EAAQ,EAAE;YACpE,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,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACnD,CAAC;IAED,kDAAkD;IAC1C,iBAAiB,CAAC,QAAwB;QAChD,MAAM,eAAe,GAAG,IAAI,GAAG,EAAU,CAAC;QAC1C,MAAM,MAAM,GAAG,IAAI,GAAG,EAAmB,CAAC;QAC1C,QAAQ;aACL,OAAO,CAAC,CAAC,YAAY,EAAwB,EAAE;YAC9C,wCAAwC;YACxC,IAAI,YAAY,CAAC,UAAU,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,YAAY,CAAC,UAAU,CAAC,EAAE;gBAC5E,IAAI,YAAY,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE;oBAC3C,eAAe,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;oBAC9C,OAAO,iBAAiB,CAAC,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;iBAClE;aACF;YACD,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC;aACD,MAAM,CAAC,CAAC,CAAC,EAAiB,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YACzC,4HAA4H;aAC3H,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;YAChB,QAAQ,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE;gBACpC,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;gBACnC,IAAI,QAAQ,EAAE;oBACZ,mDAAmD;oBACnD,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE;wBAChB,GAAG,QAAQ;wBACX,GAAG,SAAS;wBACZ,wEAAwE;wBACxE,SAAS,EACP,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC;4BACzD,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,SAAS,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,SAAS,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,CAAC;4BAC1E,CAAC,CAAC,SAAS;qBAChB,CAAC,CAAC;iBACJ;qBAAM;oBACL,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;iBAC9B;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QACL,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,KAAK,CAAC,YAAY,CAAC,OAAiB;QAC1C,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ;aACxC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC;aACvD,GAAG,CAAC,KAAK,EAAE,GAAG,EAAyB,EAAE;YACxC,IAAI;gBACF,IAAI,YAAY,GAAkB,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;gBAC9D,IAAI,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,GAAG,EAAE,YAAY,EAAE;oBAC7C,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,GAAI,OAAO,CAAC,cAAc,CAAC,YAAY,CAAmB,IAAI,SAAS,CAAC;oBACpF,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,GAA8B,CAAC;aACvC;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,GAA8B,CAAC;aACvC;QACH,CAAC,CAAC,CAAC;QACL,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC7C,OAAO,KAAK,CAAC,IAAI,CACf,QAAQ;aACL,MAAM,CAAC,CAAC,GAA8B,EAAE,GAAiB,EAAE,EAAE;YAC5D,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;YACrB,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,IAAI,GAAG,EAAwB,CAAC;aAClC,MAAM,EAAE,CACZ,CAAC;IACJ,CAAC;IAED,kDAAkD;IAC1C,KAAK,CAAC,WAAW,CAAC,OAAyB;QACjD,2DAA2D;QAC3D,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,YAAY,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,IAAI,IAAI;YACjD,cAAc,EAAE,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,KAAK,CAAC,cAAc;YAC5D,KAAK,EAAE,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK;SAC3C,CAAC;IACJ,CAAC;;AAtPsB,gCAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;AAChD,oCAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAC;AACxD,iCAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;AAE5C,8BAAK,GAAG;IAC7B,YAAY,EAAE,uBAAK,CAAC,MAAM,CAAC;QACzB,IAAI,EAAE,GAAG;QACT,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,0BAA0B,CAAC;QACxD,OAAO,EAAE,CAAC,WAAW,CAAC;QACtB,gBAAgB,EAAE,IAAI;QACtB,OAAO,EAAE,YAAY;KACtB,CAAC;IACF,OAAO,EAAE,uBAAK,CAAC,MAAM,CAAC;QACpB,IAAI,EAAE,GAAG;QACT,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,uBAAuB,CAAC;QACrD,QAAQ,EAAE,IAAI;QACd,SAAS,EAAE,CAAC,KAAK,CAAC;KACnB,CAAC;IACF,GAAG,EAAE,uBAAK,CAAC,OAAO,CAAC;QACjB,IAAI,EAAE,GAAG;QACT,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,mBAAmB,CAAC;QACjD,SAAS,EAAE,CAAC,SAAS,CAAC;KACvB,CAAC;IACF,gBAAgB,EAAE,uBAAK,CAAC,MAAM,CAAC;QAC7B,IAAI,EAAE,GAAG;QACT,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,8BAA8B,CAAC;QAC5D,OAAO,EAAE,iBAAO,CAAC,MAAM;KACxB,CAAC;IACF,MAAM,EAAE,uBAAK,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,sBAAsB,CAAC,EAAE,CAAC;IAC/E,mBAAmB,EAAE,uBAAK,CAAC,OAAO,CAAC;QACjC,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,iCAAiC,CAAC;QAC/D,OAAO,EAAE,CAAC,iBAAiB,CAAC;QAC5B,gBAAgB,EAAE,IAAI;KACvB,CAAC;IACF,aAAa,EAAE,uBAAK,CAAC,SAAS,CAAC;QAC7B,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,2BAA2B,CAAC;QACzD,IAAI,EAAE,GAAG;KACV,CAAC;CACH,CAAC;kBAvCiB,wBAAwB;AA0P7C,iGAAiG;AACjG,MAAM,iBAAiB,GAAG,CAAC,WAA4C,EAAY,EAAE,CACnF,IAAI,GAAG,CACL,MAAM,CAAC,OAAO,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,EAAE,SAAS,CAAC,EAAE,EAAE;IAC3D,IAAI,SAAS,CAAC,SAAS,EAAE;QACvB,OAAO;QACP,OAAO,CAAC,KAAK,EAAE,EAAE,GAAG,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,iBAAiB,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;KAClG;IACD,OAAO,CAAC,KAAK,EAAE,EAAE,GAAG,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC,CAAC;AACtE,CAAC,CAAC,CACH,CAAC"}
|
package/oclif.manifest.json
CHANGED
|
@@ -1,15 +1,9 @@
|
|
|
1
1
|
{
|
|
2
|
-
"version": "3.0.46",
|
|
3
2
|
"commands": {
|
|
4
3
|
"commandreference:generate": {
|
|
5
|
-
"id": "commandreference:generate",
|
|
6
|
-
"summary": "generate the command reference guide located",
|
|
7
|
-
"description": "generate the command reference guide located",
|
|
8
|
-
"strict": true,
|
|
9
|
-
"pluginName": "@salesforce/plugin-command-reference",
|
|
10
|
-
"pluginAlias": "@salesforce/plugin-command-reference",
|
|
11
|
-
"pluginType": "core",
|
|
12
4
|
"aliases": [],
|
|
5
|
+
"args": {},
|
|
6
|
+
"description": "generate the command reference guide located",
|
|
13
7
|
"examples": [
|
|
14
8
|
"Generate the command reference guide\n<%= config.bin %> <%= command.id %>",
|
|
15
9
|
"Generate the command reference for a set of plugins\n<%= config.bin %> <%= command.id %> --plugins pluginA,pluginB",
|
|
@@ -18,104 +12,138 @@
|
|
|
18
12
|
],
|
|
19
13
|
"flags": {
|
|
20
14
|
"json": {
|
|
21
|
-
"name": "json",
|
|
22
|
-
"type": "boolean",
|
|
23
15
|
"description": "Format output as json.",
|
|
24
16
|
"helpGroup": "GLOBAL",
|
|
25
|
-
"
|
|
17
|
+
"name": "json",
|
|
18
|
+
"allowNo": false,
|
|
19
|
+
"type": "boolean"
|
|
26
20
|
},
|
|
27
21
|
"output-dir": {
|
|
28
|
-
"
|
|
29
|
-
|
|
22
|
+
"aliases": [
|
|
23
|
+
"outputdir"
|
|
24
|
+
],
|
|
30
25
|
"char": "d",
|
|
26
|
+
"deprecateAliases": true,
|
|
27
|
+
"name": "output-dir",
|
|
31
28
|
"summary": "output directory to put generated files",
|
|
32
|
-
"multiple": false,
|
|
33
29
|
"default": "./tmp/root",
|
|
34
|
-
"
|
|
35
|
-
|
|
36
|
-
|
|
30
|
+
"hasDynamicHelp": false,
|
|
31
|
+
"multiple": false,
|
|
32
|
+
"type": "option"
|
|
37
33
|
},
|
|
38
34
|
"plugins": {
|
|
39
|
-
"name": "plugins",
|
|
40
|
-
"type": "option",
|
|
41
35
|
"char": "p",
|
|
42
|
-
"summary": "comma separated list of plugin names to be part of the generation. Defaults to the oclif plugin in the current working directory",
|
|
43
|
-
"multiple": true,
|
|
44
36
|
"exclusive": [
|
|
45
37
|
"all"
|
|
46
|
-
]
|
|
38
|
+
],
|
|
39
|
+
"name": "plugins",
|
|
40
|
+
"summary": "comma separated list of plugin names to be part of the generation. Defaults to the oclif plugin in the current working directory",
|
|
41
|
+
"hasDynamicHelp": false,
|
|
42
|
+
"multiple": true,
|
|
43
|
+
"type": "option"
|
|
47
44
|
},
|
|
48
45
|
"all": {
|
|
49
|
-
"name": "all",
|
|
50
|
-
"type": "boolean",
|
|
51
46
|
"char": "a",
|
|
52
|
-
"summary": "include all relevant plugins in the generation",
|
|
53
|
-
"allowNo": false,
|
|
54
47
|
"exclusive": [
|
|
55
48
|
"plugins"
|
|
56
|
-
]
|
|
49
|
+
],
|
|
50
|
+
"name": "all",
|
|
51
|
+
"summary": "include all relevant plugins in the generation",
|
|
52
|
+
"allowNo": false,
|
|
53
|
+
"type": "boolean"
|
|
57
54
|
},
|
|
58
55
|
"ditamap-suffix": {
|
|
59
|
-
"name": "ditamap-suffix",
|
|
60
|
-
"type": "option",
|
|
61
56
|
"char": "s",
|
|
57
|
+
"name": "ditamap-suffix",
|
|
62
58
|
"summary": "unique suffix to append to generated ditamap",
|
|
59
|
+
"default": "unified",
|
|
60
|
+
"hasDynamicHelp": false,
|
|
63
61
|
"multiple": false,
|
|
64
|
-
"
|
|
62
|
+
"type": "option"
|
|
65
63
|
},
|
|
66
64
|
"hidden": {
|
|
67
65
|
"name": "hidden",
|
|
68
|
-
"type": "boolean",
|
|
69
66
|
"summary": "show hidden commands",
|
|
70
|
-
"allowNo": false
|
|
67
|
+
"allowNo": false,
|
|
68
|
+
"type": "boolean"
|
|
71
69
|
},
|
|
72
70
|
"error-on-warnings": {
|
|
71
|
+
"aliases": [
|
|
72
|
+
"erroronwarnings"
|
|
73
|
+
],
|
|
74
|
+
"deprecateAliases": true,
|
|
73
75
|
"name": "error-on-warnings",
|
|
74
|
-
"type": "boolean",
|
|
75
76
|
"summary": "fail the command if there are any warnings",
|
|
76
77
|
"allowNo": false,
|
|
77
|
-
"
|
|
78
|
-
"erroronwarnings"
|
|
79
|
-
]
|
|
78
|
+
"type": "boolean"
|
|
80
79
|
},
|
|
81
80
|
"config-path": {
|
|
82
|
-
"name": "config-path",
|
|
83
|
-
"type": "option",
|
|
84
81
|
"char": "c",
|
|
82
|
+
"name": "config-path",
|
|
85
83
|
"summary": "A path to the directory containing a plugin or cli",
|
|
86
|
-
"
|
|
84
|
+
"hasDynamicHelp": false,
|
|
85
|
+
"multiple": false,
|
|
86
|
+
"type": "option"
|
|
87
87
|
}
|
|
88
88
|
},
|
|
89
|
-
"
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
"id": "jit:install",
|
|
93
|
-
"summary": "Install all JIT plugins.",
|
|
94
|
-
"strict": true,
|
|
95
|
-
"pluginName": "@salesforce/plugin-command-reference",
|
|
89
|
+
"hasDynamicHelp": false,
|
|
90
|
+
"hiddenAliases": [],
|
|
91
|
+
"id": "commandreference:generate",
|
|
96
92
|
"pluginAlias": "@salesforce/plugin-command-reference",
|
|
93
|
+
"pluginName": "@salesforce/plugin-command-reference",
|
|
97
94
|
"pluginType": "core",
|
|
95
|
+
"strict": true,
|
|
96
|
+
"summary": "generate the command reference guide located",
|
|
97
|
+
"enableJsonFlag": true,
|
|
98
|
+
"SF_ENV": "SF_ENV",
|
|
99
|
+
"isESM": false,
|
|
100
|
+
"relativePath": [
|
|
101
|
+
"lib",
|
|
102
|
+
"commands",
|
|
103
|
+
"commandreference",
|
|
104
|
+
"generate.js"
|
|
105
|
+
]
|
|
106
|
+
},
|
|
107
|
+
"jit:install": {
|
|
98
108
|
"aliases": [],
|
|
109
|
+
"args": {},
|
|
99
110
|
"examples": [
|
|
100
111
|
"<%= config.bin %> <%= command.id %>"
|
|
101
112
|
],
|
|
102
113
|
"flags": {
|
|
103
114
|
"json": {
|
|
104
|
-
"name": "json",
|
|
105
|
-
"type": "boolean",
|
|
106
115
|
"description": "Format output as json.",
|
|
107
116
|
"helpGroup": "GLOBAL",
|
|
108
|
-
"
|
|
117
|
+
"name": "json",
|
|
118
|
+
"allowNo": false,
|
|
119
|
+
"type": "boolean"
|
|
109
120
|
},
|
|
110
121
|
"dry-run": {
|
|
111
|
-
"name": "dry-run",
|
|
112
|
-
"type": "boolean",
|
|
113
122
|
"char": "d",
|
|
123
|
+
"name": "dry-run",
|
|
114
124
|
"summary": "List the plugins that would be installed.",
|
|
115
|
-
"allowNo": false
|
|
125
|
+
"allowNo": false,
|
|
126
|
+
"type": "boolean"
|
|
116
127
|
}
|
|
117
128
|
},
|
|
118
|
-
"
|
|
129
|
+
"hasDynamicHelp": false,
|
|
130
|
+
"hiddenAliases": [],
|
|
131
|
+
"id": "jit:install",
|
|
132
|
+
"pluginAlias": "@salesforce/plugin-command-reference",
|
|
133
|
+
"pluginName": "@salesforce/plugin-command-reference",
|
|
134
|
+
"pluginType": "core",
|
|
135
|
+
"strict": true,
|
|
136
|
+
"summary": "Install all JIT plugins.",
|
|
137
|
+
"enableJsonFlag": true,
|
|
138
|
+
"SF_ENV": "SF_ENV",
|
|
139
|
+
"isESM": false,
|
|
140
|
+
"relativePath": [
|
|
141
|
+
"lib",
|
|
142
|
+
"commands",
|
|
143
|
+
"jit",
|
|
144
|
+
"install.js"
|
|
145
|
+
]
|
|
119
146
|
}
|
|
120
|
-
}
|
|
147
|
+
},
|
|
148
|
+
"version": "3.0.47"
|
|
121
149
|
}
|
package/package.json
CHANGED
|
@@ -1,50 +1,30 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@salesforce/plugin-command-reference",
|
|
3
3
|
"description": "Generate the Salesforce CLI command reference guide",
|
|
4
|
-
"version": "3.0.
|
|
4
|
+
"version": "3.0.47",
|
|
5
5
|
"author": "Salesforce",
|
|
6
6
|
"bugs": "https://github.com/salesforcecli/plugin-command-reference/issues",
|
|
7
7
|
"dependencies": {
|
|
8
|
-
"@oclif/core": "^
|
|
9
|
-
"@salesforce/core": "^5.3.
|
|
8
|
+
"@oclif/core": "^3.0.0",
|
|
9
|
+
"@salesforce/core": "^5.3.20",
|
|
10
10
|
"@salesforce/kit": "^3.0.15",
|
|
11
|
-
"@salesforce/sf-plugins-core": "^
|
|
11
|
+
"@salesforce/sf-plugins-core": "^4",
|
|
12
12
|
"@salesforce/ts-types": "^2.0.9",
|
|
13
13
|
"chalk": "^4",
|
|
14
14
|
"handlebars": "^4.7.8",
|
|
15
15
|
"tslib": "^2"
|
|
16
16
|
},
|
|
17
17
|
"devDependencies": {
|
|
18
|
-
"@oclif/plugin-help": "^
|
|
19
|
-
"@salesforce/dev-
|
|
20
|
-
"@salesforce/
|
|
21
|
-
"@
|
|
22
|
-
"@
|
|
23
|
-
"
|
|
24
|
-
"
|
|
25
|
-
"@typescript-eslint/eslint-plugin": "^5.62.0",
|
|
26
|
-
"@typescript-eslint/parser": "^5.61.0",
|
|
27
|
-
"chai": "^4.3.10",
|
|
28
|
-
"eslint": "^8.52.0",
|
|
29
|
-
"eslint-config-prettier": "^8.10.0",
|
|
30
|
-
"eslint-config-salesforce": "^2.0.2",
|
|
31
|
-
"eslint-config-salesforce-license": "^0.2.0",
|
|
32
|
-
"eslint-config-salesforce-typescript": "^2.0.0",
|
|
33
|
-
"eslint-plugin-header": "^3.1.1",
|
|
34
|
-
"eslint-plugin-import": "^2.29.0",
|
|
35
|
-
"eslint-plugin-jsdoc": "^46.8.2",
|
|
36
|
-
"eslint-plugin-sf-plugin": "^1.16.9",
|
|
37
|
-
"husky": "^8.0.3",
|
|
38
|
-
"mocha": "^10.2.0",
|
|
39
|
-
"nyc": "^15.1.0",
|
|
40
|
-
"oclif": "^3.17.2",
|
|
41
|
-
"prettier": "^2.8.8",
|
|
42
|
-
"pretty-quick": "^3.1.0",
|
|
18
|
+
"@oclif/plugin-help": "^6",
|
|
19
|
+
"@salesforce/dev-scripts": "^6.0.3",
|
|
20
|
+
"@salesforce/plugin-auth": "^2.8.26",
|
|
21
|
+
"@types/debug": "^4.1.12",
|
|
22
|
+
"@types/ejs": "^3.1.5",
|
|
23
|
+
"eslint-plugin-sf-plugin": "^1.16.15",
|
|
24
|
+
"oclif": "^4",
|
|
43
25
|
"shx": "^0.3.3",
|
|
44
|
-
"
|
|
45
|
-
"
|
|
46
|
-
"typescript": "^5.2.2",
|
|
47
|
-
"wireit": "^0.14.1"
|
|
26
|
+
"ts-node": "^10.9.1",
|
|
27
|
+
"typescript": "^5.2.2"
|
|
48
28
|
},
|
|
49
29
|
"engines": {
|
|
50
30
|
"node": ">=16.0.0"
|
|
@@ -176,7 +156,7 @@
|
|
|
176
156
|
]
|
|
177
157
|
},
|
|
178
158
|
"test:command-reference": {
|
|
179
|
-
"command": "\"./bin/dev\" commandreference:generate --plugins auth --outputdir test/tmp",
|
|
159
|
+
"command": "ts-node \"./bin/dev.js\" commandreference:generate --plugins auth --outputdir test/tmp",
|
|
180
160
|
"files": [
|
|
181
161
|
"src/**/*.ts",
|
|
182
162
|
"messages/**",
|
|
@@ -187,7 +167,7 @@
|
|
|
187
167
|
]
|
|
188
168
|
},
|
|
189
169
|
"test:deprecation-policy": {
|
|
190
|
-
"command": "\"./bin/dev\" snapshot:compare",
|
|
170
|
+
"command": "ts-node \"./bin/dev.js\" snapshot:compare",
|
|
191
171
|
"files": [
|
|
192
172
|
"src/**/*.ts"
|
|
193
173
|
],
|
|
@@ -197,7 +177,7 @@
|
|
|
197
177
|
]
|
|
198
178
|
},
|
|
199
179
|
"test:json-schema": {
|
|
200
|
-
"command": "\"./bin/dev\" schema:compare",
|
|
180
|
+
"command": "ts-node \"./bin/dev.js\" schema:compare",
|
|
201
181
|
"files": [
|
|
202
182
|
"src/**/*.ts",
|
|
203
183
|
"schemas"
|