@teambit/cli 0.0.861 → 0.0.862

package/artifacts/__bit_junit.xml

@@ -1,4 +1,4 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <testsuites tests="0" failures="0" errors="0" skipped="0">
-  <testsuite name="teambit.harmony/cli@0.0.861" tests="0" failures="0" errors="0" skipped="0"/>
+  <testsuite name="teambit.harmony/cli@0.0.862" tests="0" failures="0" errors="0" skipped="0"/>
 </testsuites>

package/artifacts/preview/teambit_harmony_cli-preview.js

@@ -1 +1 @@
-!function(e,t){"object"==typeof exports&&"object"==typeof module?module.exports=t():"function"==typeof define&&define.amd?define([],t):"object"==typeof exports?exports["teambit.harmony/cli-preview"]=t():e["teambit.harmony/cli-preview"]=t()}(self,(()=>(()=>{"use strict";var e={22203:(e,t,o)=>{var n={id:"teambit.harmony/cli@0.0.861",homepage:"https://bit.cloud/teambit/harmony/cli",exported:!0};function r(){const e=a(o(41594));return r=function(){return e},e}function a(e){return e&&e.__esModule?e:{default:e}}Object.defineProperty(t,"__esModule",{value:!0}),t.Logo=void 0,r.__bit_component=n,a.__bit_component=n;const i=()=>r().default.createElement("div",{style:{height:"100%",display:"flex",justifyContent:"center"}},r().default.createElement("img",{style:{width:70},src:"https://static.bit.dev/extensions-icons/cli.svg"}));i.__bit_component=n,t.Logo=i},41594:e=>{e.exports=React}},t={};function o(n){var r=t[n];if(void 0!==r)return r.exports;var a=t[n]={exports:{}};return e[n](a,a.exports,o),a.exports}o.d=(e,t)=>{for(var n in t)o.o(t,n)&&!o.o(e,n)&&Object.defineProperty(e,n,{enumerable:!0,get:t[n]})},o.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),o.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})};var n={};return(()=>{o.r(n),o.d(n,{compositions:()=>p,compositions_metadata:()=>u,overview:()=>l});var e={};o.r(e),o.d(e,{default:()=>m});var t=o(22203);o(41594);const r=MdxJsReact,a=TeambitMdxUiMdxScopeContext;var i=["components"];function s(){return s=Object.assign?Object.assign.bind():function(e){for(var t=1;t<arguments.length;t++){var o=arguments[t];for(var n in o)Object.prototype.hasOwnProperty.call(o,n)&&(e[n]=o[n])}return e},s.apply(this,arguments)}var c={},d="wrapper";function m(e){var t=e.components,o=function(e,t){if(null==e)return{};var o,n,r=function(e,t){if(null==e)return{};var o,n,r={},a=Object.keys(e);for(n=0;n<a.length;n++)o=a[n],t.indexOf(o)>=0||(r[o]=e[o]);return r}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n<a.length;n++)o=a[n],t.indexOf(o)>=0||Object.prototype.propertyIsEnumerable.call(e,o)&&(r[o]=e[o])}return r}(e,i);return(0,r.mdx)(d,s({},c,o,{components:t,mdxType:"MDXLayout"}),(0,r.mdx)(a.MDXScopeProvider,{components:{},mdxType:"MDXScopeProvider"},(0,r.mdx)("p",null,"CLI Aspect manages the commands in the CLI. New commands are registered to this aspect with the necessary data such as, command-name, description and flags. Parsing the args from the CLI is done by Commander package."),(0,r.mdx)("h2",null,"Features"),(0,r.mdx)("ul",null,(0,r.mdx)("li",{parentName:"ul"},"Allow to register new commands"),(0,r.mdx)("li",{parentName:"ul"},"Use commander commands."),(0,r.mdx)("li",{parentName:"ul"},"Render to stdout as string or as a React component by Ink."))))}m.isMDXComponent=!0;const p=[t],l=[e],u={compositions:[{displayName:"Logo",identifier:"Logo"}]}})(),n})()));
+!function(e,t){"object"==typeof exports&&"object"==typeof module?module.exports=t():"function"==typeof define&&define.amd?define([],t):"object"==typeof exports?exports["teambit.harmony/cli-preview"]=t():e["teambit.harmony/cli-preview"]=t()}(self,(()=>(()=>{"use strict";var e={27441:(e,t,o)=>{var n={id:"teambit.harmony/cli@0.0.862",homepage:"https://bit.cloud/teambit/harmony/cli",exported:!0};function r(){const e=a(o(41594));return r=function(){return e},e}function a(e){return e&&e.__esModule?e:{default:e}}Object.defineProperty(t,"__esModule",{value:!0}),t.Logo=void 0,r.__bit_component=n,a.__bit_component=n;const i=()=>r().default.createElement("div",{style:{height:"100%",display:"flex",justifyContent:"center"}},r().default.createElement("img",{style:{width:70},src:"https://static.bit.dev/extensions-icons/cli.svg"}));i.__bit_component=n,t.Logo=i},41594:e=>{e.exports=React}},t={};function o(n){var r=t[n];if(void 0!==r)return r.exports;var a=t[n]={exports:{}};return e[n](a,a.exports,o),a.exports}o.d=(e,t)=>{for(var n in t)o.o(t,n)&&!o.o(e,n)&&Object.defineProperty(e,n,{enumerable:!0,get:t[n]})},o.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),o.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})};var n={};return(()=>{o.r(n),o.d(n,{compositions:()=>p,compositions_metadata:()=>u,overview:()=>l});var e={};o.r(e),o.d(e,{default:()=>m});var t=o(27441);o(41594);const r=MdxJsReact,a=TeambitMdxUiMdxScopeContext;var i=["components"];function s(){return s=Object.assign?Object.assign.bind():function(e){for(var t=1;t<arguments.length;t++){var o=arguments[t];for(var n in o)Object.prototype.hasOwnProperty.call(o,n)&&(e[n]=o[n])}return e},s.apply(this,arguments)}var c={},d="wrapper";function m(e){var t=e.components,o=function(e,t){if(null==e)return{};var o,n,r=function(e,t){if(null==e)return{};var o,n,r={},a=Object.keys(e);for(n=0;n<a.length;n++)o=a[n],t.indexOf(o)>=0||(r[o]=e[o]);return r}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n<a.length;n++)o=a[n],t.indexOf(o)>=0||Object.prototype.propertyIsEnumerable.call(e,o)&&(r[o]=e[o])}return r}(e,i);return(0,r.mdx)(d,s({},c,o,{components:t,mdxType:"MDXLayout"}),(0,r.mdx)(a.MDXScopeProvider,{components:{},mdxType:"MDXScopeProvider"},(0,r.mdx)("p",null,"CLI Aspect manages the commands in the CLI. New commands are registered to this aspect with the necessary data such as, command-name, description and flags. Parsing the args from the CLI is done by Commander package."),(0,r.mdx)("h2",null,"Features"),(0,r.mdx)("ul",null,(0,r.mdx)("li",{parentName:"ul"},"Allow to register new commands"),(0,r.mdx)("li",{parentName:"ul"},"Use commander commands."),(0,r.mdx)("li",{parentName:"ul"},"Render to stdout as string or as a React component by Ink."))))}m.isMDXComponent=!0;const p=[t],l=[e],u={compositions:[{displayName:"Logo",identifier:"Logo"}]}})(),n})()));

