@salesforce/plugin-command-reference 3.0.88 → 3.0.89

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
@@ -130,7 +130,7 @@ EXAMPLES
130
130
  $ sf commandreference generate --all --config-path /path/to/plugin --output-dir ./docs
131
131
  ```
132
132
 
133
- _See code: [src/commands/commandreference/generate.ts](https://github.com/salesforcecli/plugin-command-reference/blob/3.0.88/src/commands/commandreference/generate.ts)_
133
+ _See code: [src/commands/commandreference/generate.ts](https://github.com/salesforcecli/plugin-command-reference/blob/3.0.89/src/commands/commandreference/generate.ts)_
134
134
 
135
135
  ## `sf jit install`
136
136
 
@@ -151,6 +151,6 @@ EXAMPLES
151
151
  $ sf jit install
152
152
  ```
153
153
 
154
- _See code: [src/commands/jit/install.ts](https://github.com/salesforcecli/plugin-command-reference/blob/3.0.88/src/commands/jit/install.ts)_
154
+ _See code: [src/commands/jit/install.ts](https://github.com/salesforcecli/plugin-command-reference/blob/3.0.89/src/commands/jit/install.ts)_
155
155
 
156
156
  <!-- commandsstop -->
@@ -8,14 +8,18 @@ import { join } from 'node:path';
8
8
  import { asString, ensureObject, ensureString } from '@salesforce/ts-types';
9
9
  import { punctuate, replaceConfigVariables } from '../utils.js';
10
10
  import { Ditamap } from './ditamap.js';
11
- const getDefault = async (flag) => {
11
+ const getDefault = async (flag, flagName) => {
12
12
  if (!flag) {
13
13
  return '';
14
14
  }
15
+ if (flagName === 'target-org' || flagName === 'target-dev-hub') {
16
+ // special handling to prevent global/local default usernames from appearing in the docs, but they do appear in user's help
17
+ return '';
18
+ }
15
19
  if (typeof flag.default === 'function') {
16
20
  try {
17
21
  const help = await flag.default();
18
- return help || '';
22
+ return help.includes('[object Object]') ? '' : help ?? '';
19
23
  }
20
24
  catch {
21
25
  return '';
@@ -35,14 +39,15 @@ export class Command extends Ditamap {
35
39
  super(filename, undefined);
36
40
  this.flags = ensureObject(command.flags);
37
41
  this.commandMeta = commandMeta;
42
+ const binary = readBinary(this.commandMeta);
38
43
  const summary = punctuate(command.summary);
39
44
  this.commandName = command.id.replace(/:/g, asString(this.commandMeta.topicSeparator, ':'));
40
45
  const description = command.description
41
- ? replaceConfigVariables(command.description, asString(this.commandMeta.binary, 'unknown'), this.commandName)
46
+ ? replaceConfigVariables(command.description, binary, this.commandName)
42
47
  : undefined;
43
48
  // Help are all the lines after the first line in the description. Before oclif, there was a 'help' property so continue to
44
49
  // support that.
45
- const help = this.formatParagraphs(description);
50
+ const help = formatParagraphs(description);
46
51
  let trailblazerCommunityUrl;
47
52
  let trailblazerCommunityName;
48
53
  if (this.commandMeta.trailblazerCommunityLink) {
@@ -63,8 +68,8 @@ export class Command extends Ditamap {
63
68
  commands = [example.command];
64
69
  }
65
70
  return {
66
- description: replaceConfigVariables(desc ?? '', asString(this.commandMeta.binary, 'unknown'), this.commandName),
67
- commands: commands.map((cmd) => replaceConfigVariables(cmd, asString(this.commandMeta.binary, 'unknown'), this.commandName)),
71
+ description: replaceConfigVariables(desc ?? '', binary, this.commandName),
72
+ commands: commands.map((cmd) => replaceConfigVariables(cmd, binary, this.commandName)),
68
73
  };
69
74
  });
70
75
  const state = command.state ?? this.commandMeta.state;
@@ -72,7 +77,7 @@ export class Command extends Ditamap {
72
77
  name: this.commandName,
73
78
  summary,
74
79
  description,
75
- binary: 'binary' in commandMeta && typeof commandMeta.binary === 'string' ? commandMeta.binary : 'unknown',
80
+ binary,
76
81
  commandWithUnderscores,
77
82
  deprecated: command.deprecated ?? state === 'deprecated' ?? false,
78
83
  examples,
@@ -87,26 +92,19 @@ export class Command extends Ditamap {
87
92
  this.destination = join(Ditamap.outputDir, topic, filename);
88
93
  }
89
94
  async getParametersForTemplate(flags) {
90
- const final = [];
91
- for (const [flagName, flag] of Object.entries(flags)) {
92
- if (!flag || flag.hidden)
93
- continue;
94
- const description = replaceConfigVariables(Array.isArray(flag?.description) ? flag?.description.join('\n') : flag?.description ?? '', asString(this.commandMeta.binary, 'unknown'), this.commandName);
95
- const entireDescription = flag.summary
96
- ? `${replaceConfigVariables(flag.summary, asString(this.commandMeta.binary, 'unknown'), this.commandName)}\n${description}`
97
- : description;
98
- const updated = Object.assign({}, flag, {
99
- name: flagName,
100
- description: this.formatParagraphs(entireDescription),
101
- optional: !flag?.required,
102
- kind: flag?.kind ?? flag?.type,
103
- hasValue: flag?.type !== 'boolean',
104
- // eslint-disable-next-line no-await-in-loop
105
- defaultFlagValue: await getDefault(flag),
106
- });
107
- final.push(updated);
108
- }
109
- return final;
95
+ const descriptionBuilder = buildDescription(this.commandName)(readBinary(this.commandMeta));
96
+ return Promise.all([...Object.entries(flags)]
97
+ .filter(flagIsDefined)
98
+ .filter(([, flag]) => !flag.hidden)
99
+ .map(async ([flagName, flag]) => ({
100
+ ...flag,
101
+ name: flagName,
102
+ description: descriptionBuilder(flag),
103
+ optional: !flag.required,
104
+ kind: flag.kind ?? flag.type,
105
+ hasValue: flag.type !== 'boolean',
106
+ defaultFlagValue: await getDefault(flag, flagName),
107
+ })));
110
108
  }
111
109
  // eslint-disable-next-line class-methods-use-this
112
110
  getTemplateFileName() {
@@ -118,4 +116,11 @@ export class Command extends Ditamap {
118
116
  return super.transformToDitamap();
119
117
  }
120
118
  }
119
+ const flagIsDefined = (input) => input[1] !== undefined;
120
+ const buildDescription = (commandName) => (binary) => (flag) => {
121
+ const description = replaceConfigVariables(Array.isArray(flag?.description) ? flag?.description.join('\n') : flag?.description ?? '', binary, commandName);
122
+ return formatParagraphs(flag.summary ? `${replaceConfigVariables(flag.summary, binary, commandName)}\n${description}` : description);
123
+ };
124
+ const formatParagraphs = (textToFormat) => textToFormat ? textToFormat.split('\n').filter((n) => n !== '') : [];
125
+ const readBinary = (commandMeta) => 'binary' in commandMeta && typeof commandMeta.binary === 'string' ? commandMeta.binary : 'unknown';
121
126
  //# sourceMappingURL=command.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"command.js","sourceRoot":"","sources":["../../src/ditamap/command.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,QAAQ,EAAc,YAAY,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACxF,OAAO,EAAmD,SAAS,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AACjH,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAavC,MAAM,UAAU,GAAG,KAAK,EAAE,IAAe,EAAmB,EAAE;IAC5D,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,IAAI,OAAO,IAAI,CAAC,OAAO,KAAK,UAAU,EAAE,CAAC;QACvC,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;YAClC,OAAO,IAAI,IAAI,EAAE,CAAC;QACpB,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,EAAE,CAAC;QACZ,CAAC;IACH,CAAC;SAAM,CAAC;QACN,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,OAAO,OAAQ,SAAQ,OAAO;IAC1B,KAAK,CAAuB;IAC5B,WAAW,CAA0B;IACrC,WAAW,CAAS;IAE5B,YACE,KAAa,EACb,QAAuB,EACvB,OAAqB,EACrB,cAAuC,EAAE;QAEzC,MAAM,sBAAsB,GAAG,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAC3E,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,iBAAiB,sBAAsB,EAAE,EAAE,KAAK,CAAC,CAAC;QAEhF,KAAK,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QAE3B,IAAI,CAAC,KAAK,GAAG,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACzC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAE/B,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAC3C,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC,CAAC;QAE5F,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW;YACrC,CAAC,CAAC,sBAAsB,CAAC,OAAO,CAAC,WAAW,EAAE,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,SAAS,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC;YAC7G,CAAC,CAAC,SAAS,CAAC;QAEd,2HAA2H;QAC3H,gBAAgB;QAEhB,MAAM,IAAI,GAAG,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;QAEhD,IAAI,uBAA2C,CAAC;QAChD,IAAI,wBAA4C,CAAC;QAEjD,IAAI,IAAI,CAAC,WAAW,CAAC,wBAAwB,EAAE,CAAC;YAC9C,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,wBAAyD,CAAC;YAC7F,uBAAuB,GAAG,SAAS,CAAC,GAAG,IAAI,SAAS,CAAC;YACrD,wBAAwB,GAAG,SAAS,CAAC,IAAI,IAAI,SAAS,CAAC;QACzD,CAAC;QAED,MAAM,QAAQ,GAAG,CAAC,OAAO,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;YACxD,IAAI,IAAmB,CAAC;YACxB,IAAI,QAAkB,CAAC;YACvB,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;gBAChC,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBAClC,IAAI,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;gBAC1C,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;YAC5D,CAAC;iBAAM,CAAC;gBACN,IAAI,GAAG,OAAO,CAAC,WAAW,CAAC;gBAC3B,QAAQ,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAC/B,CAAC;YAED,OAAO;gBACL,WAAW,EAAE,sBAAsB,CAAC,IAAI,IAAI,EAAE,EAAE,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,SAAS,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC;gBAC/G,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAC7B,sBAAsB,CAAC,GAAG,EAAE,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,SAAS,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAC5F;aACF,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC;QACtD,MAAM,WAAW,GAAgB;YAC/B,IAAI,EAAE,IAAI,CAAC,WAAW;YACtB,OAAO;YACP,WAAW;YACX,MAAM,EAAE,QAAQ,IAAI,WAAW,IAAI,OAAO,WAAW,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;YAC1G,sBAAsB;YACtB,UAAU,EAAG,OAAO,CAAC,UAAsB,IAAI,KAAK,KAAK,YAAY,IAAI,KAAK;YAC9E,QAAQ;YACR,IAAI;YACJ,aAAa,EAAE,KAAK,KAAK,MAAM;YAC/B,oBAAoB,EAAE,KAAK,KAAK,aAAa;YAC7C,kBAAkB,EAAE,KAAK,KAAK,WAAW;YACzC,wBAAwB;YACxB,uBAAuB;SACxB,CAAC;QAEF,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;QAEhD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC9D,CAAC;IAEM,KAAK,CAAC,wBAAwB,CAAC,KAA2B;QAC/D,MAAM,KAAK,GAA2B,EAAE,CAAC;QAEzC,KAAK,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACrD,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM;gBAAE,SAAS;YACnC,MAAM,WAAW,GAAG,sBAAsB,CACxC,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,WAAW,IAAI,EAAE,EACzF,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,SAAS,CAAC,EAC5C,IAAI,CAAC,WAAW,CACjB,CAAC;YACF,MAAM,iBAAiB,GAAG,IAAI,CAAC,OAAO;gBACpC,CAAC,CAAC,GAAG,sBAAsB,CACvB,IAAI,CAAC,OAAO,EACZ,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,SAAS,CAAC,EAC5C,IAAI,CAAC,WAAW,CACjB,KAAK,WAAW,EAAE;gBACrB,CAAC,CAAC,WAAW,CAAC;YAChB,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,EAAE,QAAQ;gBACzB,IAAI,EAAE,IAAI,EAAE,IAAI,IAAI,IAAI,EAAE,IAAI;gBAC9B,QAAQ,EAAE,IAAI,EAAE,IAAI,KAAK,SAAS;gBAClC,4CAA4C;gBAC5C,gBAAgB,EAAE,MAAM,UAAU,CAAC,IAAI,CAAC;aACzC,CAAC,CAAC;YACH,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACtB,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,kDAAkD;IAC3C,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"}
1
+ {"version":3,"file":"command.js","sourceRoot":"","sources":["../../src/ditamap/command.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,QAAQ,EAAc,YAAY,EAAE,YAAY,EAAY,MAAM,sBAAsB,CAAC;AAClG,OAAO,EAAmD,SAAS,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AACjH,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAavC,MAAM,UAAU,GAAG,KAAK,EAAE,IAAc,EAAE,QAAgB,EAAmB,EAAE;IAC7E,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,IAAI,QAAQ,KAAK,YAAY,IAAI,QAAQ,KAAK,gBAAgB,EAAE,CAAC;QAC/D,2HAA2H;QAC3H,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,IAAI,OAAO,IAAI,CAAC,OAAO,KAAK,UAAU,EAAE,CAAC;QACvC,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;YAClC,OAAO,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;QAC5D,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,EAAE,CAAC;QACZ,CAAC;IACH,CAAC;SAAM,CAAC;QACN,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,OAAO,OAAQ,SAAQ,OAAO;IAC1B,KAAK,CAAuB;IAC5B,WAAW,CAA0B;IACrC,WAAW,CAAS;IAE5B,YACE,KAAa,EACb,QAAuB,EACvB,OAAqB,EACrB,cAAuC,EAAE;QAEzC,MAAM,sBAAsB,GAAG,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAC3E,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,iBAAiB,sBAAsB,EAAE,EAAE,KAAK,CAAC,CAAC;QAChF,KAAK,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QAE3B,IAAI,CAAC,KAAK,GAAG,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACzC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAE5C,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAC3C,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC,CAAC;QAE5F,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW;YACrC,CAAC,CAAC,sBAAsB,CAAC,OAAO,CAAC,WAAW,EAAE,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC;YACvE,CAAC,CAAC,SAAS,CAAC;QAEd,2HAA2H;QAC3H,gBAAgB;QAEhB,MAAM,IAAI,GAAG,gBAAgB,CAAC,WAAW,CAAC,CAAC;QAE3C,IAAI,uBAA2C,CAAC;QAChD,IAAI,wBAA4C,CAAC;QAEjD,IAAI,IAAI,CAAC,WAAW,CAAC,wBAAwB,EAAE,CAAC;YAC9C,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,wBAAyD,CAAC;YAC7F,uBAAuB,GAAG,SAAS,CAAC,GAAG,IAAI,SAAS,CAAC;YACrD,wBAAwB,GAAG,SAAS,CAAC,IAAI,IAAI,SAAS,CAAC;QACzD,CAAC;QAED,MAAM,QAAQ,GAAG,CAAC,OAAO,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;YACxD,IAAI,IAAmB,CAAC;YACxB,IAAI,QAAkB,CAAC;YACvB,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;gBAChC,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBAClC,IAAI,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;gBAC1C,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;YAC5D,CAAC;iBAAM,CAAC;gBACN,IAAI,GAAG,OAAO,CAAC,WAAW,CAAC;gBAC3B,QAAQ,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAC/B,CAAC;YAED,OAAO;gBACL,WAAW,EAAE,sBAAsB,CAAC,IAAI,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC;gBACzE,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,sBAAsB,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;aACvF,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC;QACtD,MAAM,WAAW,GAAgB;YAC/B,IAAI,EAAE,IAAI,CAAC,WAAW;YACtB,OAAO;YACP,WAAW;YACX,MAAM;YACN,sBAAsB;YACtB,UAAU,EAAG,OAAO,CAAC,UAAsB,IAAI,KAAK,KAAK,YAAY,IAAI,KAAK;YAC9E,QAAQ;YACR,IAAI;YACJ,aAAa,EAAE,KAAK,KAAK,MAAM;YAC/B,oBAAoB,EAAE,KAAK,KAAK,aAAa;YAC7C,kBAAkB,EAAE,KAAK,KAAK,WAAW;YACzC,wBAAwB;YACxB,uBAAuB;SACxB,CAAC;QAEF,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;QAEhD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC9D,CAAC;IAEM,KAAK,CAAC,wBAAwB,CAAC,KAA2B;QAC/D,MAAM,kBAAkB,GAAG,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;QAC5F,OAAO,OAAO,CAAC,GAAG,CAChB,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;aACvB,MAAM,CAAC,aAAa,CAAC;aACrB,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;aAClC,GAAG,CACF,KAAK,EAAE,CAAC,QAAQ,EAAE,IAAI,CAAC,EAAE,EAAE,CACzB,CAAC;YACC,GAAG,IAAI;YACP,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,kBAAkB,CAAC,IAAI,CAAC;YACrC,QAAQ,EAAE,CAAC,IAAI,CAAC,QAAQ;YACxB,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI;YAC5B,QAAQ,EAAE,IAAI,CAAC,IAAI,KAAK,SAAS;YACjC,gBAAgB,EAAE,MAAM,UAAU,CAAC,IAAI,EAAE,QAAQ,CAAC;SACpB,CAAC,CACpC,CACJ,CAAC;IACJ,CAAC;IAED,kDAAkD;IAC3C,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;AAED,MAAM,aAAa,GAAG,CAAC,KAAmC,EAA+B,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC;AAEnH,MAAM,gBAAgB,GACpB,CAAC,WAAmB,EAAE,EAAE,CACxB,CAAC,MAAc,EAAE,EAAE,CACnB,CAAC,IAAc,EAAY,EAAE;IAC3B,MAAM,WAAW,GAAG,sBAAsB,CACxC,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,WAAW,IAAI,EAAE,EACzF,MAAM,EACN,WAAW,CACZ,CAAC;IACF,OAAO,gBAAgB,CACrB,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,sBAAsB,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,KAAK,WAAW,EAAE,CAAC,CAAC,CAAC,WAAW,CAC5G,CAAC;AACJ,CAAC,CAAC;AAEJ,MAAM,gBAAgB,GAAG,CAAC,YAAqB,EAAY,EAAE,CAC3D,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;AAEvE,MAAM,UAAU,GAAG,CAAC,WAAoC,EAAU,EAAE,CAClE,QAAQ,IAAI,WAAW,IAAI,OAAO,WAAW,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC"}
@@ -21,7 +21,6 @@ export declare abstract class Ditamap {
21
21
  getFilename(): string;
22
22
  getOutputFilePath(): string;
23
23
  write(): Promise<void>;
24
- protected formatParagraphs(textToFormat?: string): string[];
25
24
  /**
26
25
  * Applies the named handlebars template to the supplied data
27
26
  *
@@ -68,10 +68,6 @@ export class Ditamap {
68
68
  const output = await this.transformToDitamap();
69
69
  await fs.writeFile(this.destination, output);
70
70
  }
71
- // eslint-disable-next-line class-methods-use-this
72
- formatParagraphs(textToFormat) {
73
- return textToFormat ? textToFormat.split('\n').filter((n) => n !== '') : [];
74
- }
75
71
  /**
76
72
  * Applies the named handlebars template to the supplied data
77
73
  *
@@ -1 +1 @@
1
- {"version":3,"file":"ditamap.js","sourceRoot":"","sources":["../../src/ditamap/ditamap.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAClC,OAAO,YAAY,MAAM,OAAO,CAAC;AACjC,OAAO,EAAE,MAAM,YAAY,CAAC;AAI5B,MAAM,KAAK,GAAG,YAAY,CAAC,kBAAkB,CAAC,CAAC;AAE/C,EAAE,CAAC,cAAc,CAAC,aAAa,EAAE,CAAC,GAAW,EAAE,EAAE,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC;AACrE,EAAE,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,KAAe,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;AACjE,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,8DAA8D;AAC9D,EAAE,CAAC,cAAc,CAAC,aAAa,EAAE,UAAqB,GAAW,EAAE,OAAsB;IACvF,OAAO,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC;QAC9F,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,KAAa,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;AAE5E,MAAM,OAAgB,OAAO;IAsBG;IAA4B;IArBnD,MAAM,CAAC,MAAM,GAAG,SAAS,CAAC;IAE1B,MAAM,CAAC,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC;IAE7F,MAAM,CAAC,SAAS,CAAS;IAEzB,MAAM,CAAC,UAAU,CAAS;IAE1B,MAAM,CAAC,OAAO,CAAyB;IAEvC,MAAM,CAAC,cAAc,CAGzB;IAEK,MAAM,CAAC,OAAO,CAAS;IAErB,WAAW,CAAS;IAEb,MAAM,CAAS;IAEhC,YAA8B,QAAgB,EAAY,IAAiB;QAA7C,aAAQ,GAAR,QAAQ,CAAQ;QAAY,SAAI,GAAJ,IAAI,CAAa;QACzE,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC;QACrE,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IACvD,CAAC;IAEM,MAAM,KAAK,MAAM;QACtB,OAAO,OAAO,CAAC,OAAO,CAAC;IACzB,CAAC;IAEM,MAAM,KAAK,MAAM,CAAC,MAAc;QACrC,OAAO,CAAC,OAAO,GAAG,MAAM,CAAC;IAC3B,CAAC;IAEM,MAAM,CAAC,IAAI,CAAC,IAAY,EAAE,GAAW;QAC1C,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,OAAO,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,GAAG,EAAE,CAAC;IAChF,CAAC;IAEM,WAAW;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAEM,iBAAiB;QACtB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAEM,KAAK,CAAC,KAAK;QAChB,MAAM,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC/D,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;IAED,kDAAkD;IACxC,gBAAgB,CAAC,YAAqB;QAC9C,OAAO,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC9E,CAAC;IAED;;;;;;OAMG;IACO,KAAK,CAAC,kBAAkB;QAChC,EAAE;QACF,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"}
1
+ {"version":3,"file":"ditamap.js","sourceRoot":"","sources":["../../src/ditamap/ditamap.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAClC,OAAO,YAAY,MAAM,OAAO,CAAC;AACjC,OAAO,EAAE,MAAM,YAAY,CAAC;AAI5B,MAAM,KAAK,GAAG,YAAY,CAAC,kBAAkB,CAAC,CAAC;AAE/C,EAAE,CAAC,cAAc,CAAC,aAAa,EAAE,CAAC,GAAW,EAAE,EAAE,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC;AACrE,EAAE,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,KAAe,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;AACjE,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,8DAA8D;AAC9D,EAAE,CAAC,cAAc,CAAC,aAAa,EAAE,UAAqB,GAAW,EAAE,OAAsB;IACvF,OAAO,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC;QAC9F,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,KAAa,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;AAE5E,MAAM,OAAgB,OAAO;IAsBG;IAA4B;IArBnD,MAAM,CAAC,MAAM,GAAG,SAAS,CAAC;IAE1B,MAAM,CAAC,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC;IAE7F,MAAM,CAAC,SAAS,CAAS;IAEzB,MAAM,CAAC,UAAU,CAAS;IAE1B,MAAM,CAAC,OAAO,CAAyB;IAEvC,MAAM,CAAC,cAAc,CAGzB;IAEK,MAAM,CAAC,OAAO,CAAS;IAErB,WAAW,CAAS;IAEb,MAAM,CAAS;IAEhC,YAA8B,QAAgB,EAAY,IAAiB;QAA7C,aAAQ,GAAR,QAAQ,CAAQ;QAAY,SAAI,GAAJ,IAAI,CAAa;QACzE,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC;QACrE,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IACvD,CAAC;IAEM,MAAM,KAAK,MAAM;QACtB,OAAO,OAAO,CAAC,OAAO,CAAC;IACzB,CAAC;IAEM,MAAM,KAAK,MAAM,CAAC,MAAc;QACrC,OAAO,CAAC,OAAO,GAAG,MAAM,CAAC;IAC3B,CAAC;IAEM,MAAM,CAAC,IAAI,CAAC,IAAY,EAAE,GAAW;QAC1C,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,OAAO,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,GAAG,EAAE,CAAC;IAChF,CAAC;IAEM,WAAW;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAEM,iBAAiB;QACtB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAEM,KAAK,CAAC,KAAK;QAChB,MAAM,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC/D,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;IAED;;;;;;OAMG;IACO,KAAK,CAAC,kBAAkB;QAChC,EAAE;QACF,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"}
package/lib/utils.d.ts CHANGED
@@ -38,6 +38,7 @@ type ClIRefTopicData = {
38
38
  longDescription?: string;
39
39
  };
40
40
  export type CommandParameterData = {
41
+ description: string[];
41
42
  optional?: boolean;
42
43
  char?: string;
43
44
  name: string;