@teambit/harmony.content.cli-reference 1.95.76 → 1.95.78

package/dist/cli-reference.json

@@ -1455,122 +1455,6 @@
         "group": "ungrouped",
         "private": true
     },
-    {
-        "name": "install [packages...]",
-        "alias": "in",
-        "options": [
-            [
-                "v",
-                "variants <variants>",
-                "add packages to specific variants"
-            ],
-            [
-                "t",
-                "type [lifecycleType]",
-                "\"runtime\" (default) or \"peer\" (dev is not a valid option)"
-            ],
-            [
-                "u",
-                "update-existing [updateExisting]",
-                "update existing dependencies version and types"
-            ],
-            [
-                "",
-                "save-prefix [savePrefix]",
-                "set the prefix to use when adding dependency to workspace.jsonc"
-            ],
-            [
-                "",
-                "skip-dedupe [skipDedupe]",
-                "do not dedupe dependencies on installation"
-            ],
-            [
-                "",
-                "skip-import [skipImport]",
-                "do not import bit objects post installation"
-            ],
-            [
-                "",
-                "add-missing-peers [addMissingPeers]",
-                "install all missing peer dependencies"
-            ]
-        ],
-        "description": "installs workspace dependencies",
-        "extendedDescription": "when no package is specified, all workspace dependencies are installed and all workspace components are imported.",
-        "group": "development",
-        "private": false,
-        "arguments": [
-            {
-                "name": "packages...",
-                "description": "a list of packages to install (separated by spaces)"
-            }
-        ]
-    },
-    {
-        "name": "uninstall [packages...]",
-        "alias": "un",
-        "options": [],
-        "description": "uninstall dependencies",
-        "extendedDescription": "",
-        "group": "development",
-        "private": false
-    },
-    {
-        "name": "update",
-        "alias": "up",
-        "options": [
-            [
-                "y",
-                "yes",
-                "automatically update all outdated packages"
-            ]
-        ],
-        "description": "update dependencies",
-        "extendedDescription": "",
-        "group": "development",
-        "private": false
-    },
-    {
-        "name": "link [component-names...]",
-        "alias": "",
-        "options": [
-            [
-                "j",
-                "json",
-                "return the output as JSON"
-            ],
-            [
-                "",
-                "verbose",
-                "verbose output"
-            ],
-            [
-                "r",
-                "rewire",
-                "Replace relative paths with module paths in code (e.g. \"../foo\" => \"@bit/foo\")"
-            ],
-            [
-                "",
-                "target <dir>",
-                "EXPERIMENTAL. link to an external directory (similar to npm-link) so other projects could use these components"
-            ],
-            [
-                "",
-                "skip-fetching-objects",
-                "skip fetch missing objects from remotes before linking"
-            ]
-        ],
-        "description": "create links in the node_modules directory, to core aspects and to components in the workspace",
-        "extendedDescription": "https://bit.dev/docs/workspace/component-links",
-        "group": "development",
-        "private": false,
-        "arguments": [
-            {
-                "name": "component-names...",
-                "description": "names or IDs of the components to link"
-            }
-        ]
-    },
     {
         "name": "create <template-name> <component-names...>",
         "alias": "",
@@ -1791,6 +1675,158 @@
             }
         ]
     },