package/artifacts/schema.json

@@ -90,7 +90,8 @@
                     "line": 33,
                     "character": 26
                   },
-                  "name": "OnStartSlot"
+                  "name": "OnStartSlot",
+                  "internalFilePath": "cli.main.runtime.ts"
                 },
                 "isOptional": false,
                 "isSpread": false
@@ -110,7 +111,8 @@
                     "line": 34,
                     "character": 34
                   },
-                  "name": "OnCommandStartSlot"
+                  "name": "OnCommandStartSlot",
+                  "internalFilePath": "cli.main.runtime.ts"
                 },
                 "isOptional": false,
                 "isSpread": false
@@ -130,7 +132,8 @@
                     "line": 35,
                     "character": 31
                   },
-                  "name": "OnBeforeExitSlot"
+                  "name": "OnBeforeExitSlot",
+                  "internalFilePath": "cli.main.runtime.ts"
                 },
                 "isOptional": false,
                 "isSpread": false
@@ -150,7 +153,11 @@
                     "line": 36,
                     "character": 21
                   },
-                  "name": "Logger"
+                  "name": "Logger",
+                  "componentId": {
+                    "scope": "teambit.harmony",
+                    "name": "logger"
+                  }
                 },
                 "isOptional": false,
                 "isSpread": false
@@ -346,7 +353,8 @@
                     "line": 74,
                     "character": 29
                   },
