@teambit/harmony.content.cli-reference 1.95.66 → 1.95.69

package/dist/cli-reference.json

@@ -989,81 +989,6 @@
             }
         ]
     },
-    {
-        "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": "update",
-        "alias": "up",
-        "options": [
-            [
-                "y",
-                "yes",
-                "automatically update all outdated packages"
-            ]
-        ],
-        "description": "update dependencies",
-        "extendedDescription": "",
-        "group": "development",
-        "private": false
-    },
-    {
-        "name": "uninstall [packages...]",
-        "alias": "un",
-        "options": [],
-        "description": "uninstall dependencies",
-        "extendedDescription": "",
-        "group": "development",
-        "private": false
-    },
     {
         "name": "eject-conf <pattern>",
         "alias": "",
@@ -1205,47 +1130,6 @@
         "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": "use <component-id>",
         "alias": "",
@@ -1300,7 +1184,7 @@
         ]
     },
     {
-        "name": "checkout [values...]",
+        "name": "checkout <to> [component-pattern]",
         "alias": "U",
         "options": [
             [
@@ -1338,6 +1222,11 @@
                 "verbose",
                 "showing verbose output for inspection"
             ],
+            [
+                "",
+                "reset",
+                "DEPRECATED. run \"bit checkout reset\" instead"
+            ],
             [
                 "",
                 "skip-npm-install",
@@ -1347,27 +1236,22 @@
                 "",
                 "skip-dependency-installation",
                 "do not install packages of the imported components"
-            ],
-            [
-                "",
-                "ignore-package-json",
-                "do not generate package.json for the imported component(s). (it automatically enables skip-npm-install and save-dependencies-as-components flags)"
-            ],
-            [
-                "",
-                "conf [path]",
-                "write the configuration file (bit.json) and the envs configuration files (use --conf without path to write to the default dir)"
-            ],
-            [
-                "",
-                "ignore-dist",
-                "do not write dist files (when exist)"
             ]
         ],
         "description": "switch between component versions or remove local changes",
-        "extendedDescription": "\n  `bit checkout <version> [ids...]` => checkout the specified ids (or all components when --all is used) to the specified version\n  `bit checkout head` => checkout all components to their latest versions\n  `bit checkout head [ids...]` => checkout the specified ids to their latest versions\n  `bit checkout [ids...] --reset` => remove local modifications from the specified ids (or all components when --all is used)\n  you can use a pattern for multiple ids, such as bit checkout 0.0.1 \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
+        "extendedDescription": "\n  `bit checkout <version> [component-pattern]` => checkout the specified ids (or all components when --all is used) to the specified version\n  `bit checkout head [component-pattern]` => checkout to the last snap/tag, omit [component-pattern] to checkout head for all\n  `bit checkout reset [component-pattern]` => remove local modifications from the specified ids (or all components when --all is used)",
         "group": "development",
-        "private": false
+        "private": false,
+        "arguments": [
+            {
+                "name": "to",
+                "description": "permitted values: [head, reset, specific-version]. 'head' - last snap/tag. 'reset' - removes local changes"
+            },
+            {
+                "name": "component-pattern",
+                "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": "remove <component-pattern>",
@@ -1422,6 +1306,122 @@
             }
         ]
     },
+    {
+        "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": "",
@@ -2113,6 +2113,11 @@
                         "no-squash",
                         "EXPERIMENTAL. relevant for merging lanes into main, which by default squash."
                     ],
+                    [
+                        "",
+                        "ignore-config-changes",
+                        "allow merging when component are modified due to config changes (such as dependencies) only and not files"
+                    ],
                     [
                         "",
                         "verbose",
@@ -3402,6 +3407,11 @@
                 "email <string>",
                 "email to be saved as part of the version log"
             ],