+    {
+        "name": "compile [component-names...]",
+        "alias": "",
+        "options": [
+            [
+                "c",
+                "changed",
+                "compile only new and modified components"
+            ],
+            [
+                "v",
+                "verbose",
+                "show more data, such as, dist paths"
+            ],
+            [
+                "j",
+                "json",
+                "return the compile results in json format"
+            ],
+            [
+                "d",
+                "delete-dist-dir",
+                "delete existing dist folder before writing new compiled files"
+            ]
+        ],
+        "description": "compile components in the workspace",
+        "extendedDescription": "",
+        "group": "development",
+        "private": false,
+        "arguments": [
+            {
+                "name": "component-names...",
+                "description": "a list of component names or component IDs (defaults to all components)"
+            }
+        ]
+    },
+    {
+        "name": "install [packages...]",
+        "alias": "in",
+        "options": [
+            [
+                "v",
+                "variants <variants>",
+                "add packages to specific variants"
+            ],
+            [
+                "t",
+                "type [lifecycleType]",
+                "\"runtime\" (default) or \"peer\" (dev is not a valid option)"
+            ],
+            [
+                "u",
+                "update-existing [updateExisting]",
+                "update existing dependencies version and types"
+            ],
+            [
+                "",
+                "save-prefix [savePrefix]",
+                "set the prefix to use when adding dependency to workspace.jsonc"
+            ],
+            [
+                "",
+                "skip-dedupe [skipDedupe]",
+                "do not dedupe dependencies on installation"
+            ],
+            [
+                "",
+                "skip-import [skipImport]",
+                "do not import bit objects post installation"
+            ],
+            [
+                "",
+                "add-missing-peers [addMissingPeers]",
+                "install all missing peer dependencies"
+            ]
+        ],
+        "description": "installs workspace dependencies",
+        "extendedDescription": "when no package is specified, all workspace dependencies are installed and all workspace components are imported.",
+        "group": "development",
+        "private": false,
+        "arguments": [
+            {
+                "name": "packages...",
+                "description": "a list of packages to install (separated by spaces)"
+            }
+        ]
+    },
+    {
+        "name": "uninstall [packages...]",
+        "alias": "un",
+        "options": [],
+        "description": "uninstall dependencies",
+        "extendedDescription": "",
+        "group": "development",
+        "private": false
+    },
+    {
+        "name": "update",
+        "alias": "up",
+        "options": [
+            [
+                "y",
+                "yes",
+                "automatically update all outdated packages"
+            ]
+        ],
+        "description": "update dependencies",
+        "extendedDescription": "",
+        "group": "development",
+        "private": false
+    },
+    {
+        "name": "link [component-names...]",
+        "alias": "",
+        "options": [
+            [
+                "j",
+                "json",
+                "return the output as JSON"
+            ],
+            [
+                "",
+                "verbose",
+                "verbose output"
+            ],
+            [
+                "r",
+                "rewire",
+                "Replace relative paths with module paths in code (e.g. \"../foo\" => \"@bit/foo\")"
+            ],
+            [
+                "",
+                "target <dir>",
+                "EXPERIMENTAL. link to an external directory (similar to npm-link) so other projects could use these components"
+            ],
+            [
+                "",
+                "skip-fetching-objects",
+                "skip fetch missing objects from remotes before linking"
+            ]
+        ],
+        "description": "create links in the node_modules directory, to core aspects and to components in the workspace",
+        "extendedDescription": "https://bit.dev/docs/workspace/component-links",
+        "group": "development",
+        "private": false,
+        "arguments": [
+            {
+                "name": "component-names...",
+                "description": "names or IDs of the components to link"
+            }
+        ]
+    },
     {
         "name": "insights [names...]",
         "alias": "",
@@ -2703,8 +2739,8 @@
         ]
     },
     {
-        "name": "dependencies <sub-command>",
-        "alias": "deps",
+        "name": "deps <sub-command>",
+        "alias": "dependencies",
         "options": [],
         "description": "manage dependencies",
         "extendedDescription": "",
@@ -2746,7 +2782,7 @@
                         "description": "component name, component id, or component pattern. use component pattern to select multiple components.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
                     },
                     {
-                        "name": "package",
+                        "name": "package...",
                         "description": "package name with or without a version, e.g. \"lodash@1.0.0\" or just \"lodash\" which will remove all lodash instances of any version"
                     }
                 ]
@@ -2791,7 +2827,7 @@
                         "description": "component name, component id, or component pattern. use component pattern to select multiple components.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
                     },
                     {
-                        "name": "package",
+                        "name": "package...",
                         "description": "package name with or without a version, e.g. \"lodash@1.0.0\" or just \"lodash\" which will be resolved to the latest"
                     }
                 ]
@@ -2946,42 +2982,6 @@
         "group": "development",
         "private": false
     },
