@teambit/cli 0.0.660 → 0.0.662
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/dist/generate-doc-md.js
CHANGED
|
@@ -32,7 +32,23 @@ class GenerateCommandsDoc {
|
|
|
32
32
|
let output = `${this.getFrontmatter()}
|
|
33
33
|
# CLI Reference
|
|
34
34
|
|
|
35
|
-
|
|
35
|
+
Run the following to list all available Bit commands (alternatively, use the \`-h\` alias, instead of \`--help\`):
|
|
36
|
+
|
|
37
|
+
\`\`\`sh
|
|
38
|
+
bit --help
|
|
39
|
+
\`\`\`
|
|
40
|
+
|
|
41
|
+
Run the following to get help on a specific command:
|
|
42
|
+
|
|
43
|
+
\`\`\`sh
|
|
44
|
+
bit COMMAND --help
|
|
45
|
+
\`\`\`
|
|
46
|
+
|
|
47
|
+
Run the following to get help on a specific sub-command:
|
|
48
|
+
|
|
49
|
+
\`\`\`sh
|
|
50
|
+
bit COMMAND SUB_COMMAND --help
|
|
51
|
+
\`\`\`
|
|
36
52
|
`;
|
|
37
53
|
output += commands.map(cmd => this.generateCommand(cmd)).join('\n');
|
|
38
54
|
return output;
|
|
@@ -71,7 +87,6 @@ Commands that are marked as workspace only must be executed inside a workspace.
|
|
|
71
87
|
if (cmd.alias && cmd.alias.length > 0) {
|
|
72
88
|
result += `**Alias**: \`${cmd.alias}\` \n`;
|
|
73
89
|
}
|
|
74
|
-
result += `**Workspace only**: ${cmd.skipWorkspace ? 'no' : 'yes'} \n`;
|
|
75
90
|
result += `**Description**: ${this.formatDescription(cmd)}`;
|
|
76
91
|
result += `\`bit ${cmd.name}\` \n\n`;
|
|
77
92
|
if (cmd.commands && cmd.commands.length > 0) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"names":["GenerateCommandsDoc","constructor","commands","options","generate","getAllPublicCommandsSorted","output","getFrontmatter","map","cmd","generateCommand","join","generateJson","commandsToObjects","command","cmdObject","oneCommandToObject","length","metadata","metadataStr","Object","keys","key","publicCommands","filter","private","sort","a","b","name","localeCompare","commandName","getCommandId","result","alias","
|
|
1
|
+
{"version":3,"names":["GenerateCommandsDoc","constructor","commands","options","generate","getAllPublicCommandsSorted","output","getFrontmatter","map","cmd","generateCommand","join","generateJson","commandsToObjects","command","cmdObject","oneCommandToObject","length","metadata","metadataStr","Object","keys","key","publicCommands","filter","private","sort","a","b","name","localeCompare","commandName","getCommandId","result","alias","formatDescription","generateSubCommands","generateOptions","subCommands","ret","forEach","subCommand","subcommandName","usage","opt","flag","description","aliasFormatted","flagFormatted","replaceAll","formatStringToMD","str","split","extendedDescription","pick"],"sources":["generate-doc-md.ts"],"sourcesContent":["import { Command } from '@teambit/legacy/dist/cli/command';\nimport { CommandOptions } from '@teambit/legacy/dist/cli/legacy-command';\nimport { pick } from 'lodash';\nimport { getCommandId } from './get-command-id';\n\nexport type GenerateOpts = {\n metadata?: Record<string, string>;\n};\n\ntype CommandObject = ReturnType<typeof oneCommandToObject> & { commands?: any };\n\nexport class GenerateCommandsDoc {\n constructor(private commands: Command[], private options: GenerateOpts) {}\n\n generate(): string {\n const commands = this.getAllPublicCommandsSorted();\n let output = `${this.getFrontmatter()}\n# CLI Reference\n\nRun the following to list all available Bit commands (alternatively, use the \\`-h\\` alias, instead of \\`--help\\`):\n\n\\`\\`\\`sh\nbit --help\n\\`\\`\\`\n\nRun the following to get help on a specific command:\n\n\\`\\`\\`sh\nbit COMMAND --help\n\\`\\`\\`\n\nRun the following to get help on a specific sub-command:\n\n\\`\\`\\`sh\nbit COMMAND SUB_COMMAND --help\n\\`\\`\\`\n`;\n output += commands.map((cmd) => this.generateCommand(cmd)).join('\\n');\n\n return output;\n }\n\n generateJson() {\n return this.commandsToObjects();\n }\n\n private commandsToObjects(commands: Command[] = this.commands): CommandObject[] {\n return commands.map((command) => {\n const cmdObject: CommandObject = oneCommandToObject(command);\n if (command.commands?.length) {\n cmdObject.commands = this.commandsToObjects(command.commands);\n }\n return cmdObject;\n });\n }\n\n private getFrontmatter() {\n const metadata = this.options.metadata;\n if (!metadata) {\n return '';\n }\n const metadataStr = Object.keys(metadata)\n .map((key) => `${key}: ${metadata[key]}`)\n .join('\\n');\n\n return `---\n ${metadataStr}\n ---\n`;\n }\n\n private getAllPublicCommandsSorted() {\n const publicCommands = this.commands.filter((cmd) => !cmd.private);\n return publicCommands.sort((a, b) => a.name.localeCompare(b.name));\n }\n\n private generateCommand(cmd: Command) {\n const commandName = getCommandId(cmd.name);\n let result = `## ${commandName} \\n\\n`;\n if (cmd.alias && cmd.alias.length > 0) {\n result += `**Alias**: \\`${cmd.alias}\\` \\n`;\n }\n result += `**Description**: ${this.formatDescription(cmd)}`;\n result += `\\`bit ${cmd.name}\\` \\n\\n`;\n\n if (cmd.commands && cmd.commands.length > 0) {\n result += this.generateSubCommands(cmd.commands, cmd);\n }\n result += this.generateOptions(cmd.options);\n result += `--- \\n`;\n\n return result;\n }\n\n private generateSubCommands(subCommands: Command[], command: Command) {\n let ret = '';\n subCommands.forEach((subCommand) => {\n const commandName = getCommandId(command.name);\n const subcommandName = getCommandId(subCommand.name);\n const usage = `${commandName} ${subCommand.name}`;\n ret += `### ${commandName} ${subcommandName} \\n`;\n ret += `**Usage**: \\`${usage}\\` \\n\\n`;\n ret += `**Description**: ${this.formatDescription(subCommand)}`;\n\n ret += '\\n';\n ret += this.generateOptions(subCommand.options);\n });\n return ret;\n }\n\n private generateOptions(options: CommandOptions): string {\n if (!options || options.length <= 0) return '';\n let output = `| **Option** | **Option alias** | **Description**| \\n`;\n output += `|---|:-----:|---|\\n`;\n options.forEach((opt) => {\n const [alias, flag, description] = opt;\n const aliasFormatted = alias ? `\\`-${alias}\\`` : ' ';\n const flagFormatted = `--${flag}`;\n output += `|\\`${flagFormatted}\\`|${aliasFormatted}|${description.replaceAll('\\n', ' ')}|\\n`;\n });\n output += `\\n`;\n return output;\n }\n\n private formatStringToMD(str: string): string {\n return str.split('\\n').join(' \\n');\n }\n\n private formatDescription(command: Command): string {\n const extendedDescription = command.extendedDescription\n ? ` \\n${this.formatStringToMD(command.extendedDescription)}`\n : '';\n const description = this.formatStringToMD(command.description as string);\n return `${description}${extendedDescription} \\n\\n`;\n }\n}\n\nfunction oneCommandToObject(command: Command) {\n return pick(command, [\n 'name',\n 'alias',\n 'options',\n 'description',\n 'extendedDescription',\n 'group',\n 'private',\n 'internal',\n 'remoteOp',\n 'skipWorkspace',\n 'arguments',\n 'examples',\n ]);\n}\n"],"mappings":";;;;;;;;;;AAEA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AACA;EAAA;EAAA;IAAA;EAAA;EAAA;AAAA;AAQO,MAAMA,mBAAmB,CAAC;EAC/BC,WAAW,CAASC,QAAmB,EAAUC,OAAqB,EAAE;IAAA,KAApDD,QAAmB,GAAnBA,QAAmB;IAAA,KAAUC,OAAqB,GAArBA,OAAqB;EAAG;EAEzEC,QAAQ,GAAW;IACjB,MAAMF,QAAQ,GAAG,IAAI,CAACG,0BAA0B,EAAE;IAClD,IAAIC,MAAM,GAAI,GAAE,IAAI,CAACC,cAAc,EAAG;AAC1C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,CAAC;IACGD,MAAM,IAAIJ,QAAQ,CAACM,GAAG,CAAEC,GAAG,IAAK,IAAI,CAACC,eAAe,CAACD,GAAG,CAAC,CAAC,CAACE,IAAI,CAAC,IAAI,CAAC;IAErE,OAAOL,MAAM;EACf;EAEAM,YAAY,GAAG;IACb,OAAO,IAAI,CAACC,iBAAiB,EAAE;EACjC;EAEQA,iBAAiB,CAACX,QAAmB,GAAG,IAAI,CAACA,QAAQ,EAAmB;IAC9E,OAAOA,QAAQ,CAACM,GAAG,CAAEM,OAAO,IAAK;MAAA;MAC/B,MAAMC,SAAwB,GAAGC,kBAAkB,CAACF,OAAO,CAAC;MAC5D,yBAAIA,OAAO,CAACZ,QAAQ,8CAAhB,kBAAkBe,MAAM,EAAE;QAC5BF,SAAS,CAACb,QAAQ,GAAG,IAAI,CAACW,iBAAiB,CAACC,OAAO,CAACZ,QAAQ,CAAC;MAC/D;MACA,OAAOa,SAAS;IAClB,CAAC,CAAC;EACJ;EAEQR,cAAc,GAAG;IACvB,MAAMW,QAAQ,GAAG,IAAI,CAACf,OAAO,CAACe,QAAQ;IACtC,IAAI,CAACA,QAAQ,EAAE;MACb,OAAO,EAAE;IACX;IACA,MAAMC,WAAW,GAAGC,MAAM,CAACC,IAAI,CAACH,QAAQ,CAAC,CACtCV,GAAG,CAAEc,GAAG,IAAM,GAAEA,GAAI,KAAIJ,QAAQ,CAACI,GAAG,CAAE,EAAC,CAAC,CACxCX,IAAI,CAAC,IAAI,CAAC;IAEb,OAAQ;AACZ,MAAMQ,WAAY;AAClB;AACA,CAAC;EACC;EAEQd,0BAA0B,GAAG;IACnC,MAAMkB,cAAc,GAAG,IAAI,CAACrB,QAAQ,CAACsB,MAAM,CAAEf,GAAG,IAAK,CAACA,GAAG,CAACgB,OAAO,CAAC;IAClE,OAAOF,cAAc,CAACG,IAAI,CAAC,CAACC,CAAC,EAAEC,CAAC,KAAKD,CAAC,CAACE,IAAI,CAACC,aAAa,CAACF,CAAC,CAACC,IAAI,CAAC,CAAC;EACpE;EAEQnB,eAAe,CAACD,GAAY,EAAE;IACpC,MAAMsB,WAAW,GAAG,IAAAC,4BAAY,EAACvB,GAAG,CAACoB,IAAI,CAAC;IAC1C,IAAII,MAAM,GAAI,MAAKF,WAAY,QAAO;IACtC,IAAItB,GAAG,CAACyB,KAAK,IAAIzB,GAAG,CAACyB,KAAK,CAACjB,MAAM,GAAG,CAAC,EAAE;MACrCgB,MAAM,IAAK,gBAAexB,GAAG,CAACyB,KAAM,QAAO;IAC7C;IACAD,MAAM,IAAK,oBAAmB,IAAI,CAACE,iBAAiB,CAAC1B,GAAG,CAAE,EAAC;IAC3DwB,MAAM,IAAK,SAAQxB,GAAG,CAACoB,IAAK,UAAS;IAErC,IAAIpB,GAAG,CAACP,QAAQ,IAAIO,GAAG,CAACP,QAAQ,CAACe,MAAM,GAAG,CAAC,EAAE;MAC3CgB,MAAM,IAAI,IAAI,CAACG,mBAAmB,CAAC3B,GAAG,CAACP,QAAQ,EAAEO,GAAG,CAAC;IACvD;IACAwB,MAAM,IAAI,IAAI,CAACI,eAAe,CAAC5B,GAAG,CAACN,OAAO,CAAC;IAC3C8B,MAAM,IAAK,SAAQ;IAEnB,OAAOA,MAAM;EACf;EAEQG,mBAAmB,CAACE,WAAsB,EAAExB,OAAgB,EAAE;IACpE,IAAIyB,GAAG,GAAG,EAAE;IACZD,WAAW,CAACE,OAAO,CAAEC,UAAU,IAAK;MAClC,MAAMV,WAAW,GAAG,IAAAC,4BAAY,EAAClB,OAAO,CAACe,IAAI,CAAC;MAC9C,MAAMa,cAAc,GAAG,IAAAV,4BAAY,EAACS,UAAU,CAACZ,IAAI,CAAC;MACpD,MAAMc,KAAK,GAAI,GAAEZ,WAAY,IAAGU,UAAU,CAACZ,IAAK,EAAC;MACjDU,GAAG,IAAK,OAAMR,WAAY,IAAGW,cAAe,KAAI;MAChDH,GAAG,IAAK,gBAAeI,KAAM,UAAS;MACtCJ,GAAG,IAAK,oBAAmB,IAAI,CAACJ,iBAAiB,CAACM,UAAU,CAAE,EAAC;MAE/DF,GAAG,IAAI,IAAI;MACXA,GAAG,IAAI,IAAI,CAACF,eAAe,CAACI,UAAU,CAACtC,OAAO,CAAC;IACjD,CAAC,CAAC;IACF,OAAOoC,GAAG;EACZ;EAEQF,eAAe,CAAClC,OAAuB,EAAU;IACvD,IAAI,CAACA,OAAO,IAAIA,OAAO,CAACc,MAAM,IAAI,CAAC,EAAE,OAAO,EAAE;IAC9C,IAAIX,MAAM,GAAI,wDAAuD;IACrEA,MAAM,IAAK,qBAAoB;IAC/BH,OAAO,CAACqC,OAAO,CAAEI,GAAG,IAAK;MACvB,MAAM,CAACV,KAAK,EAAEW,IAAI,EAAEC,WAAW,CAAC,GAAGF,GAAG;MACtC,MAAMG,cAAc,GAAGb,KAAK,GAAI,MAAKA,KAAM,IAAG,GAAG,KAAK;MACtD,MAAMc,aAAa,GAAI,KAAIH,IAAK,EAAC;MACjCvC,MAAM,IAAK,MAAK0C,aAAc,MAAKD,cAAe,IAAGD,WAAW,CAACG,UAAU,CAAC,IAAI,EAAE,GAAG,CAAE,KAAI;IAC7F,CAAC,CAAC;IACF3C,MAAM,IAAK,IAAG;IACd,OAAOA,MAAM;EACf;EAEQ4C,gBAAgB,CAACC,GAAW,EAAU;IAC5C,OAAOA,GAAG,CAACC,KAAK,CAAC,IAAI,CAAC,CAACzC,IAAI,CAAC,MAAM,CAAC;EACrC;EAEQwB,iBAAiB,CAACrB,OAAgB,EAAU;IAClD,MAAMuC,mBAAmB,GAAGvC,OAAO,CAACuC,mBAAmB,GAClD,OAAM,IAAI,CAACH,gBAAgB,CAACpC,OAAO,CAACuC,mBAAmB,CAAE,EAAC,GAC3D,EAAE;IACN,MAAMP,WAAW,GAAG,IAAI,CAACI,gBAAgB,CAACpC,OAAO,CAACgC,WAAW,CAAW;IACxE,OAAQ,GAAEA,WAAY,GAAEO,mBAAoB,QAAO;EACrD;AACF;AAAC;AAED,SAASrC,kBAAkB,CAACF,OAAgB,EAAE;EAC5C,OAAO,IAAAwC,cAAI,EAACxC,OAAO,EAAE,CACnB,MAAM,EACN,OAAO,EACP,SAAS,EACT,aAAa,EACb,qBAAqB,EACrB,OAAO,EACP,SAAS,EACT,UAAU,EACV,UAAU,EACV,eAAe,EACf,WAAW,EACX,UAAU,CACX,CAAC;AACJ"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_cli@0.0.
|
|
2
|
-
import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_cli@0.0.
|
|
1
|
+
import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_cli@0.0.662/dist/cli.composition.js';
|
|
2
|
+
import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_cli@0.0.662/dist/cli.docs.mdx';
|
|
3
3
|
|
|
4
4
|
export const compositions = [compositions_0];
|
|
5
5
|
export const overview = [overview_0];
|
|
Binary file
|
package/package.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@teambit/cli",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.662",
|
|
4
4
|
"homepage": "https://bit.dev/teambit/harmony/cli",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"componentId": {
|
|
7
7
|
"scope": "teambit.harmony",
|
|
8
8
|
"name": "cli",
|
|
9
|
-
"version": "0.0.
|
|
9
|
+
"version": "0.0.662"
|
|
10
10
|
},
|
|
11
11
|
"dependencies": {
|
|
12
12
|
"chalk": "2.4.2",
|
|
@@ -19,8 +19,8 @@
|
|
|
19
19
|
"core-js": "^3.0.0",
|
|
20
20
|
"@babel/runtime": "7.20.0",
|
|
21
21
|
"@teambit/harmony": "0.4.6",
|
|
22
|
-
"@teambit/community": "0.0.
|
|
23
|
-
"@teambit/logger": "0.0.
|
|
22
|
+
"@teambit/community": "0.0.210",
|
|
23
|
+
"@teambit/logger": "0.0.755",
|
|
24
24
|
"@teambit/bit-error": "0.0.402"
|
|
25
25
|
},
|
|
26
26
|
"devDependencies": {
|
|
@@ -35,7 +35,7 @@
|
|
|
35
35
|
"@types/testing-library__jest-dom": "5.9.5"
|
|
36
36
|
},
|
|
37
37
|
"peerDependencies": {
|
|
38
|
-
"@teambit/legacy": "1.0.
|
|
38
|
+
"@teambit/legacy": "1.0.443",
|
|
39
39
|
"react": "^16.8.0 || ^17.0.0",
|
|
40
40
|
"react-dom": "^16.8.0 || ^17.0.0"
|
|
41
41
|
},
|
|
Binary file
|