-                  "name": "Command"
+                  "name": "Command",
+                  "packageName": "@teambit/legacy/dist/cli/command"
                 },
                 {
                   "__schema": "KeywordTypeSchema",
@@ -468,7 +476,8 @@
                     "line": 95,
                     "character": 30
                   },
-                  "name": "OnStart"
+                  "name": "OnStart",
+                  "internalFilePath": "cli.main.runtime.ts"
                 },
                 "isOptional": false,
                 "isSpread": false
@@ -520,7 +529,8 @@
                     "line": 104,
                     "character": 44
                   },
-                  "name": "OnCommandStart"
+                  "name": "OnCommandStart",
+                  "internalFilePath": "cli.main.runtime.ts"
                 },
                 "isOptional": false,
                 "isSpread": false
@@ -593,7 +603,8 @@
                     "line": 124,
                     "character": 40
                   },
-                  "name": "OnBeforeExitFn"
+                  "name": "OnBeforeExitFn",
+                  "internalFilePath": "cli.main.runtime.ts"
                 },
                 "isOptional": false,
                 "isSpread": false
@@ -760,7 +771,11 @@
                         "line": 172,
                         "character": 20
                       },
-                      "name": "LoggerMain"
+                      "name": "LoggerMain",
+                      "componentId": {
+                        "scope": "teambit.harmony",
+                        "name": "logger"
+                      }
                     }
                   ]
                 },
@@ -819,7 +834,8 @@
                         "line": 176,
                         "character": 7
                       },
-                      "name": "OnStartSlot"
+                      "name": "OnStartSlot",
+                      "internalFilePath": "cli.main.runtime.ts"
                     },
                     {
                       "__schema": "TypeRefSchema",
@@ -828,7 +844,8 @@
                         "line": 177,
                         "character": 7
                       },
-                      "name": "OnCommandStartSlot"
+                      "name": "OnCommandStartSlot",
+                      "internalFilePath": "cli.main.runtime.ts"
                     },
                     {
                       "__schema": "TypeRefSchema",
@@ -837,7 +854,8 @@
                         "line": 178,
                         "character": 7
                       },
-                      "name": "OnBeforeExitSlot"
+                      "name": "OnBeforeExitSlot",
+                      "internalFilePath": "cli.main.runtime.ts"
                     }
                   ]
                 },
@@ -888,7 +906,8 @@
                 "line": 19,
                 "character": 33
               },
-              "name": "Command"
+              "name": "Command",
+              "packageName": "@teambit/legacy/dist/cli/command"
             }
           ]
         }
@@ -910,6 +929,11 @@
             "character": 28
           },
           "name": "SlotRegistry",
+          "componentId": {
+            "scope": "teambit.harmony",
+            "name": "harmony",
+            "version": "0.4.6"
+          },
           "typeArgs": [
             {
               "__schema": "TypeRefSchema",
@@ -1068,7 +1092,7 @@
                 "_legacy": {
                   "scope": "teambit.harmony",
                   "name": "cli",
-                  "version": "0.0.861"
+                  "version": "0.0.862"
                 },
                 "_scope": "teambit.harmony"
               }
@@ -1192,7 +1216,8 @@
                   "line": 19,
                   "character": 33
                 },
-                "name": "Command"
+                "name": "Command",
+                "packageName": "@teambit/legacy/dist/cli/command"
               }
             ]
           }
@@ -1296,7 +1321,7 @@
               "line": 21,
               "character": 30
             },
-            "signature": "(commandName: string, args: CLIArgs, flags: Flags): Promise<void>",
+            "signature": "(commandName: string, args: \u001b[2m(package: @teambit/legacy/dist/cli/command)\u001b[22m CLIArgs, flags: \u001b[2m(package: @teambit/legacy/dist/cli/command)\u001b[22m Flags): Promise<void>",
             "name": "",
             "params": [
               {
@@ -1334,7 +1359,8 @@
                     "line": 21,
                     "character": 58
                   },
-                  "name": "CLIArgs"
+                  "name": "CLIArgs",
+                  "packageName": "@teambit/legacy/dist/cli/command"
                 },
                 "isOptional": false,
                 "isSpread": false
@@ -1354,7 +1380,8 @@
                     "line": 21,
                     "character": 74
                   },
-                  "name": "Flags"
+                  "name": "Flags",
+                  "packageName": "@teambit/legacy/dist/cli/command"
                 },
                 "isOptional": false,
                 "isSpread": false
