@salesforce/plugin-command-reference 3.0.75 → 3.0.77
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 +9 -7
- package/lib/commands/commandreference/generate.js +68 -70
- package/lib/commands/commandreference/generate.js.map +1 -1
- package/lib/commands/jit/install.d.ts +1 -1
- package/lib/commands/jit/install.js +14 -17
- package/lib/commands/jit/install.js.map +1 -1
- package/lib/ditamap/base-ditamap.d.ts +1 -1
- package/lib/ditamap/base-ditamap.js +4 -8
- package/lib/ditamap/base-ditamap.js.map +1 -1
- package/lib/ditamap/cli-reference.d.ts +1 -1
- package/lib/ditamap/cli-reference.js +5 -9
- package/lib/ditamap/cli-reference.js.map +1 -1
- package/lib/ditamap/command.d.ts +2 -2
- package/lib/ditamap/command.js +19 -20
- package/lib/ditamap/command.js.map +1 -1
- package/lib/ditamap/ditamap.d.ts +1 -1
- package/lib/ditamap/ditamap.js +20 -14
- package/lib/ditamap/ditamap.js.map +1 -1
- package/lib/ditamap/help-reference.d.ts +1 -1
- package/lib/ditamap/help-reference.js +3 -7
- package/lib/ditamap/help-reference.js.map +1 -1
- package/lib/ditamap/topic-commands.d.ts +2 -2
- package/lib/ditamap/topic-commands.js +5 -9
- package/lib/ditamap/topic-commands.js.map +1 -1
- package/lib/ditamap/topic-ditamap.d.ts +1 -1
- package/lib/ditamap/topic-ditamap.js +5 -9
- package/lib/ditamap/topic-ditamap.js.map +1 -1
- package/lib/docs.d.ts +1 -1
- package/lib/docs.js +33 -33
- package/lib/docs.js.map +1 -1
- package/lib/index.js +1 -3
- package/lib/index.js.map +1 -1
- package/lib/utils.d.ts +2 -2
- package/lib/utils.js +6 -11
- package/lib/utils.js.map +1 -1
- package/npm-shrinkwrap.json +1980 -1851
- package/oclif.lock +1032 -897
- package/oclif.manifest.json +29 -5
- package/package.json +17 -16
package/lib/ditamap/ditamap.js
CHANGED
|
@@ -1,16 +1,14 @@
|
|
|
1
|
-
"use strict";
|
|
2
1
|
/*
|
|
3
2
|
* Copyright (c) 2018, salesforce.com, inc.
|
|
4
3
|
* All rights reserved.
|
|
5
4
|
* Licensed under the BSD 3-Clause license.
|
|
6
5
|
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
7
6
|
*/
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
const hb = require("handlebars");
|
|
7
|
+
import { dirname, join } from 'node:path';
|
|
8
|
+
import { fileURLToPath } from 'node:url';
|
|
9
|
+
import fs from 'node:fs/promises';
|
|
10
|
+
import debugCreator from 'debug';
|
|
11
|
+
import hb from 'handlebars';
|
|
14
12
|
const debug = debugCreator('commandreference');
|
|
15
13
|
hb.registerHelper('toUpperCase', (str) => str.toUpperCase());
|
|
16
14
|
hb.registerHelper('join', (array) => array.join(', '));
|
|
@@ -32,12 +30,23 @@ hb.registerHelper('isCodeBlock', function (val, options) {
|
|
|
32
30
|
: options.inverse(this);
|
|
33
31
|
});
|
|
34
32
|
hb.registerHelper('nextVersion', (value) => parseInt(value, 2) + 1);
|
|
35
|
-
class Ditamap {
|
|
33
|
+
export class Ditamap {
|
|
34
|
+
filename;
|
|
35
|
+
data;
|
|
36
|
+
static SUFFIX = 'unified';
|
|
37
|
+
static templatesDir = join(dirname(fileURLToPath(import.meta.url)), '..', '..', 'templates');
|
|
38
|
+
static outputDir;
|
|
39
|
+
static cliVersion;
|
|
40
|
+
static plugins;
|
|
41
|
+
static pluginVersions;
|
|
42
|
+
static _suffix;
|
|
43
|
+
destination;
|
|
44
|
+
source;
|
|
36
45
|
constructor(filename, data) {
|
|
37
46
|
this.filename = filename;
|
|
38
47
|
this.data = data;
|
|
39
|
-
this.source =
|
|
40
|
-
this.destination =
|
|
48
|
+
this.source = join(Ditamap.templatesDir, this.getTemplateFileName());
|
|
49
|
+
this.destination = join(Ditamap.outputDir, filename);
|
|
41
50
|
}
|
|
42
51
|
static get suffix() {
|
|
43
52
|
return Ditamap._suffix;
|
|
@@ -55,7 +64,7 @@ class Ditamap {
|
|
|
55
64
|
return this.destination;
|
|
56
65
|
}
|
|
57
66
|
async write() {
|
|
58
|
-
await fs.mkdir(
|
|
67
|
+
await fs.mkdir(dirname(this.destination), { recursive: true });
|
|
59
68
|
const output = await this.transformToDitamap();
|
|
60
69
|
await fs.writeFile(this.destination, output);
|
|
61
70
|
}
|
|
@@ -78,7 +87,4 @@ class Ditamap {
|
|
|
78
87
|
return template(this.data);
|
|
79
88
|
}
|
|
80
89
|
}
|
|
81
|
-
exports.Ditamap = Ditamap;
|
|
82
|
-
Ditamap.SUFFIX = 'unified';
|
|
83
|
-
Ditamap.templatesDir = (0, node_path_1.join)(__dirname, '..', '..', 'templates');
|
|
84
90
|
//# sourceMappingURL=ditamap.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ditamap.js","sourceRoot":"","sources":["../../src/ditamap/ditamap.ts"],"names":[],"mappings":"
|
|
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,17 +1,14 @@
|
|
|
1
|
-
"use strict";
|
|
2
1
|
/*
|
|
3
2
|
* Copyright (c) 2018, salesforce.com, inc.
|
|
4
3
|
* All rights reserved.
|
|
5
4
|
* Licensed under the BSD 3-Clause license.
|
|
6
5
|
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
7
6
|
*/
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
const ditamap_1 = require("./ditamap");
|
|
11
|
-
class HelpReference extends ditamap_1.Ditamap {
|
|
7
|
+
import { Ditamap } from './ditamap.js';
|
|
8
|
+
export class HelpReference extends Ditamap {
|
|
12
9
|
constructor() {
|
|
13
10
|
// Set the data of topic and filenames
|
|
14
|
-
const filename =
|
|
11
|
+
const filename = Ditamap.file('cli_reference_help', 'xml');
|
|
15
12
|
super(filename, {
|
|
16
13
|
id: filename.replace('.xml', ''),
|
|
17
14
|
});
|
|
@@ -21,5 +18,4 @@ class HelpReference extends ditamap_1.Ditamap {
|
|
|
21
18
|
return 'cli_reference_help.hbs';
|
|
22
19
|
}
|
|
23
20
|
}
|
|
24
|
-
exports.HelpReference = HelpReference;
|
|
25
21
|
//# sourceMappingURL=help-reference.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"help-reference.js","sourceRoot":"","sources":["../../src/ditamap/help-reference.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"help-reference.js","sourceRoot":"","sources":["../../src/ditamap/help-reference.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAEvC,MAAM,OAAO,aAAc,SAAQ,OAAO;IACxC;QACE,sCAAsC;QACtC,MAAM,QAAQ,GAAG,OAAO,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;IAED,kDAAkD;IAC3C,mBAAmB;QACxB,OAAO,wBAAwB,CAAC;IAClC,CAAC;CACF"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { SfTopic } from '../utils';
|
|
2
|
-
import { Ditamap } from './ditamap';
|
|
1
|
+
import { SfTopic } from '../utils.js';
|
|
2
|
+
import { Ditamap } from './ditamap.js';
|
|
3
3
|
export declare class TopicCommands extends Ditamap {
|
|
4
4
|
constructor(topic: string, topicMeta: SfTopic);
|
|
5
5
|
getTemplateFileName(): string;
|
|
@@ -1,26 +1,22 @@
|
|
|
1
|
-
"use strict";
|
|
2
1
|
/*
|
|
3
2
|
* Copyright (c) 2021, salesforce.com, inc.
|
|
4
3
|
* All rights reserved.
|
|
5
4
|
* Licensed under the BSD 3-Clause license.
|
|
6
5
|
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
7
6
|
*/
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
const ditamap_1 = require("./ditamap");
|
|
12
|
-
class TopicCommands extends ditamap_1.Ditamap {
|
|
7
|
+
import { join } from 'node:path';
|
|
8
|
+
import { Ditamap } from './ditamap.js';
|
|
9
|
+
export class TopicCommands extends Ditamap {
|
|
13
10
|
constructor(topic, topicMeta) {
|
|
14
|
-
const filename =
|
|
11
|
+
const filename = Ditamap.file(`cli_reference_${topic}_commands`, 'xml');
|
|
15
12
|
// Set the data of topic and filenames
|
|
16
13
|
super(filename, topicMeta);
|
|
17
14
|
// Override destination to include topic and subtopic
|
|
18
|
-
this.destination =
|
|
15
|
+
this.destination = join(Ditamap.outputDir, topic, filename);
|
|
19
16
|
}
|
|
20
17
|
// eslint-disable-next-line class-methods-use-this
|
|
21
18
|
getTemplateFileName() {
|
|
22
19
|
return 'cli_reference_topic_commands.hbs';
|
|
23
20
|
}
|
|
24
21
|
}
|
|
25
|
-
exports.TopicCommands = TopicCommands;
|
|
26
22
|
//# sourceMappingURL=topic-commands.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"topic-commands.js","sourceRoot":"","sources":["../../src/ditamap/topic-commands.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"topic-commands.js","sourceRoot":"","sources":["../../src/ditamap/topic-commands.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEjC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAEvC,MAAM,OAAO,aAAc,SAAQ,OAAO;IACxC,YAAmB,KAAa,EAAE,SAAkB;QAClD,MAAM,QAAQ,GAAG,OAAO,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,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC9D,CAAC;IAED,kDAAkD;IAC3C,mBAAmB;QACxB,OAAO,kCAAkC,CAAC;IAC5C,CAAC;CACF"}
|
|
@@ -1,27 +1,23 @@
|
|
|
1
|
-
"use strict";
|
|
2
1
|
/*
|
|
3
2
|
* Copyright (c) 2018, salesforce.com, inc.
|
|
4
3
|
* All rights reserved.
|
|
5
4
|
* Licensed under the BSD 3-Clause license.
|
|
6
5
|
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
7
6
|
*/
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
const ditamap_1 = require("./ditamap");
|
|
12
|
-
class TopicDitamap extends ditamap_1.Ditamap {
|
|
7
|
+
import { join } from 'node:path';
|
|
8
|
+
import { Ditamap } from './ditamap.js';
|
|
9
|
+
export class TopicDitamap extends Ditamap {
|
|
13
10
|
constructor(topic, commandIds) {
|
|
14
|
-
const filename =
|
|
11
|
+
const filename = Ditamap.file(`cli_reference_${topic}`, 'ditamap');
|
|
15
12
|
// Set the data of topic and filenames
|
|
16
13
|
const commands = commandIds.sort().map((c) => ({ command: c.replace(/:/g, '_') }));
|
|
17
14
|
super(filename, { topic, commands });
|
|
18
15
|
// Override destination to include topic and subtopic
|
|
19
|
-
this.destination =
|
|
16
|
+
this.destination = join(Ditamap.outputDir, topic, filename);
|
|
20
17
|
}
|
|
21
18
|
// eslint-disable-next-line class-methods-use-this
|
|
22
19
|
getTemplateFileName() {
|
|
23
20
|
return 'topic_ditamap.hbs';
|
|
24
21
|
}
|
|
25
22
|
}
|
|
26
|
-
exports.TopicDitamap = TopicDitamap;
|
|
27
23
|
//# sourceMappingURL=topic-ditamap.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"topic-ditamap.js","sourceRoot":"","sources":["../../src/ditamap/topic-ditamap.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"topic-ditamap.js","sourceRoot":"","sources":["../../src/ditamap/topic-ditamap.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAEvC,MAAM,OAAO,YAAa,SAAQ,OAAO;IACvC,YAAmB,KAAa,EAAE,UAAoB;QACpD,MAAM,QAAQ,GAAG,OAAO,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,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC9D,CAAC;IAED,kDAAkD;IAC3C,mBAAmB;QACxB,OAAO,mBAAmB,CAAC;IAC7B,CAAC;CACF"}
|
package/lib/docs.d.ts
CHANGED
package/lib/docs.js
CHANGED
|
@@ -1,26 +1,27 @@
|
|
|
1
|
-
"use strict";
|
|
2
1
|
/*
|
|
3
2
|
* Copyright (c) 2018, salesforce.com, inc.
|
|
4
3
|
* All rights reserved.
|
|
5
4
|
* Licensed under the BSD 3-Clause license.
|
|
6
5
|
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
7
6
|
*/
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
const utils_1 = require("./utils");
|
|
19
|
-
const help_reference_1 = require("./ditamap/help-reference");
|
|
7
|
+
import fs from 'node:fs/promises';
|
|
8
|
+
import { ensureString } from '@salesforce/ts-types';
|
|
9
|
+
import chalk from 'chalk';
|
|
10
|
+
import { BaseDitamap } from './ditamap/base-ditamap.js';
|
|
11
|
+
import { CLIReference } from './ditamap/cli-reference.js';
|
|
12
|
+
import { Command } from './ditamap/command.js';
|
|
13
|
+
import { TopicCommands } from './ditamap/topic-commands.js';
|
|
14
|
+
import { TopicDitamap } from './ditamap/topic-ditamap.js';
|
|
15
|
+
import { events, punctuate } from './utils.js';
|
|
16
|
+
import { HelpReference } from './ditamap/help-reference.js';
|
|
20
17
|
function emitNoTopicMetadataWarning(topic) {
|
|
21
|
-
|
|
18
|
+
events.emit('warning', `No metadata for topic ${chalk.bold(topic)}. That topic owner must add topic metadata in the oclif section in the package.json file within their plugin.`);
|
|
22
19
|
}
|
|
23
|
-
class Docs {
|
|
20
|
+
export class Docs {
|
|
21
|
+
outputDir;
|
|
22
|
+
hidden;
|
|
23
|
+
topicMeta;
|
|
24
|
+
cliMeta;
|
|
24
25
|
constructor(outputDir, hidden, topicMeta, cliMeta) {
|
|
25
26
|
this.outputDir = outputDir;
|
|
26
27
|
this.hidden = hidden;
|
|
@@ -40,9 +41,9 @@ class Docs {
|
|
|
40
41
|
let description = topicMeta.description;
|
|
41
42
|
if (!description && !topicMeta.external) {
|
|
42
43
|
// TODO: check why the same property is used again when it is already used above
|
|
43
|
-
description =
|
|
44
|
+
description = punctuate(topicMeta.description);
|
|
44
45
|
if (!description) {
|
|
45
|
-
|
|
46
|
+
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.`);
|
|
46
47
|
return [];
|
|
47
48
|
}
|
|
48
49
|
}
|
|
@@ -58,9 +59,9 @@ class Docs {
|
|
|
58
59
|
subTopicNames.push(subtopic);
|
|
59
60
|
// Commands within the sub topic
|
|
60
61
|
for (const command of classes) {
|
|
61
|
-
const fullTopic =
|
|
62
|
-
const commandsInFullTopic = classes.filter((cmd) =>
|
|
63
|
-
const commandMeta = this.resolveCommandMeta(
|
|
62
|
+
const fullTopic = ensureString(command.id).replace(/:\w+$/, '');
|
|
63
|
+
const commandsInFullTopic = classes.filter((cmd) => ensureString(cmd.id).startsWith(fullTopic));
|
|
64
|
+
const commandMeta = this.resolveCommandMeta(ensureString(command.id), command, commandsInFullTopic.length);
|
|
64
65
|
// eslint-disable-next-line no-await-in-loop
|
|
65
66
|
await this.populateCommand(topic, subtopic, command, commandMeta);
|
|
66
67
|
commandIds.push(command.id);
|
|
@@ -72,14 +73,14 @@ class Docs {
|
|
|
72
73
|
emitNoTopicMetadataWarning(`${topic}:${subtopic}`);
|
|
73
74
|
}
|
|
74
75
|
else {
|
|
75
|
-
|
|
76
|
+
events.emit('warning', `Can't create topic for ${topic}:${subtopic}: ${err.message}\n`);
|
|
76
77
|
}
|
|
77
78
|
}
|
|
78
79
|
}
|
|
79
80
|
// The topic ditamap with all of the subtopic links.
|
|
80
|
-
|
|
81
|
-
await new
|
|
82
|
-
await new
|
|
81
|
+
events.emit('subtopics', topic, subTopicNames);
|
|
82
|
+
await new TopicCommands(topic, topicMeta).write();
|
|
83
|
+
await new TopicDitamap(topic, commandIds).write();
|
|
83
84
|
return subTopicNames;
|
|
84
85
|
}
|
|
85
86
|
/**
|
|
@@ -96,7 +97,7 @@ class Docs {
|
|
|
96
97
|
if (command.hidden && !this.hidden) {
|
|
97
98
|
continue;
|
|
98
99
|
}
|
|
99
|
-
const commandParts =
|
|
100
|
+
const commandParts = ensureString(command.id).split(':');
|
|
100
101
|
const topLevelTopic = commandParts[0];
|
|
101
102
|
const plugin = command.plugin;
|
|
102
103
|
if (plugin) {
|
|
@@ -136,12 +137,12 @@ class Docs {
|
|
|
136
137
|
}
|
|
137
138
|
async populateTemplate(commands) {
|
|
138
139
|
const topicsAndSubtopics = this.groupTopicsAndSubtopics(commands);
|
|
139
|
-
await new
|
|
140
|
-
await new
|
|
140
|
+
await new CLIReference().write();
|
|
141
|
+
await new HelpReference().write();
|
|
141
142
|
// Generate one base file with all top-level topics.
|
|
142
|
-
await new
|
|
143
|
+
await new BaseDitamap(Array.from(topicsAndSubtopics.keys())).write();
|
|
143
144
|
for (const [topic, subtopics] of topicsAndSubtopics.entries()) {
|
|
144
|
-
|
|
145
|
+
events.emit('topic', { topic });
|
|
145
146
|
// eslint-disable-next-line no-await-in-loop
|
|
146
147
|
await this.populateTopic(topic, subtopics);
|
|
147
148
|
}
|
|
@@ -172,11 +173,11 @@ class Docs {
|
|
|
172
173
|
return commandMeta;
|
|
173
174
|
}
|
|
174
175
|
else if (commandsInTopic !== 1) {
|
|
175
|
-
|
|
176
|
+
events.emit('warning', `subtopic "${part}" meta not found for command ${commandId}`);
|
|
176
177
|
}
|
|
177
178
|
else if (!commandMeta.description) {
|
|
178
179
|
commandMeta.description = command.description;
|
|
179
|
-
commandMeta.longDescription = (command.longDescription ? command.longDescription :
|
|
180
|
+
commandMeta.longDescription = (command.longDescription ? command.longDescription : punctuate(command.description));
|
|
180
181
|
}
|
|
181
182
|
}
|
|
182
183
|
return commandMeta;
|
|
@@ -186,10 +187,9 @@ class Docs {
|
|
|
186
187
|
if (command.hidden && !this.hidden) {
|
|
187
188
|
return '';
|
|
188
189
|
}
|
|
189
|
-
const commandDitamap = new
|
|
190
|
+
const commandDitamap = new Command(topic, subtopic, command, commandMeta);
|
|
190
191
|
await commandDitamap.write();
|
|
191
192
|
return commandDitamap.getFilename();
|
|
192
193
|
}
|
|
193
194
|
}
|
|
194
|
-
exports.Docs = Docs;
|
|
195
195
|
//# sourceMappingURL=docs.js.map
|
package/lib/docs.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"docs.js","sourceRoot":"","sources":["../src/docs.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"docs.js","sourceRoot":"","sources":["../src/docs.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAClC,OAAO,EAAW,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAC7D,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAW,MAAM,EAAE,SAAS,EAAmC,MAAM,YAAY,CAAC;AACzF,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAI5D,SAAS,0BAA0B,CAAC,KAAa;IAC/C,MAAM,CAAC,IAAI,CACT,SAAS,EACT,yBAAyB,KAAK,CAAC,IAAI,CACjC,KAAK,CACN,+GAA+G,CACjH,CAAC;AACJ,CAAC;AAED,MAAM,OAAO,IAAI;IAEL;IACA;IACA;IACA;IAJV,YACU,SAAiB,EACjB,MAAe,EACf,SAAmB,EACnB,OAAgB;QAHhB,cAAS,GAAT,SAAS,CAAQ;QACjB,WAAM,GAAN,MAAM,CAAS;QACf,cAAS,GAAT,SAAS,CAAU;QACnB,YAAO,GAAP,OAAO,CAAS;IACvB,CAAC;IAEG,KAAK,CAAC,KAAK,CAAC,QAAwB;QACzC,0BAA0B;QAC1B,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAEpD,MAAM,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IACxC,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,KAAa,EAAE,SAAsC;QAC9E,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC5C,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,qBAAqB,KAAK,6DAA6D,CAAC,CAAC;QAC3G,CAAC;QAED,IAAI,WAAW,GAAG,SAAS,CAAC,WAAW,CAAC;QACxC,IAAI,CAAC,WAAW,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC;YACxC,gFAAgF;YAChF,WAAW,GAAG,SAAS,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;YAC/C,IAAI,CAAC,WAAW,EAAE,CAAC;gBACjB,MAAM,CAAC,IAAI,CACT,SAAS,EACT,4BAA4B,KAAK,CAAC,IAAI,CACpC,KAAK,CACN,qHAAqH,CACvH,CAAC;gBACF,OAAO,EAAE,CAAC;YACZ,CAAC;QACH,CAAC;QAED,MAAM,aAAa,GAAG,EAAE,CAAC;QACzB,MAAM,UAAU,GAAG,EAAE,CAAC;QAEtB,KAAK,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,IAAI,SAAS,CAAC,OAAO,EAAE,EAAE,CAAC;YACtD,IAAI,CAAC;gBACH,6CAA6C;gBAE7C,uCAAuC;gBACvC,wDAAwD;gBACxD,cAAc;gBACd,IAAI;gBAEJ,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAE7B,gCAAgC;gBAChC,KAAK,MAAM,OAAO,IAAI,OAAO,EAAE,CAAC;oBAC9B,MAAM,SAAS,GAAG,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;oBAChE,MAAM,mBAAmB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC;oBAChG,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,mBAAmB,CAAC,MAAM,CAAC,CAAC;oBAE3G,4CAA4C;oBAC5C,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;oBAClE,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;gBAC9B,CAAC;YACH,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,GAAG,GACP,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC;gBAC7G,IAAI,GAAG,CAAC,IAAI,KAAK,0BAA0B,EAAE,CAAC;oBAC5C,0BAA0B,CAAC,GAAG,KAAK,IAAI,QAAQ,EAAE,CAAC,CAAC;gBACrD,CAAC;qBAAM,CAAC;oBACN,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,0BAA0B,KAAK,IAAI,QAAQ,KAAK,GAAG,CAAC,OAAO,IAAI,CAAC,CAAC;gBAC1F,CAAC;YACH,CAAC;QACH,CAAC;QAED,oDAAoD;QACpD,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,EAAE,aAAa,CAAC,CAAC;QAE/C,MAAM,IAAI,aAAa,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC,KAAK,EAAE,CAAC;QAClD,MAAM,IAAI,YAAY,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC,KAAK,EAAE,CAAC;QAClD,OAAO,aAAa,CAAC;IACvB,CAAC;IAED;;;;;;OAMG;IACK,uBAAuB,CAAC,QAAwB;QACtD,oFAAoF;QACpF,MAAM,cAAc,GAAG,IAAI,GAAG,EAAuC,CAAC;QAEtE,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC/B,IAAI,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;gBACnC,SAAS;YACX,CAAC;YACD,MAAM,YAAY,GAAG,YAAY,CAAC,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,EAAE,CAAC;gBACX,0GAA0G;gBAC1G,OAAO,CAAC,KAAK,GAAG,aAAa,CAAC;gBAE9B,MAAM,yBAAyB,GAAG,cAAc,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,IAAI,GAAG,EAA0B,CAAC;gBAEzG,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBAC9B,mDAAmD;oBACnD,MAAM,cAAc,GAAG,yBAAyB,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;oBAC5E,yBAAyB,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,cAAc,EAAE,OAAO,CAAC,CAAC,CAAC;gBAC/E,CAAC;qBAAM,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBACrC,uDAAuD;oBACvD,MAAM,cAAc,GAAG,yBAAyB,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;oBAC5E,yBAAyB,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,cAAc,EAAE,OAAO,CAAC,CAAC,CAAC;gBAC/E,CAAC;qBAAM,CAAC;oBACN,MAAM,QAAQ,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;oBAEjC,IAAI,CAAC;wBACH,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;wBACpD,MAAM,aAAa,GAAG,SAAS,EAAE,SAAS,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC;wBAC1D,IAAI,aAAa,EAAE,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;4BAC1C,SAAS;wBACX,CAAC;oBACH,CAAC;oBAAC,OAAO,CAAC,EAAE,CAAC;wBACX,qGAAqG;oBACvG,CAAC;oBAED,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;oBAE5B,MAAM,gBAAgB,GAAG,yBAAyB,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;oBACvE,yBAAyB,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,GAAG,gBAAgB,EAAE,OAAO,CAAC,CAAC,CAAC;gBAC1E,CAAC;gBAED,cAAc,CAAC,GAAG,CAAC,aAAa,EAAE,yBAAyB,CAAC,CAAC;YAC/D,CAAC;QACH,CAAC;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,YAAY,EAAE,CAAC,KAAK,EAAE,CAAC;QACjC,MAAM,IAAI,aAAa,EAAE,CAAC,KAAK,EAAE,CAAC;QAElC,oDAAoD;QACpD,MAAM,IAAI,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;QAErE,KAAK,MAAM,CAAC,KAAK,EAAE,SAAS,CAAC,IAAI,kBAAkB,CAAC,OAAO,EAAE,EAAE,CAAC;YAC9D,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;YAChC,4CAA4C;YAC5C,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QAC7C,CAAC;IACH,CAAC;IAEO,kBAAkB,CACxB,SAAiB,EACjB,OAAqB,EACrB,eAAuB;QAEvB,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,IAAwB,CAAC;QAC7B,IAAI,CAAC;YACH,IAAI,WAAgC,CAAC;YACrC,KAAK,IAAI,IAAI,YAAY,EAAE,CAAC;gBAC1B,IAAI,WAAW,EAAE,CAAC;oBAChB,MAAM,SAAS,GAAG,WAAW,CAAC,SAAS,CAAC;oBACxC,WAAW,GAAG,SAAS,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;gBACrC,CAAC;qBAAM,CAAC;oBACN,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;gBACzC,CAAC;gBAED,+GAA+G;gBAC/G,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC;YAC9C,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,0CAA0C;YAC1C,IAAI,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC7B,+FAA+F;gBAC/F,OAAO,WAAW,CAAC;YACrB,CAAC;iBAAM,IAAI,eAAe,KAAK,CAAC,EAAE,CAAC;gBACjC,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,aAAa,IAAI,gCAAgC,SAAS,EAAE,CAAC,CAAC;YACvF,CAAC;iBAAM,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,CAAC;gBACpC,WAAW,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;gBAC9C,WAAW,CAAC,eAAe,GAAG,CAC5B,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,WAAW,CAAC,CACxE,CAAC;YACf,CAAC;QACH,CAAC;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;IAEO,KAAK,CAAC,eAAe,CAC3B,KAAa,EACb,QAAuB,EACvB,OAAqB,EACrB,WAAoC;QAEpC,oCAAoC;QACpC,IAAI,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACnC,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,MAAM,cAAc,GAAG,IAAI,OAAO,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"}
|
package/lib/index.js
CHANGED
|
@@ -1,10 +1,8 @@
|
|
|
1
|
-
"use strict";
|
|
2
1
|
/*
|
|
3
2
|
* Copyright (c) 2018, salesforce.com, inc.
|
|
4
3
|
* All rights reserved.
|
|
5
4
|
* Licensed under the BSD 3-Clause license.
|
|
6
5
|
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
7
6
|
*/
|
|
8
|
-
|
|
9
|
-
exports.default = {};
|
|
7
|
+
export default {};
|
|
10
8
|
//# sourceMappingURL=index.js.map
|
package/lib/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAe,EAAE,CAAC"}
|
package/lib/utils.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
/// <reference types="node" />
|
|
1
|
+
/// <reference types="node" resolution-mode="require"/>
|
|
2
2
|
import { EventEmitter } from 'node:events';
|
|
3
3
|
import { Command, Interfaces } from '@oclif/core';
|
|
4
4
|
import { AnyJson } from '@salesforce/ts-types';
|
|
@@ -9,7 +9,7 @@ export type CommandClass = Pick<Command.Class, 'id' | 'hidden' | 'description' |
|
|
|
9
9
|
binary: string;
|
|
10
10
|
deprecated?: boolean;
|
|
11
11
|
};
|
|
12
|
-
export declare const events: EventEmitter
|
|
12
|
+
export declare const events: EventEmitter<[never]>;
|
|
13
13
|
export declare function punctuate(description?: string): string | undefined;
|
|
14
14
|
export declare const replaceConfigVariables: (text: string, bin: string, id: string) => string;
|
|
15
15
|
export type CliMeta = {
|
package/lib/utils.js
CHANGED
|
@@ -1,19 +1,16 @@
|
|
|
1
|
-
"use strict";
|
|
2
1
|
/*
|
|
3
2
|
* Copyright (c) 2018, salesforce.com, inc.
|
|
4
3
|
* All rights reserved.
|
|
5
4
|
* Licensed under the BSD 3-Clause license.
|
|
6
5
|
* For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
7
6
|
*/
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
const
|
|
11
|
-
|
|
12
|
-
exports.events = new node_events_1.EventEmitter();
|
|
13
|
-
function punctuate(description) {
|
|
7
|
+
import { EventEmitter } from 'node:events';
|
|
8
|
+
import { EOL } from 'node:os';
|
|
9
|
+
export const events = new EventEmitter();
|
|
10
|
+
export function punctuate(description) {
|
|
14
11
|
if (!description)
|
|
15
12
|
return description;
|
|
16
|
-
const lines = description.split(
|
|
13
|
+
const lines = description.split(EOL);
|
|
17
14
|
let mainDescription = lines[0];
|
|
18
15
|
mainDescription = mainDescription.charAt(0).toUpperCase() + mainDescription.substring(1);
|
|
19
16
|
if (!mainDescription.endsWith('.')) {
|
|
@@ -21,7 +18,5 @@ function punctuate(description) {
|
|
|
21
18
|
}
|
|
22
19
|
return mainDescription;
|
|
23
20
|
}
|
|
24
|
-
|
|
25
|
-
const replaceConfigVariables = (text, bin, id) => text.replace(/<%= config.bin %>/g, bin ?? 'unknown').replace(/<%= command.id %>/g, id);
|
|
26
|
-
exports.replaceConfigVariables = replaceConfigVariables;
|
|
21
|
+
export const replaceConfigVariables = (text, bin, id) => text.replace(/<%= config.bin %>/g, bin ?? 'unknown').replace(/<%= command.id %>/g, id);
|
|
27
22
|
//# sourceMappingURL=utils.js.map
|
package/lib/utils.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,GAAG,EAAE,MAAM,SAAS,CAAC;AAS9B,MAAM,CAAC,MAAM,MAAM,GAAG,IAAI,YAAY,EAAE,CAAC;AAEzC,MAAM,UAAU,SAAS,CAAC,WAAoB;IAC5C,IAAI,CAAC,WAAW;QAAE,OAAO,WAAW,CAAC;IAErC,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACrC,IAAI,eAAe,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAE/B,eAAe,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAEzF,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACnC,eAAe,IAAI,GAAG,CAAC;IACzB,CAAC;IAED,OAAO,eAAe,CAAC;AACzB,CAAC;AAED,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,IAAY,EAAE,GAAW,EAAE,EAAU,EAAU,EAAE,CACtF,IAAI,CAAC,OAAO,CAAC,oBAAoB,EAAE,GAAG,IAAI,SAAS,CAAC,CAAC,OAAO,CAAC,oBAAoB,EAAE,EAAE,CAAC,CAAC"}
|