@salesforce/plugin-command-reference 1.4.6 → 1.5.0

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/docs.d.ts CHANGED
@@ -1,11 +1,19 @@
1
1
  import { Dictionary, JsonMap } from '@salesforce/ts-types';
2
+ import * as OclifCommand from '@oclif/command';
3
+ declare type CommandClass = OclifCommand.Command & {
4
+ topic: string;
5
+ subtopic: string;
6
+ plugin: JsonMap & {
7
+ name: string;
8
+ };
9
+ } & JsonMap;
2
10
  export declare class Docs {
3
11
  private outputDir;
4
12
  private plugins;
5
13
  private hidden;
6
14
  private topicMeta;
7
15
  constructor(outputDir: string, plugins: JsonMap, hidden: boolean, topicMeta: JsonMap);
8
- build(commands: JsonMap[]): Promise<void>;
16
+ build(commands: CommandClass[]): Promise<void>;
9
17
  populateTopic(topic: string, subtopics: Dictionary<Dictionary | Dictionary[]>): Promise<any[]>;
10
18
  /**
11
19
  * Group all commands by the top level topic and then subtopic. e.g. force, analytics, evergreen, etc
@@ -19,3 +27,4 @@ export declare class Docs {
19
27
  private resolveCommandMeta;
20
28
  private populateCommand;
21
29
  }
30
+ export {};
package/lib/docs.js CHANGED
@@ -105,16 +105,17 @@ class Docs {
105
105
  continue;
106
106
  }
107
107
  const commandParts = (0, ts_types_1.ensureString)(command.id).split(':');
108
- if (commandParts.length === 1) {
109
- continue; // Top level topic command. Just ignore for as it is usually help for the topic.
110
- }
111
108
  const topLevelTopic = commandParts[0];
112
109
  const plugin = command.plugin;
113
110
  if (this.plugins[plugin.name]) {
114
111
  // Also include the namespace on the commands so we don't need to do the split at other times in the code.
115
112
  command.topic = topLevelTopic;
116
113
  const topics = topLevelTopics[topLevelTopic] || {};
117
- if (commandParts.length === 2) {
114
+ if (commandParts.length === 1) {
115
+ // This is a top-level topic that is also a command
116
+ topics[commandParts[0]] = command;
117
+ }
118
+ else if (commandParts.length === 2) {
118
119
  // This is a command directly under the top-level topic
119
120
  topics[commandParts[1]] = command;
120
121
  }
@@ -133,8 +134,8 @@ class Docs {
133
134
  command.subtopic = subtopic;
134
135
  const existingSubTopics = topics[subtopic];
135
136
  let subtopicCommands = [];
136
- if ((0, ts_types_1.isArray)(existingSubTopics)) {
137
- subtopicCommands = existingSubTopics;
137
+ if (existingSubTopics) {
138
+ subtopicCommands = (0, ts_types_1.isArray)(existingSubTopics) ? existingSubTopics : [existingSubTopics];
138
139
  }
139
140
  (0, ts_types_1.ensureArray)(subtopicCommands);
140
141
  subtopicCommands.push(command);
@@ -155,6 +156,8 @@ class Docs {
155
156
  await Promise.all(topics.map((topic) => {
156
157
  utils_1.events.emit('topic', { topic });
157
158
  const subtopics = (0, ts_types_1.ensure)(topicsAndSubtopics[topic]);
159
+ // eslint-disable-next-line @typescript-eslint/ban-ts-comment
160
+ // @ts-ignore
158
161
  return this.populateTopic(topic, subtopics);
159
162
  }));
160
163
  }
package/lib/docs.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"docs.js","sourceRoot":"","sources":["../src/docs.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,+BAA4B;AAC5B,yBAAyB;AAEzB,mDAS8B;AAC9B,+BAA+B;AAC/B,yDAAqD;AACrD,2DAAuD;AACvD,uEAAkE;AAClE,+CAA4C;AAC5C,iEAA4D;AAC5D,iEAA6D;AAC7D,2DAAuD;AACvD,mCAA4D;AAE5D,MAAM,YAAY,GAAG,IAAA,WAAI,EAAC,SAAS,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC;AAExD,MAAa,IAAI;IACf,YACU,SAAiB,EACjB,OAAgB,EAChB,MAAe,EACf,SAAkB;QAHlB,cAAS,GAAT,SAAS,CAAQ;QACjB,YAAO,GAAP,OAAO,CAAS;QAChB,WAAM,GAAN,MAAM,CAAS;QACf,cAAS,GAAT,SAAS,CAAS;IACzB,CAAC;IAEG,KAAK,CAAC,KAAK,CAAC,QAAmB;QACpC,0BAA0B;QAC1B,MAAM,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAE7D,MAAM,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED,8DAA8D;IACvD,KAAK,CAAC,aAAa,CAAC,KAAa,EAAE,SAAgD;QACxF,MAAM,SAAS,GAAG,IAAA,wBAAa,EAC7B,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EACrB,qBAAqB,KAAK,6DAA6D,CACxF,CAAC;QACF,IAAI,WAAW,GAAG,IAAA,mBAAQ,EAAC,SAAS,CAAC,eAAe,CAAC,CAAC;QACtD,IAAI,CAAC,WAAW,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE;YACvC,wDAAwD;YACxD,WAAW,GAAG,IAAA,iBAAS,EAAC,IAAA,mBAAQ,EAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC;YACzD,IAAI,CAAC,WAAW,EAAE;gBAChB,cAAM,CAAC,IAAI,CACT,SAAS,EACT,4BAA4B,KAAK,CAAC,IAAI,CACpC,KAAK,CACN,qJAAqJ,CACvJ,CAAC;gBACF,OAAO;aACR;SACF;QACD,MAAM,IAAI,uCAAiB,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC,KAAK,EAAE,CAAC;QAExD,MAAM,aAAa,GAAa,EAAE,CAAC;QACnC,MAAM,YAAY,GAAa,EAAE,CAAC;QAClC,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;YAC7C,MAAM,iBAAiB,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;YAC9C,IAAI;gBACF,IAAI,CAAC,IAAA,kBAAO,EAAC,iBAAiB,CAAC,EAAE;oBAC/B,uEAAuE;oBACvE,MAAM,OAAO,GAAG,iBAAiB,CAAC;oBAClC,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAA,uBAAY,EAAC,OAAO,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;oBAClF,4CAA4C;oBAC5C,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;oBAC9D,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;oBAC5B,SAAS;iBACV;gBAED,MAAM,aAAa,GAAG,IAAA,wBAAa,EAAC,SAAS,CAAC,SAAS,CAAC,CAAC;gBAEzD,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE;oBAC5B,MAAM,aAAa,GAAG,GAAG,KAAK,IAAI,QAAQ,EAAE,CAAC;oBAC7C,cAAM,CAAC,IAAI,CACT,SAAS,EACT,yBAAyB,KAAK,CAAC,IAAI,CACjC,aAAa,CACd,+GAA+G,CACjH,CAAC;oBACF,SAAS;iBACV;gBAED,MAAM,YAAY,GAAG,IAAA,wBAAa,EAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC;gBAE5D,+BAA+B;gBAC/B,4CAA4C;gBAC5C,MAAM,IAAI,iCAAc,CAAC,KAAK,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC,KAAK,EAAE,CAAC;gBAEhE,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAE7B,gCAAgC;gBAChC,MAAM,SAAS,GAAa,EAAE,CAAC;gBAC/B,KAAK,MAAM,OAAO,IAAI,iBAAiB,EAAE;oBACvC,MAAM,SAAS,GAAG,IAAA,uBAAY,EAAC,OAAO,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;oBAChE,MAAM,mBAAmB,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAA,uBAAY,EAAC,GAAG,CAAC,EAAE,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC;oBAC1G,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAA,uBAAY,EAAC,OAAO,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,mBAAmB,CAAC,MAAM,CAAC,CAAC;oBAE3G,4CAA4C;oBAC5C,SAAS,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC;iBACnF;gBACD,4CAA4C;gBAC5C,MAAM,IAAI,kCAAe,CAAC,KAAK,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC,KAAK,EAAE,CAAC;aAC/D;YAAC,OAAO,KAAK,EAAE;gBACd,cAAM,CAAC,IAAI,CAAC,SAAS,EAAE,0BAA0B,KAAK,IAAI,QAAQ,KAAK,KAAK,CAAC,OAAO,IAAI,CAAC,CAAC;aAC3F;SACF;QAED,oDAAoD;QACpD,cAAM,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,EAAE,aAAa,CAAC,CAAC;QAC/C,MAAM,IAAI,4BAAY,CAAC,KAAK,EAAE,aAAa,EAAE,YAAY,CAAC,CAAC,KAAK,EAAE,CAAC;QACnE,OAAO,aAAa,CAAC;IACvB,CAAC;IAED;;;;;;OAMG;IACK,uBAAuB,CAC7B,QAAmB;QAEnB,MAAM,cAAc,GAAsD,EAAE,CAAC;QAE7E,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;YAC9B,IAAI,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;gBAClC,SAAS;aACV;YACD,MAAM,YAAY,GAAG,IAAA,uBAAY,EAAC,OAAO,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACzD,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE;gBAC7B,SAAS,CAAC,gFAAgF;aAC3F;YAED,MAAM,aAAa,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;YAEtC,MAAM,MAAM,GAAG,OAAO,CAAC,MAA2B,CAAC;YACnD,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;gBAC7B,0GAA0G;gBAC1G,OAAO,CAAC,KAAK,GAAG,aAAa,CAAC;gBAE9B,MAAM,MAAM,GAAG,cAAc,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC;gBAEnD,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE;oBAC7B,uDAAuD;oBACvD,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC;iBACnC;qBAAM;oBACL,MAAM,QAAQ,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;oBAEjC,IAAI;wBACF,MAAM,SAAS,GAAG,IAAA,wBAAa,EAAC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAC;wBAC/D,MAAM,aAAa,GAAG,IAAA,wBAAa,EAAC,SAAS,CAAC,SAAS,CAAC,CAAC;wBACzD,IAAI,aAAa,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;4BACxC,SAAS;yBACV;qBACF;oBAAC,OAAO,CAAC,EAAE;wBACV,qGAAqG;qBACtG;oBAED,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;oBAE5B,MAAM,iBAAiB,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;oBAC3C,IAAI,gBAAgB,GAAG,EAAE,CAAC;oBAC1B,IAAI,IAAA,kBAAO,EAAC,iBAAiB,CAAC,EAAE;wBAC9B,gBAAgB,GAAG,iBAAiB,CAAC;qBACtC;oBACD,IAAA,sBAAW,EAAC,gBAAgB,CAAC,CAAC;oBAC9B,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;oBAC/B,MAAM,CAAC,QAAQ,CAAC,GAAG,gBAAgB,CAAC;iBACrC;gBAED,cAAc,CAAC,aAAa,CAAC,GAAG,MAAM,CAAC;aACxC;SACF;QACD,OAAO,cAAc,CAAC;IACxB,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAAC,QAAmB;QAChD,MAAM,kBAAkB,GAAG,IAAI,CAAC,uBAAuB,CAAC,QAAQ,CAAC,CAAC;QAElE,MAAM,IAAI,4BAAY,EAAE,CAAC,KAAK,EAAE,CAAC;QACjC,MAAM,IAAA,sBAAc,EAAC,IAAI,CAAC,SAAS,EAAE,YAAY,EAAE,wBAAwB,CAAC,CAAC;QAE7E,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAE/C,oDAAoD;QACpD,MAAM,IAAI,0BAAW,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,CAAC;QAEtC,MAAM,OAAO,CAAC,GAAG,CACf,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;YACnB,cAAM,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;YAChC,MAAM,SAAS,GAAG,IAAA,iBAAM,EAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC;YACpD,OAAO,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QAC9C,CAAC,CAAC,CACH,CAAC;IACJ,CAAC;IAEO,kBAAkB,CAAC,SAAiB,EAAE,OAAO,EAAE,eAAuB;QAC5E,MAAM,WAAW,GAAiE,EAAE,CAAC;QACrF,yEAAyE;QACzE,MAAM,YAAY,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC1C,IAAI,IAAY,CAAC;QACjB,IAAI;YACF,IAAI,WAAgC,CAAC;YACrC,KAAK,IAAI,IAAI,YAAY,EAAE;gBACzB,IAAI,WAAW,EAAE;oBACf,MAAM,SAAS,GAAG,IAAA,wBAAa,EAAC,WAAW,CAAC,SAAS,CAAC,CAAC;oBACvD,WAAW,GAAG,IAAA,wBAAa,EAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;iBAC9C;qBAAM;oBACL,WAAW,GAAG,IAAA,wBAAa,EAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;iBACnD;gBAED,+GAA+G;gBAC/G,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;aACzC;SACF;QAAC,OAAO,KAAK,EAAE;YACd,IAAI,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;gBAC5B,+FAA+F;gBAC/F,OAAO,WAAW,CAAC;aACpB;iBAAM,IAAI,eAAe,KAAK,CAAC,EAAE;gBAChC,cAAM,CAAC,IAAI,CAAC,SAAS,EAAE,aAAa,IAAI,gCAAgC,SAAS,EAAE,CAAC,CAAC;aACtF;iBAAM,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE;gBACnC,kGAAkG;gBAClG,WAAW,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;gBAC9C,WAAW,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,IAAI,IAAA,iBAAS,EAAC,OAAO,CAAC,WAAqB,CAAC,CAAC;aACnG;SACF;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;IAEO,KAAK,CAAC,eAAe,CAC3B,KAAa,EACb,QAAgB,EAChB,OAAmB,EACnB,WAAoB;QAEpB,oCAAoC;QACpC,IAAI,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YAClC,OAAO,EAAE,CAAC;SACX;QAED,MAAM,cAAc,GAAG,IAAI,iBAAO,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;QAC1E,MAAM,cAAc,CAAC,KAAK,EAAE,CAAC;QAC7B,OAAO,cAAc,CAAC,WAAW,EAAE,CAAC;IACtC,CAAC;CACF;AApOD,oBAoOC"}
1
+ {"version":3,"file":"docs.js","sourceRoot":"","sources":["../src/docs.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,+BAA4B;AAC5B,yBAAyB;AACzB,mDAS8B;AAE9B,+BAA+B;AAC/B,yDAAqD;AACrD,2DAAuD;AACvD,uEAAkE;AAClE,+CAA4C;AAC5C,iEAA4D;AAC5D,iEAA6D;AAC7D,2DAAuD;AACvD,mCAA4D;AAE5D,MAAM,YAAY,GAAG,IAAA,WAAI,EAAC,SAAS,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC;AAQxD,MAAa,IAAI;IACf,YACU,SAAiB,EACjB,OAAgB,EAChB,MAAe,EACf,SAAkB;QAHlB,cAAS,GAAT,SAAS,CAAQ;QACjB,YAAO,GAAP,OAAO,CAAS;QAChB,WAAM,GAAN,MAAM,CAAS;QACf,cAAS,GAAT,SAAS,CAAS;IACzB,CAAC;IAEG,KAAK,CAAC,KAAK,CAAC,QAAwB;QACzC,0BAA0B;QAC1B,MAAM,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAE7D,MAAM,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED,8DAA8D;IACvD,KAAK,CAAC,aAAa,CAAC,KAAa,EAAE,SAAgD;QACxF,MAAM,SAAS,GAAG,IAAA,wBAAa,EAC7B,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EACrB,qBAAqB,KAAK,6DAA6D,CACxF,CAAC;QACF,IAAI,WAAW,GAAG,IAAA,mBAAQ,EAAC,SAAS,CAAC,eAAe,CAAC,CAAC;QACtD,IAAI,CAAC,WAAW,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE;YACvC,wDAAwD;YACxD,WAAW,GAAG,IAAA,iBAAS,EAAC,IAAA,mBAAQ,EAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC;YACzD,IAAI,CAAC,WAAW,EAAE;gBAChB,cAAM,CAAC,IAAI,CACT,SAAS,EACT,4BAA4B,KAAK,CAAC,IAAI,CACpC,KAAK,CACN,qJAAqJ,CACvJ,CAAC;gBACF,OAAO;aACR;SACF;QACD,MAAM,IAAI,uCAAiB,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC,KAAK,EAAE,CAAC;QAExD,MAAM,aAAa,GAAa,EAAE,CAAC;QACnC,MAAM,YAAY,GAAa,EAAE,CAAC;QAClC,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;YAC7C,MAAM,iBAAiB,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;YAC9C,IAAI;gBACF,IAAI,CAAC,IAAA,kBAAO,EAAC,iBAAiB,CAAC,EAAE;oBAC/B,uEAAuE;oBACvE,MAAM,OAAO,GAAG,iBAAiB,CAAC;oBAClC,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAA,uBAAY,EAAC,OAAO,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;oBAClF,4CAA4C;oBAC5C,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;oBAC9D,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;oBAC5B,SAAS;iBACV;gBAED,MAAM,aAAa,GAAG,IAAA,wBAAa,EAAC,SAAS,CAAC,SAAS,CAAC,CAAC;gBAEzD,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE;oBAC5B,MAAM,aAAa,GAAG,GAAG,KAAK,IAAI,QAAQ,EAAE,CAAC;oBAC7C,cAAM,CAAC,IAAI,CACT,SAAS,EACT,yBAAyB,KAAK,CAAC,IAAI,CACjC,aAAa,CACd,+GAA+G,CACjH,CAAC;oBACF,SAAS;iBACV;gBAED,MAAM,YAAY,GAAG,IAAA,wBAAa,EAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC;gBAE5D,+BAA+B;gBAC/B,4CAA4C;gBAC5C,MAAM,IAAI,iCAAc,CAAC,KAAK,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC,KAAK,EAAE,CAAC;gBAEhE,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAE7B,gCAAgC;gBAChC,MAAM,SAAS,GAAa,EAAE,CAAC;gBAC/B,KAAK,MAAM,OAAO,IAAI,iBAAiB,EAAE;oBACvC,MAAM,SAAS,GAAG,IAAA,uBAAY,EAAC,OAAO,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;oBAChE,MAAM,mBAAmB,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAA,uBAAY,EAAC,GAAG,CAAC,EAAE,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC;oBAC1G,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAA,uBAAY,EAAC,OAAO,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,mBAAmB,CAAC,MAAM,CAAC,CAAC;oBAE3G,4CAA4C;oBAC5C,SAAS,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC;iBACnF;gBACD,4CAA4C;gBAC5C,MAAM,IAAI,kCAAe,CAAC,KAAK,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC,KAAK,EAAE,CAAC;aAC/D;YAAC,OAAO,KAAK,EAAE;gBACd,cAAM,CAAC,IAAI,CAAC,SAAS,EAAE,0BAA0B,KAAK,IAAI,QAAQ,KAAK,KAAK,CAAC,OAAO,IAAI,CAAC,CAAC;aAC3F;SACF;QAED,oDAAoD;QACpD,cAAM,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,EAAE,aAAa,CAAC,CAAC;QAC/C,MAAM,IAAI,4BAAY,CAAC,KAAK,EAAE,aAAa,EAAE,YAAY,CAAC,CAAC,KAAK,EAAE,CAAC;QACnE,OAAO,aAAa,CAAC;IACvB,CAAC;IAED;;;;;;OAMG;IACK,uBAAuB,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;YAE9B,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;gBAC7B,0GAA0G;gBAC1G,OAAO,CAAC,KAAK,GAAG,aAAa,CAAC;gBAE9B,MAAM,MAAM,GAAG,cAAc,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC;gBAEnD,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE;oBAC7B,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;wBACV,qGAAqG;qBACtG;oBAED,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;oBAE5B,MAAM,iBAAiB,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;oBAC3C,IAAI,gBAAgB,GAAG,EAAE,CAAC;oBAC1B,IAAI,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;QAED,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,IAAA,sBAAc,EAAC,IAAI,CAAC,SAAS,EAAE,YAAY,EAAE,wBAAwB,CAAC,CAAC;QAE7E,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAE/C,oDAAoD;QACpD,MAAM,IAAI,0BAAW,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,CAAC;QAEtC,MAAM,OAAO,CAAC,GAAG,CACf,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;YACnB,cAAM,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;YAChC,MAAM,SAAS,GAAG,IAAA,iBAAM,EAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC;YACpD,6DAA6D;YAC7D,aAAa;YACb,OAAO,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QAC9C,CAAC,CAAC,CACH,CAAC;IACJ,CAAC;IAEO,kBAAkB,CAAC,SAAiB,EAAE,OAAO,EAAE,eAAuB;QAC5E,MAAM,WAAW,GAAiE,EAAE,CAAC;QACrF,yEAAyE;QACzE,MAAM,YAAY,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC1C,IAAI,IAAY,CAAC;QACjB,IAAI;YACF,IAAI,WAAgC,CAAC;YACrC,KAAK,IAAI,IAAI,YAAY,EAAE;gBACzB,IAAI,WAAW,EAAE;oBACf,MAAM,SAAS,GAAG,IAAA,wBAAa,EAAC,WAAW,CAAC,SAAS,CAAC,CAAC;oBACvD,WAAW,GAAG,IAAA,wBAAa,EAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;iBAC9C;qBAAM;oBACL,WAAW,GAAG,IAAA,wBAAa,EAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;iBACnD;gBAED,+GAA+G;gBAC/G,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;aACzC;SACF;QAAC,OAAO,KAAK,EAAE;YACd,IAAI,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;gBAC5B,+FAA+F;gBAC/F,OAAO,WAAW,CAAC;aACpB;iBAAM,IAAI,eAAe,KAAK,CAAC,EAAE;gBAChC,cAAM,CAAC,IAAI,CAAC,SAAS,EAAE,aAAa,IAAI,gCAAgC,SAAS,EAAE,CAAC,CAAC;aACtF;iBAAM,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE;gBACnC,kGAAkG;gBAClG,WAAW,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;gBAC9C,WAAW,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,IAAI,IAAA,iBAAS,EAAC,OAAO,CAAC,WAAqB,CAAC,CAAC;aACnG;SACF;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;IAEO,KAAK,CAAC,eAAe,CAC3B,KAAa,EACb,QAAgB,EAChB,OAAmB,EACnB,WAAoB;QAEpB,oCAAoC;QACpC,IAAI,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YAClC,OAAO,EAAE,CAAC;SACX;QAED,MAAM,cAAc,GAAG,IAAI,iBAAO,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;QAC1E,MAAM,cAAc,CAAC,KAAK,EAAE,CAAC;QAC7B,OAAO,cAAc,CAAC,WAAW,EAAE,CAAC;IACtC,CAAC;CACF;AArOD,oBAqOC"}
@@ -1 +1 @@
1
- {"version":"1.4.6","commands":{"commandreference:generate":{"id":"commandreference:generate","description":"generate the command reference guide located","strict":true,"usage":"<%= command.id %> [-d <string>] [-p <array>] [--hidden] [--erroronwarnings] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-command-reference","pluginAlias":"@salesforce/plugin-command-reference","pluginType":"core","aliases":[],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"outputdir":{"name":"outputdir","type":"option","char":"d","description":"output directory to put generated files","multiple":false,"default":"./tmp/root"},"plugins":{"name":"plugins","type":"option","char":"p","description":"comma separated list of plugin names to be part of the generation. Defaults to the oclif plugin in the current working directory","multiple":false},"hidden":{"name":"hidden","type":"boolean","description":"show hidden commands","allowNo":false},"erroronwarnings":{"name":"erroronwarnings","type":"boolean","description":"fail the command if there are any warnings","allowNo":false}},"args":[{"name":"file"}],"flagsConfig":{"outputdir":{"kind":"string","char":"d","description":"output directory to put generated files","default":"./tmp/root","input":[],"multiple":false,"type":"option"},"plugins":{"kind":"array","char":"p","description":"comma separated list of plugin names to be part of the generation. Defaults to the oclif plugin in the current working directory","input":[],"multiple":false,"type":"option"},"hidden":{"kind":"boolean","description":"show hidden commands","allowNo":false,"type":"boolean"},"erroronwarnings":{"kind":"boolean","description":"fail the command if there are any warnings","allowNo":false,"type":"boolean"}}}}}
1
+ {"version":"1.5.0","commands":{"commandreference:generate":{"id":"commandreference:generate","description":"generate the command reference guide located","strict":true,"usage":"<%= command.id %> [-d <string>] [-p <array>] [--hidden] [--erroronwarnings] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]","pluginName":"@salesforce/plugin-command-reference","pluginAlias":"@salesforce/plugin-command-reference","pluginType":"core","aliases":[],"flags":{"json":{"name":"json","type":"boolean","description":"format output as json","allowNo":false},"loglevel":{"name":"loglevel","type":"option","description":"logging level for this command invocation","required":false,"helpValue":"(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)","multiple":false,"options":["trace","debug","info","warn","error","fatal","TRACE","DEBUG","INFO","WARN","ERROR","FATAL"],"default":"warn"},"outputdir":{"name":"outputdir","type":"option","char":"d","description":"output directory to put generated files","multiple":false,"default":"./tmp/root"},"plugins":{"name":"plugins","type":"option","char":"p","description":"comma separated list of plugin names to be part of the generation. Defaults to the oclif plugin in the current working directory","multiple":false},"hidden":{"name":"hidden","type":"boolean","description":"show hidden commands","allowNo":false},"erroronwarnings":{"name":"erroronwarnings","type":"boolean","description":"fail the command if there are any warnings","allowNo":false}},"args":[{"name":"file"}],"flagsConfig":{"outputdir":{"kind":"string","char":"d","description":"output directory to put generated files","default":"./tmp/root","input":[],"multiple":false,"type":"option"},"plugins":{"kind":"array","char":"p","description":"comma separated list of plugin names to be part of the generation. Defaults to the oclif plugin in the current working directory","input":[],"multiple":false,"type":"option"},"hidden":{"kind":"boolean","description":"show hidden commands","allowNo":false,"type":"boolean"},"erroronwarnings":{"kind":"boolean","description":"fail the command if there are any warnings","allowNo":false,"type":"boolean"}}}}}
package/package.json CHANGED
@@ -1,11 +1,11 @@
1
1
  {
2
2
  "name": "@salesforce/plugin-command-reference",
3
3
  "description": "Generate the Salesforce CLI command reference guide",
4
- "version": "1.4.6",
4
+ "version": "1.5.0",
5
5
  "author": "Salesforce",
6
6
  "bugs": "https://github.com/forcedotcom/plugin-command-reference/issues",
7
7
  "dependencies": {
8
- "@salesforce/command": "^5.2.12",
8
+ "@salesforce/command": "^5.2.15",
9
9
  "@salesforce/core": "^3.31.10",
10
10
  "@types/lodash.uniqby": "^4.7.7",
11
11
  "chalk": "^3.0.0",
@@ -17,27 +17,27 @@
17
17
  "devDependencies": {
18
18
  "@salesforce/dev-config": "^3.1.0",
19
19
  "@salesforce/dev-scripts": "^3.1.0",
20
- "@salesforce/plugin-alias": "^2.1.5",
21
- "@salesforce/plugin-signups": "^1.2.7",
20
+ "@salesforce/plugin-alias": "^2.1.6",
21
+ "@salesforce/plugin-signups": "^1.2.10",
22
22
  "@salesforce/prettier-config": "^0.0.2",
23
23
  "@semantic-release/changelog": "^5.0.0",
24
24
  "@semantic-release/git": "^9.0.1",
25
25
  "@types/shelljs": "^0.8.11",
26
26
  "@typescript-eslint/eslint-plugin": "^5.40.0",
27
- "@typescript-eslint/parser": "^5.40.0",
27
+ "@typescript-eslint/parser": "^5.40.1",
28
28
  "chai": "^4.3.6",
29
- "eslint": "^8.25.0",
29
+ "eslint": "^8.26.0",
30
30
  "eslint-config-prettier": "^8.5.0",
31
31
  "eslint-config-salesforce": "^1.1.0",
32
32
  "eslint-config-salesforce-license": "^0.1.6",
33
33
  "eslint-config-salesforce-typescript": "^1.1.1",
34
34
  "eslint-plugin-header": "^3.0.0",
35
35
  "eslint-plugin-import": "2.26.0",
36
- "eslint-plugin-jsdoc": "^39.3.6",
36
+ "eslint-plugin-jsdoc": "^39.3.25",
37
37
  "husky": "^7.0.4",
38
38
  "mocha": "^9.1.3",
39
39
  "nyc": "^15.1.0",
40
- "oclif": "^3.2.16",
40
+ "oclif": "^3.2.21",
41
41
  "prettier": "^2.7.1",
42
42
  "pretty-quick": "^3.1.3",
43
43
  "salesforce-alm": "^54.8.1",