@@ -1442,6 +1469,11 @@
               "character": 27
             },
             "name": "SlotRegistry",
+            "componentId": {
+              "scope": "teambit.harmony",
+              "name": "harmony",
+              "version": "0.4.6"
+            },
             "typeArgs": [
               {
                 "__schema": "TypeRefSchema",
@@ -1450,7 +1482,8 @@
                   "line": 24,
                   "character": 40
                 },
-                "name": "OnStart"
+                "name": "OnStart",
+                "internalFilePath": "cli.main.runtime.ts"
               }
             ]
           }
@@ -1472,6 +1505,11 @@
               "character": 34
             },
             "name": "SlotRegistry",
+            "componentId": {
+              "scope": "teambit.harmony",
+              "name": "harmony",
+              "version": "0.4.6"
+            },
             "typeArgs": [
               {
                 "__schema": "TypeRefSchema",
@@ -1480,7 +1518,8 @@
                   "line": 25,
                   "character": 47
                 },
-                "name": "OnCommandStart"
+                "name": "OnCommandStart",
+                "internalFilePath": "cli.main.runtime.ts"
               }
             ]
           }
@@ -1502,6 +1541,11 @@
               "character": 28
             },
             "name": "SlotRegistry",
+            "componentId": {
+              "scope": "teambit.harmony",
+              "name": "harmony",
+              "version": "0.4.6"
+            },
             "typeArgs": [
               {
                 "__schema": "TypeRefSchema",
@@ -1532,6 +1576,11 @@
               "character": 32
             },
             "name": "SlotRegistry",
+            "componentId": {
+              "scope": "teambit.harmony",
+              "name": "harmony",
+              "version": "0.4.6"
+            },
             "typeArgs": [
               {
                 "__schema": "TypeRefSchema",
@@ -1540,7 +1589,8 @@
                   "line": 27,
                   "character": 45
                 },
-                "name": "OnBeforeExitFn"
+                "name": "OnBeforeExitFn",
+                "internalFilePath": "cli.main.runtime.ts"
               }
             ]
           }
@@ -1622,7 +1672,8 @@
                       "line": 33,
                       "character": 26
                     },
-                    "name": "OnStartSlot"
+                    "name": "OnStartSlot",
+                    "internalFilePath": "cli.main.runtime.ts"
                   },
                   "isOptional": false,
                   "isSpread": false
@@ -1642,7 +1693,8 @@
                       "line": 34,
                       "character": 34
                     },
-                    "name": "OnCommandStartSlot"
+                    "name": "OnCommandStartSlot",
+                    "internalFilePath": "cli.main.runtime.ts"
                   },
                   "isOptional": false,
                   "isSpread": false
@@ -1662,7 +1714,8 @@
                       "line": 35,
                       "character": 31
                     },
-                    "name": "OnBeforeExitSlot"
+                    "name": "OnBeforeExitSlot",
+                    "internalFilePath": "cli.main.runtime.ts"
                   },
                   "isOptional": false,
                   "isSpread": false
@@ -1682,7 +1735,11 @@
                       "line": 36,
                       "character": 21
                     },
-                    "name": "Logger"
+                    "name": "Logger",
+                    "componentId": {
+                      "scope": "teambit.harmony",
+                      "name": "logger"
+                    }
                   },
                   "isOptional": false,
                   "isSpread": false
@@ -1878,7 +1935,8 @@
                       "line": 74,
                       "character": 29
                     },
-                    "name": "Command"
+                    "name": "Command",
+                    "packageName": "@teambit/legacy/dist/cli/command"
                   },
                   {
                     "__schema": "KeywordTypeSchema",
@@ -2000,7 +2058,8 @@
                       "line": 95,
                       "character": 30
                     },
-                    "name": "OnStart"
+                    "name": "OnStart",
+                    "internalFilePath": "cli.main.runtime.ts"
                   },
                   "isOptional": false,
                   "isSpread": false
@@ -2052,7 +2111,8 @@
                       "line": 104,
                       "character": 44
                     },
-                    "name": "OnCommandStart"
+                    "name": "OnCommandStart",
+                    "internalFilePath": "cli.main.runtime.ts"
                   },
                   "isOptional": false,
                   "isSpread": false
@@ -2125,7 +2185,8 @@
                       "line": 124,
                       "character": 40
                     },
-                    "name": "OnBeforeExitFn"
+                    "name": "OnBeforeExitFn",
+                    "internalFilePath": "cli.main.runtime.ts"
                   },
                   "isOptional": false,
                   "isSpread": false