+            [
+                "",
+                "lane <lane-id>",
+                "helps to fetch the components from the lane scope (relevant for --multiple)"
+            ],
             [
                 "",
                 "skip-new-scope-validation",

package/dist/cli-reference.mdx.js

@@ -13,7 +13,7 @@ var _excluded = ["components"];
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
 
-function _extends() { _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
+function _extends() { _extends = Object.assign ? Object.assign.bind() : function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
 
 function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
 
@@ -998,23 +998,17 @@ function MDXContent(_ref) {
     parentName: "p"
   }, "Description"), ": switch between component versions or remove local changes"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
     parentName: "p"
-  }, "bit checkout <version> [ids...]"), " => checkout the specified ids (or all components when --all is used) to the specified version", (0, _react2.mdx)("br", {
+  }, "bit checkout <version> [component-pattern]"), " => checkout the specified ids (or all components when --all is used) to the specified version", (0, _react2.mdx)("br", {
     parentName: "p"
   }), "\n", "", (0, _react2.mdx)("inlineCode", {
     parentName: "p"
-  }, "bit checkout head"), " => checkout all components to their latest versions", (0, _react2.mdx)("br", {
+  }, "bit checkout head [component-pattern]"), " => checkout to the last snap/tag, omit ", "[component-pattern]", " to checkout head for all", (0, _react2.mdx)("br", {
     parentName: "p"
   }), "\n", "", (0, _react2.mdx)("inlineCode", {
     parentName: "p"
-  }, "bit checkout head [ids...]"), " => checkout the specified ids to their latest versions", (0, _react2.mdx)("br", {
+  }, "bit checkout reset [component-pattern]"), " => remove local modifications from the specified ids (or all components when --all is used)"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
     parentName: "p"
-  }), "\n", "", (0, _react2.mdx)("inlineCode", {
-    parentName: "p"
-  }, "bit checkout [ids...] --reset"), " => remove local modifications from the specified ids (or all components when --all is used)", (0, _react2.mdx)("br", {
-    parentName: "p"
-  }), "\n", "you can use a pattern for multiple ids, such as bit checkout 0.0.1 \"utils/", "*", "\". (wrap the pattern with quotes to avoid collision with shell commands)"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
-    parentName: "p"
-  }, "bit checkout [values...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
+  }, "bit checkout <to> [component-pattern]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
     parentName: "table"
   }, (0, _react2.mdx)("tr", {
     parentName: "thead"
@@ -1147,65 +1141,39 @@ function MDXContent(_ref) {
     "align": null
   }, (0, _react2.mdx)("inlineCode", {
     parentName: "td"
-  }, "--skip-npm-install")), (0, _react2.mdx)("td", {
-    parentName: "tr",
-    "align": "center"
-  }), (0, _react2.mdx)("td", {
-    parentName: "tr",
-    "align": null
-  }, "DEPRECATED. use \"--skip-dependency-installation\" instead")), (0, _react2.mdx)("tr", {
-    parentName: "tbody"
-  }, (0, _react2.mdx)("td", {
-    parentName: "tr",
-    "align": null
-  }, (0, _react2.mdx)("inlineCode", {
-    parentName: "td"
-  }, "--skip-dependency-installation")), (0, _react2.mdx)("td", {
-    parentName: "tr",
-    "align": "center"
-  }), (0, _react2.mdx)("td", {
-    parentName: "tr",
-    "align": null
-  }, "do not install packages of the imported components")), (0, _react2.mdx)("tr", {
-    parentName: "tbody"
-  }, (0, _react2.mdx)("td", {
-    parentName: "tr",
-    "align": null
-  }, (0, _react2.mdx)("inlineCode", {
-    parentName: "td"
-  }, "--ignore-package-json")), (0, _react2.mdx)("td", {
+  }, "--reset")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": "center"
   }), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
-  }, "do not generate package.json for the imported component(s). (it automatically enables skip-npm-install and save-dependencies-as-components flags)")), (0, _react2.mdx)("tr", {
+  }, "DEPRECATED. run \"bit checkout reset\" instead")), (0, _react2.mdx)("tr", {
     parentName: "tbody"
   }, (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
   }, (0, _react2.mdx)("inlineCode", {
     parentName: "td"
-  }, "--conf [path]")), (0, _react2.mdx)("td", {
+  }, "--skip-npm-install")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": "center"
   }), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
-  }, "write the configuration file (bit.json) and the envs configuration files (use --conf without path to write to the default dir)")), (0, _react2.mdx)("tr", {
+  }, "DEPRECATED. use \"--skip-dependency-installation\" instead")), (0, _react2.mdx)("tr", {
     parentName: "tbody"
   }, (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
   }, (0, _react2.mdx)("inlineCode", {
     parentName: "td"
-  }, "--ignore-dist")), (0, _react2.mdx)("td", {
+  }, "--skip-dependency-installation")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": "center"
   }), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
-  }, "do not write dist files (when exist)")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "clear-cache"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
+  }, "do not install packages of the imported components")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "clear-cache"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
     parentName: "p"
   }, "Alias"), ": ", (0, _react2.mdx)("inlineCode", {
     parentName: "p"