-    {
-        "name": "compile [component-names...]",
-        "alias": "",
-        "options": [
-            [
-                "c",
-                "changed",
-                "compile only new and modified components"
-            ],
-            [
-                "v",
-                "verbose",
-                "show more data, such as, dist paths"
-            ],
-            [
-                "j",
-                "json",
-                "return the compile results in json format"
-            ],
-            [
-                "d",
-                "delete-dist-dir",
-                "delete existing dist folder before writing new compiled files"
-            ]
-        ],
-        "description": "compile components in the workspace",
-        "extendedDescription": "",
-        "group": "development",
-        "private": false,
-        "arguments": [
-            {
-                "name": "component-names...",
-                "description": "a list of component names or component IDs (defaults to all components)"
-            }
-        ]
-    },
     {
         "name": "run <app-name>",
         "alias": "c",

package/dist/cli-reference.mdx.js

@@ -1596,27 +1596,29 @@ function MDXContent(_ref) {
   }, "-e")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
-  }, "set the component's environment. (overrides the env from variants and the template)")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "dependencies"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
+  }, "set the component's environment. (overrides the env from variants and the template)")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "dependents"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Alias"), ": ", (0, _react2.mdx)("inlineCode", {
-    parentName: "p"
-  }, "deps"), (0, _react2.mdx)("br", {
+  }, "Workspace only"), ": yes", (0, _react2.mdx)("br", {
     parentName: "p"
   }), "\n", (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Workspace only"), ": yes", (0, _react2.mdx)("br", {
+  }, "Description"), ": EXPERIMENTAL. show dependents of the given component"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
     parentName: "p"
-  }), "\n", (0, _react2.mdx)("strong", {
+  }, "bit dependents <component-name>")), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "deprecate"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": manage dependencies"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
+  }, "Alias"), ": ", (0, _react2.mdx)("inlineCode", {
     parentName: "p"
-  }, "bit dependencies <sub-command>")), (0, _react2.mdx)("h3", null, "dependencies get"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
+  }, "d"), (0, _react2.mdx)("br", {
     parentName: "p"
-  }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
+  }), "\n", (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "dependencies get <component-name>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
+  }, "Workspace only"), ": no", (0, _react2.mdx)("br", {
     parentName: "p"
-  }, "Description"), ": show direct and indirect dependencies of the given component"), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
+  }), "\n", (0, _react2.mdx)("strong", {
+    parentName: "p"
+  }, "Description"), ": deprecate a component"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "bit deprecate <component-name>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
     parentName: "table"
   }, (0, _react2.mdx)("tr", {
     parentName: "thead"
@@ -1644,33 +1646,33 @@ function MDXContent(_ref) {
     "align": null
   }, (0, _react2.mdx)("inlineCode", {
     parentName: "td"
-  }, "--tree")), (0, _react2.mdx)("td", {
+  }, "--new-id <string>")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": "center"
-  }, (0, _react2.mdx)("inlineCode", {
-    parentName: "td"
-  }, "-t")), (0, _react2.mdx)("td", {
+  }), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
-  }, "EXPERIMENTAL. render dependencies as a tree, similar to \"npm ls\"")))), (0, _react2.mdx)("h3", null, "dependencies remove"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
+  }, "if replaced by another component, enter the new component id")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "deps"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
+  }, "Alias"), ": ", (0, _react2.mdx)("inlineCode", {
     parentName: "p"
-  }, "dependencies remove <component-pattern> <package...>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
+  }, "dependencies"), (0, _react2.mdx)("br", {
     parentName: "p"
-  }, "Description"), ": remove a dependency to component(s)"), (0, _react2.mdx)("h3", null, "dependencies debug"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
+  }), "\n", (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
+  }, "Workspace only"), ": yes", (0, _react2.mdx)("br", {
+    parentName: "p"
+  }), "\n", (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "dependencies debug <component-name>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
+  }, "Description"), ": manage dependencies"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
     parentName: "p"
-  }, "Description"), ": show the immediate dependencies and how their versions were determined"), (0, _react2.mdx)("h3", null, "dependencies set"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
+  }, "bit deps <sub-command>")), (0, _react2.mdx)("h3", null, "deps get"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
     parentName: "p"
   }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
     parentName: "p"