@@ -2292,7 +2353,11 @@
                           "line": 172,
                           "character": 20
                         },
-                        "name": "LoggerMain"
+                        "name": "LoggerMain",
+                        "componentId": {
+                          "scope": "teambit.harmony",
+                          "name": "logger"
+                        }
                       }
                     ]
                   },
@@ -2351,7 +2416,8 @@
                           "line": 176,
                           "character": 7
                         },
-                        "name": "OnStartSlot"
+                        "name": "OnStartSlot",
+                        "internalFilePath": "cli.main.runtime.ts"
                       },
                       {
                         "__schema": "TypeRefSchema",
@@ -2360,7 +2426,8 @@
                           "line": 177,
                           "character": 7
                         },
-                        "name": "OnCommandStartSlot"
+                        "name": "OnCommandStartSlot",
+                        "internalFilePath": "cli.main.runtime.ts"
                       },
                       {
                         "__schema": "TypeRefSchema",
@@ -2369,7 +2436,8 @@
                           "line": 178,
                           "character": 7
                         },
-                        "name": "OnBeforeExitSlot"
+                        "name": "OnBeforeExitSlot",
+                        "internalFilePath": "cli.main.runtime.ts"
                       }
                     ]
                   },
@@ -2562,7 +2630,7 @@
   "componentId": {
     "scope": "teambit.harmony",
     "name": "cli",
-    "version": "0.0.861"
+    "version": "0.0.862"
   },
   "taggedModuleExports": []
 }

package/dist/cli-parser.d.ts

@@ -0,0 +1,35 @@
+import yargs from 'yargs';
+import { Command } from '@teambit/legacy/dist/cli/command';
+import { GroupsType } from '@teambit/legacy/dist/cli/command-groups';
+import { OnCommandStartSlot } from './cli.main.runtime';
+export declare class CLIParser {
+    private commands;
+    private groups;
+    private onCommandStartSlot;
+    parser: yargs.Argv<{}>;
+    constructor(commands: Command[], groups: GroupsType, onCommandStartSlot: OnCommandStartSlot);
+    parse(args?: string[]): Promise<void>;
+    private setHelpMiddleware;
+    private handleCommandFailure;
+    private configureCompletion;
+    private printHelp;
+    private configureParser;
+    private parseCommandWithSubCommands;
+    private getYargsCommand;
+    private configureGlobalFlags;
+    private throwForNonExistsCommand;
+    /**
+     * manipulate the command help output. there is no API from Yarn to do any of this, so it needs to be done manually.
+     * see https://github.com/yargs/yargs/issues/1956
+     *
+     * the original order of the output:
+     * description
+     * Options
+     * Commands
+     * Global
+     * Positionals
+     * Examples
+     */
+    private logCommandHelp;
+    private findCommandByArgv;
+}

package/dist/cli.aspect.d.ts

@@ -0,0 +1,4 @@
+import { Aspect, RuntimeDefinition } from '@teambit/harmony';
+export declare const MainRuntime: RuntimeDefinition;
+export declare const CLIAspect: Aspect;
+export default CLIAspect;

package/dist/cli.cmd.d.ts

@@ -0,0 +1,32 @@
+import type { Command } from '@teambit/legacy/dist/cli/command';
+import type { CommandOptions } from '@teambit/legacy/dist/cli/legacy-command';
+import { CLIMain } from './cli.main.runtime';
+import { GenerateOpts } from './generate-doc-md';
+export declare class CliGenerateCmd implements Command {
+    private cliMain;
+    name: string;
+    description: string;
+    alias: string;
+    loader: boolean;
+    group: string;
+    options: CommandOptions;
+    constructor(cliMain: CLIMain);
+    report(args: any, { metadata, docs }: GenerateOpts & {
+        docs?: boolean;
+    }): Promise<string>;
+    json(): Promise<(Partial<Command> & {
+        commands?: any;
+    })[]>;
+}
+export declare class CliCmd implements Command {
+    private cliMain;
+    name: string;
+    description: string;
+    alias: string;
+    commands: Command[];
+    loader: boolean;
+    group: string;
+    options: CommandOptions;
+    constructor(cliMain: CLIMain);
+    report(): Promise<string>;
+}

package/dist/cli.composition.d.ts

@@ -0,0 +1 @@
+export declare const Logo: () => import("react/jsx-runtime").JSX.Element;

package/dist/cli.main.runtime.d.ts

@@ -0,0 +1,85 @@
+import { SlotRegistry } from '@teambit/harmony';
+import { CLIArgs, Flags, Command } from '@teambit/legacy/dist/cli/command';
+import { GroupsType } from '@teambit/legacy/dist/cli/command-groups';
+import { Logger, LoggerMain } from '@teambit/logger';
+export type CommandList = Array<Command>;
+export type OnStart = (hasWorkspace: boolean, currentCommand: string) => Promise<void>;
+export type OnCommandStart = (commandName: string, args: CLIArgs, flags: Flags) => Promise<void>;
+export type OnBeforeExitFn = () => Promise<void>;
+export type OnStartSlot = SlotRegistry<OnStart>;
+export type OnCommandStartSlot = SlotRegistry<OnCommandStart>;
+export type CommandsSlot = SlotRegistry<CommandList>;
+export type OnBeforeExitSlot = SlotRegistry<OnBeforeExitFn>;
+export declare class CLIMain {
+    private commandsSlot;
+    private onStartSlot;
+    readonly onCommandStartSlot: OnCommandStartSlot;
+    private onBeforeExitSlot;
+    private logger;
+    groups: GroupsType;
+    constructor(commandsSlot: CommandsSlot, onStartSlot: OnStartSlot, onCommandStartSlot: OnCommandStartSlot, onBeforeExitSlot: OnBeforeExitSlot, logger: Logger);
+    /**
+     * registers a new command in to the CLI.
+     */
+    register(...commands: CommandList): void;
+    /**
+     * helpful for having the same command name in different environments (e.g. legacy and non-legacy).
+     * for example `cli.unregister('tag');` removes the "bit tag" command.
+     */
+    unregister(commandName: string): void;
+    /**
+     * list of all registered commands. (legacy and new).
+     */
+    get commands(): CommandList;
+    /**
+     * get an instance of a registered command. (useful for aspects to modify and extend existing commands)
+     */
+    getCommand(name: string): Command | undefined;
+    /**
+     * when running `bit help`, commands are grouped by categories.
+     * this method helps registering a new group by providing its name and a description.
+     * the name is what needs to be assigned to the `group` property of the Command interface.
+     * the description is what shown in the `bit help` output.
+     */
+    registerGroup(name: string, description: string): void;
+    /**
+     * onStart is when bootstrapping the CLI. (it happens before onCommandStart)
+     */
+    registerOnStart(onStartFn: OnStart): this;
+    /**
+     * onCommandStart is when a command is about to start and we have the command object and the parsed args and flags
+     * already. (it happens after onStart)
+     */
+    registerOnCommandStart(onCommandStartFn: OnCommandStart): this;
+    /**
+     * This will register a function to be called before the process exits.
+     * This will run only for "regular" exits
+     * e.g.
+     * yes - command run and finished successfully
+     * yes - command run and failed gracefully (code 1)
+     * not SIGKILL (kill -9)
+     * not SIGINT (Ctrl+C)
+     * not SIGTERM (kill)
+     * not uncaughtException
+     * not unhandledRejection
+     *
+     * @param onBeforeExitFn
+     * @returns
+     */
+    registerOnBeforeExit(onBeforeExitFn: OnBeforeExitFn): this;
+    /**
+     * execute commands registered to this aspect.
+     */
+    run(hasWorkspace: boolean): Promise<void>;
+    private invokeOnStart;
+    private setDefaults;
+    static dependencies: import("@teambit/harmony").Aspect[];
+    static runtime: import("@teambit/harmony").RuntimeDefinition;
+    static slots: (((registerFn: () => string) => SlotRegistry<CommandList>) | ((registerFn: () => string) => SlotRegistry<OnStart>) | ((registerFn: () => string) => SlotRegistry<OnCommandStart>))[];
+    static provider([loggerMain]: [LoggerMain], config: any, [commandsSlot, onStartSlot, onCommandStartSlot, onBeforeExitSlot]: [
+        CommandsSlot,
+        OnStartSlot,
+        OnCommandStartSlot,
+        OnBeforeExitSlot
+    ]): Promise<CLIMain>;
+}

package/dist/command-runner.d.ts