-  }, "dependencies set <component-pattern> <package...>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
+  }, "deps get <component-name>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": set a dependency to component(s)"), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
+  }, "Description"), ": show direct and indirect dependencies of the given component"), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
     parentName: "table"
   }, (0, _react2.mdx)("tr", {
     parentName: "thead"
@@ -1698,52 +1700,33 @@ function MDXContent(_ref) {
     "align": null
   }, (0, _react2.mdx)("inlineCode", {
     parentName: "td"
-  }, "--dev")), (0, _react2.mdx)("td", {
-    parentName: "tr",
-    "align": "center"
-  }, (0, _react2.mdx)("inlineCode", {
-    parentName: "td"
-  }, "-d")), (0, _react2.mdx)("td", {
-    parentName: "tr",
-    "align": null
-  }, "add to the devDependencies")), (0, _react2.mdx)("tr", {
-    parentName: "tbody"
-  }, (0, _react2.mdx)("td", {
-    parentName: "tr",
-    "align": null
-  }, (0, _react2.mdx)("inlineCode", {
-    parentName: "td"
-  }, "--peer")), (0, _react2.mdx)("td", {
+  }, "--tree")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": "center"
   }, (0, _react2.mdx)("inlineCode", {
     parentName: "td"
-  }, "-p")), (0, _react2.mdx)("td", {
+  }, "-t")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
-  }, "add to the peerDependencies")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "dependents"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
-    parentName: "p"
-  }, "Workspace only"), ": yes", (0, _react2.mdx)("br", {
-    parentName: "p"
-  }), "\n", (0, _react2.mdx)("strong", {
+  }, "EXPERIMENTAL. render dependencies as a tree, similar to \"npm ls\"")))), (0, _react2.mdx)("h3", null, "deps remove"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": EXPERIMENTAL. show dependents of the given component"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
+  }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
     parentName: "p"
-  }, "bit dependents <component-name>")), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "deprecate"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
+  }, "deps remove <component-pattern> <package...>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Alias"), ": ", (0, _react2.mdx)("inlineCode", {
+  }, "Description"), ": remove a dependency to component(s)"), (0, _react2.mdx)("h3", null, "deps debug"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "d"), (0, _react2.mdx)("br", {
+  }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
     parentName: "p"
-  }), "\n", (0, _react2.mdx)("strong", {
+  }, "deps debug <component-name>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Workspace only"), ": no", (0, _react2.mdx)("br", {
+  }, "Description"), ": show the immediate dependencies and how their versions were determined"), (0, _react2.mdx)("h3", null, "deps set"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
     parentName: "p"
-  }), "\n", (0, _react2.mdx)("strong", {
+  }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
     parentName: "p"
-  }, "Description"), ": deprecate a component"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
+  }, "deps set <component-pattern> <package...>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "bit deprecate <component-name>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
+  }, "Description"), ": set a dependency to component(s)"), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
     parentName: "table"
   }, (0, _react2.mdx)("tr", {
     parentName: "thead"
@@ -1771,13 +1754,30 @@ function MDXContent(_ref) {
     "align": null
   }, (0, _react2.mdx)("inlineCode", {
     parentName: "td"
-  }, "--new-id <string>")), (0, _react2.mdx)("td", {
+  }, "--dev")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": "center"
-  }), (0, _react2.mdx)("td", {
+  }, (0, _react2.mdx)("inlineCode", {
+    parentName: "td"
+  }, "-d")), (0, _react2.mdx)("td", {
+    parentName: "tr",
+    "align": null
+  }, "add to the devDependencies")), (0, _react2.mdx)("tr", {
+    parentName: "tbody"
+  }, (0, _react2.mdx)("td", {
+    parentName: "tr",
+    "align": null
+  }, (0, _react2.mdx)("inlineCode", {
+    parentName: "td"
+  }, "--peer")), (0, _react2.mdx)("td", {
+    parentName: "tr",
+    "align": "center"
+  }, (0, _react2.mdx)("inlineCode", {
+    parentName: "td"
+  }, "-p")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
-  }, "if replaced by another component, enter the new component id")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "diff"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
+  }, "add to the peerDependencies")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "diff"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
     parentName: "p"
   }, "Workspace only"), ": yes", (0, _react2.mdx)("br", {
     parentName: "p"