@@ -0,0 +1,29 @@
+import { CLIArgs, Command, Flags } from '@teambit/legacy/dist/cli/command';
+import { OnCommandStartSlot } from './cli.main.runtime';
+export declare class CommandRunner {
+    private command;
+    private args;
+    private flags;
+    private onCommandStartSlot;
+    private commandName;
+    constructor(command: Command, args: CLIArgs, flags: Flags, onCommandStartSlot: OnCommandStartSlot);
+    /**
+     * run command using one of the handler, "json"/"report"/"render". once done, exit the process.
+     */
+    runCommand(): Promise<boolean | void | null>;
+    private bootstrapCommand;
+    private invokeOnCommandStart;
+    /**
+     * this works for both, Harmony commands and Legacy commands (the legacy-command-adapter
+     * implements json() method)
+     */
+    private runJsonHandler;
+    private runReportHandler;
+    private runWaitHandler;
+    /**
+     * the loader and logger.console write output to the console during the command execution.
+     * for internals commands, such as, _put, _fetch, the command.loader = false.
+     */
+    private determineConsoleWritingDuringCommand;
+    private writeAndExit;
+}

package/dist/completion.cmd.d.ts

@@ -0,0 +1,8 @@
+import { Command } from '@teambit/legacy/dist/cli/command';
+export declare class CompletionCmd implements Command {
+    name: string;
+    description: string;
+    alias: string;
+    group: string;
+    options: never[];
+}

package/dist/exceptions/already-exists.d.ts

@@ -0,0 +1,4 @@
+import { BitError } from '@teambit/bit-error';
+export declare class AlreadyExistsError extends BitError {
+    constructor(type: string, name: string);
+}

package/dist/exceptions/command-not-found.d.ts

@@ -0,0 +1,7 @@
+import { BitError } from '@teambit/bit-error';
+export declare class CommandNotFound extends BitError {
+    commandName: string;
+    suggestion?: string;
+    constructor(commandName: string, suggestion?: string);
+    report(): string;
+}

package/dist/exceptions/index.d.ts

@@ -0,0 +1 @@
+export { AlreadyExistsError } from './already-exists';

package/dist/generate-doc-md.d.ts

@@ -0,0 +1,25 @@
+import { Command } from '@teambit/legacy/dist/cli/command';
+export type GenerateOpts = {
+    metadata?: Record<string, string>;
+};
+type CommandObject = ReturnType<typeof oneCommandToObject> & {
+    commands?: any;
+};
+export declare class GenerateCommandsDoc {
+    private commands;
+    private options;
+    constructor(commands: Command[], options: GenerateOpts);
+    generate(): string;
+    generateJson(): CommandObject[];
+    private commandsToObjects;
+    private getFrontmatter;
+    private getAllPublicCommandsSorted;
+    private generateCommand;
+    private generateSubCommands;
+    private generateArguments;
+    private generateOptions;
+    private formatStringToMD;
+    private formatDescription;
+}
+declare function oneCommandToObject(command: Command): Partial<Command>;
+export {};

package/dist/get-command-id.d.ts

@@ -0,0 +1 @@
+export declare function getCommandId(cmdName: string): string;

package/dist/help.cmd.d.ts

@@ -0,0 +1,16 @@
+import type { Command } from '@teambit/legacy/dist/cli/command';
+import type { CommandOptions } from '@teambit/legacy/dist/cli/legacy-command';
+import { CLIMain } from './cli.main.runtime';
+export declare class HelpCmd implements Command {
+    private cliMain;
+    name: string;
+    description: string;
+    alias: string;
+    loader: boolean;
+    group: string;
+    options: CommandOptions;
+    constructor(cliMain: CLIMain);
+    report(_: any, { internal }: {
+        internal: boolean;
+    }): Promise<string>;
+}

package/dist/help.d.ts

@@ -0,0 +1,3 @@
+import { GroupsType } from '@teambit/legacy/dist/cli/command-groups';
+import { CommandList } from './cli.main.runtime';
+export declare function formatHelp(commands: CommandList, groups: GroupsType, showPrivateCommands?: boolean): string;

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+import { CLIAspect, MainRuntime } from './cli.aspect';
+export type { CLIMain, CommandList, CommandsSlot } from './cli.main.runtime';
+export type { Command, CLIArgs, Flags, GenericObject } from '@teambit/legacy/dist/cli/command';
+export type { CommandOptions } from '@teambit/legacy/dist/cli/legacy-command';
+export * from './exceptions';
+export { CLIAspect as default, MainRuntime, CLIAspect };

package/dist/legacy-command-adapter.d.ts

@@ -0,0 +1,29 @@
+import { LegacyCommand } from '@teambit/legacy/dist/cli/legacy-command';
+import { Command, CommandOptions, GenericObject } from '.';
+import { CLIMain } from './cli.main.runtime';
+export declare class LegacyCommandAdapter implements Command {
+    private cmd;
+    alias: string;
+    name: string;
+    description: string;
+    options: CommandOptions;
+    extendedDescription?: string;
+    group?: string;
+    loader?: boolean;
+    commands: Command[];
+    private?: boolean;
+    skipWorkspace?: boolean;
+    helpUrl?: string;
+    _packageManagerArgs?: string[];
+    constructor(cmd: LegacyCommand, cliExtension: CLIMain);
+    private action;
+    report(params: any, options: {
+        [key: string]: any;
+    }): Promise<{
+        data: string;
+        code: number;
+    }>;
+    json(params: any, options: {
+        [key: string]: any;
+    }): Promise<GenericObject>;
+}

package/dist/{preview-1712805335812.js → preview-1712822929999.js}

@@ -1,5 +1,5 @@
-import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_cli@0.0.861/dist/cli.composition.js';
-import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_cli@0.0.861/dist/cli.docs.mdx';
+import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_cli@0.0.862/dist/cli.composition.js';
+import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_cli@0.0.862/dist/cli.docs.mdx';
 
 export const compositions = [compositions_0];
 export const overview = [overview_0];

package/dist/version.cmd.d.ts

@@ -0,0 +1,14 @@
+import type { Command } from '@teambit/legacy/dist/cli/command';
+import type { CommandOptions } from '@teambit/legacy/dist/cli/legacy-command';
+export declare class VersionCmd implements Command {
+    name: string;
+    description: string;
+    alias: string;
+    loader: boolean;
+    group: string;
+    options: CommandOptions;
+    report(): Promise<any>;
+    json(): Promise<{
+        bit: any;
+    }>;
+}

package/dist/yargs-adapter.d.ts

@@ -0,0 +1,20 @@
+import { Command } from '@teambit/legacy/dist/cli/command';
+import { Arguments, CommandModule, Argv, Options } from 'yargs';
+import { OnCommandStartSlot } from './cli.main.runtime';
+export declare const GLOBAL_GROUP = "Global";
+export declare const STANDARD_GROUP = "Options";
+export declare class YargsAdapter implements CommandModule {
+    private commanderCommand;
+    private onCommandStartSlot;
+    command: string;
+    describe?: string;
+    aliases?: string;
+    constructor(commanderCommand: Command, onCommandStartSlot: OnCommandStartSlot);
+    builder(yargs: Argv): Argv<{}>;
+    handler(argv: Arguments): Promise<boolean | void | null>;
+    get positional(): import("@teambit/legacy/dist/cli/command").CommandArg[] | undefined;
+    static optionsToBuilder(command: Command): {
+        [key: string]: Options;
+    };
+    static getGlobalOptions(command: Command): Record<string, any>;
+}

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/cli",
-  "version": "0.0.861",
+  "version": "0.0.862",
   "homepage": "https://bit.cloud/teambit/harmony/cli",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.harmony",
     "name": "cli",
-    "version": "0.0.861"
+    "version": "0.0.862"
   },
   "dependencies": {
     "chalk": "2.4.2",
@@ -17,7 +17,7 @@
     "pad-right": "0.2.2",
     "@teambit/harmony": "0.4.6",
     "@teambit/bit-error": "0.0.404",
-    "@teambit/logger": "0.0.954"
+    "@teambit/logger": "0.0.955"
   },
   "devDependencies": {
     "@types/didyoumean": "1.2.0",
@@ -25,7 +25,7 @@
     "@types/yargs": "17.0.0",
     "@types/mocha": "9.1.0",
     "chai": "4.3.0",
-    "@teambit/harmony.envs.core-aspect-env": "0.0.30"
+    "@teambit/harmony.envs.core-aspect-env": "0.0.33"
   },
   "peerDependencies": {
     "react": "^17.0.0 || ^18.0.0",

package/tsconfig.json

@@ -20,8 +20,7 @@
     "emitDeclarationOnly": true,
     "strict": true,
     "strictPropertyInitialization": false,
-    "noImplicitAny": false,
-    "composite": true
+    "noImplicitAny": false
   },
   "exclude": [
     "artifacts",
@@ -36,10 +35,5 @@
   "include": [
     "**/*",
     "**/*.json"
-  ],
-  "references": [
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_logger@0.0.954"
-    }
   ]
 }