@teambit/harmony.content.cli-reference 1.95.37 → 1.95.40

package/dist/cli-reference.json

@@ -210,7 +210,7 @@
         "private": true
     },
     {
-        "name": "dependents <id>",
+        "name": "dependents <component-name>",
         "alias": "",
         "options": [],
         "description": "EXPERIMENTAL. show dependents of the given component",
@@ -219,7 +219,7 @@
         "private": false
     },
     {
-        "name": "dependencies <id>",
+        "name": "dependencies <component-name>",
         "alias": "",
         "options": [
             [
@@ -233,7 +233,7 @@
                 "show the immediate dependencies and how their version was determined"
             ]
         ],
-        "description": "EXPERIMENTAL. show dependencies (direct and indirect) of the given component",
+        "description": "EXPERIMENTAL. show direct and indirect dependencies of the given component",
         "extendedDescription": "",
         "group": "info",
         "private": false
@@ -324,21 +324,6 @@
         "private": true,
         "internal": true
     },
-    {
-        "name": "inject-conf [id]",
-        "alias": "",
-        "options": [
-            [
-                "f",
-                "force",
-                "force injecting even if there are config files changes"
-            ]
-        ],
-        "description": "injecting components configuration",
-        "extendedDescription": "",
-        "group": "ungrouped",
-        "private": true
-    },
     {
         "name": "_scope <path> <args>",
         "alias": "",
@@ -349,36 +334,6 @@
         "private": true,
         "internal": true
     },
-    {
-        "name": "ci-update <id> [scopePath]",
-        "alias": "",
-        "options": [
-            [
-                "d",
-                "directory [file]",
-                "directory to run ci-update"
-            ],
-            [
-                "k",
-                "keep",
-                "keep test environment after run (default false)"
-            ],
-            [
-                "c",
-                "no-cache",
-                "ignore component cache when creating dist file"
-            ],
-            [
-                "o",
-                "output [file]",
-                "save ci results to file system"
-            ]
-        ],
-        "description": "run an update for build and test of a certain bit-component",
-        "extendedDescription": "",
-        "group": "ungrouped",
-        "private": true
-    },
     {
         "name": "cat-scope [scopePath]",
         "alias": "",
@@ -474,21 +429,11 @@
                 "main <file>",
                 "define entry point for the components"
             ],
-            [
-                "t",
-                "tests <file>/\"<file>,<file>\"",
-                "LEGACY ONLY. specify test files to track. use quotation marks to list files or use a glob pattern"
-            ],
             [
                 "n",
                 "namespace <namespace>",
                 "organize component in a namespace"
             ],
-            [
-                "e",
-                "exclude <file>/\"<file>,<file>\"",
-                "LEGACY ONLY. exclude file from being tracked. use quotation marks to list files or use a glob pattern"
-            ],
             [
                 "o",
                 "override <boolean>",
@@ -505,21 +450,6 @@
         "group": "development",
         "private": false
     },
-    {
-        "name": "untrack [ids...]",
-        "alias": "u",
-        "options": [
-            [
-                "a",
-                "all",
-                "revert add for all tracked components"
-            ]
-        ],
-        "description": "DEPRECATED (use \"bit remove\" instead). untrack a new component(s)\n  https://legacy-docs.bit.dev/docs/add-and-isolate-components#untracking-components\n  you can use a pattern for multiple ids, such as bit untrack \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
-        "extendedDescription": "",
-        "group": "ungrouped",
-        "private": true
-    },
     {
         "name": "untag [component-name] [component-version]",
         "alias": "",
@@ -548,13 +478,7 @@
     {
         "name": "move <current-component-dir> <new-component-dir>",
         "alias": "mv",
-        "options": [
-            [
-                "c",
-                "component",
-                "LEGACY ONLY. move component files that are spread over multiple directories to one directory. synopsis: `move <component-id> <directory>`"
-            ]
-        ],
+        "options": [],
         "description": "move a component to a different filesystem path",
         "extendedDescription": "move files or directories of component(s)\n  https://bit.dev/docs/workspace/moving-components",
         "group": "development",
@@ -611,26 +535,6 @@
         "private": true,
         "internal": true
     },
-    {
-        "name": "_deprecate <path> <args>",
-        "alias": "",
-        "options": [],
-        "description": "deprecate a component from a scope",
-        "extendedDescription": "",
-        "group": "ungrouped",
-        "private": true,
-        "internal": true
-    },
-    {
-        "name": "_undeprecate <path> <args>",
-        "alias": "",
-        "options": [],
-        "description": "undeprecate a component from a scope",
-        "extendedDescription": "",
-        "group": "ungrouped",
-        "private": true,
-        "internal": true
-    },
     {
         "name": "_latest <path> <args>",
         "alias": "",
@@ -668,7 +572,7 @@
             [
                 "r",
                 "reset",
-                "remove local changes"
+                "revert changes that were not snapped"
             ],
             [
                 "a",
@@ -784,11 +688,6 @@
                 "v",
                 "verbose",
                 "showing logs for the migration process"
-            ],
-            [
-                "h",
-                "harmony",
-                "migrate workspace from legacy to Harmony"
             ]
         ],
         "description": "migrate scope to the current version",
@@ -1187,7 +1086,7 @@
                     [
                         "r",
                         "refactor",
-                        "change the source code of all components using the original scope-name with the new scope-name"
+                        "update the import statements in all dependent components to the new package name (that contains the new scope name)"
                     ]
                 ],
                 "description": "Renames the scope name for all components with the specified 'current scope name'",
@@ -1620,7 +1519,7 @@
             [
                 "",
                 "dependents",
-                "EXPERIMENTAL. import component dependents to allow auto-tag updating them upon tag"
+                "EXPERIMENTAL. import the components' dependents. this enables changes to propagate from (modified) components to their dependents"
             ],
             [
                 "",
@@ -2072,7 +1971,7 @@
             [
                 "i",
                 "ignore-issues [issues]",
-                "ignore component issues (shown in \"bit status\" as \"issues found\"), issues to ignore:\n[MissingPackagesDependenciesOnFs, MissingComponents, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingLinks, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, MissingCustomModuleResolutionLinks, ImportNonMainFiles, CustomModuleResolutionUsed, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies]\nto ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify \"*\"."
+                "ignore component issues (shown in \"bit status\" as \"issues found\"), issues to ignore:\n[MissingPackagesDependenciesOnFs, MissingComponents, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, CustomModuleResolutionUsed, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies]\nto ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify \"*\"."
             ],
             [
                 "I",
@@ -2124,7 +2023,7 @@
         ]
     },
     {
-        "name": "snap [component-name]",
+        "name": "snap [component-pattern]",
         "alias": "",
         "options": [
             [
@@ -2165,7 +2064,7 @@
             [
                 "i",
                 "ignore-issues [issues]",
-                "ignore component issues (shown in \"bit status\" as \"issues found\"), issues to ignore:\n[MissingPackagesDependenciesOnFs, MissingComponents, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingLinks, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, MissingCustomModuleResolutionLinks, ImportNonMainFiles, CustomModuleResolutionUsed, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies]\nto ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify \"*\"."
+                "ignore component issues (shown in \"bit status\" as \"issues found\"), issues to ignore:\n[MissingPackagesDependenciesOnFs, MissingComponents, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, CustomModuleResolutionUsed, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies]\nto ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify \"*\"."
             ],
             [
                 "a",
@@ -2184,8 +2083,8 @@
         "private": true,
         "arguments": [
             {
-                "name": "component_name",
-                "description": "component names or component ID (defaults to all components)"
+                "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. By default, all new and modified components are snapped."
             }
         ]
     },
@@ -2673,7 +2572,7 @@
         ]
     },
     {
-        "name": "deprecate <id>",
+        "name": "deprecate <component-name>",
         "alias": "d",
         "options": [
             [
@@ -2687,7 +2586,13 @@
         "group": "collaborate",
         "private": false,
         "remoteOp": true,
-        "skipWorkspace": true
+        "skipWorkspace": true,
+        "arguments": [
+            {
+                "name": "component-name",
+                "description": "component name or component id"
+            }
+        ]
     },
     {
         "name": "undeprecate <id>",
@@ -2923,7 +2828,13 @@
                 "description": "creates a new lane and switches to it",
                 "extendedDescription": "a lane created from main (default-lane) is empty until components are snapped.\na lane created from another lane has all the components of the original lane.",
                 "group": "ungrouped",
-                "private": true
+                "private": true,
+                "arguments": [
+                    {
+                        "name": "lane-name",
+                        "description": "the name for the new lane"
+                    }
+                ]
             },
             {
                 "name": "merge <lane>",
@@ -2977,7 +2888,17 @@
                     [
                         "",
                         "squash",
-                        "squash multiple snaps. keep the last one only"
+                        "EXPERIMENTAL. squash multiple snaps. keep the last one only"
+                    ],
+                    [
+                        "",
+                        "pattern <component-pattern>",
+                        "EXPERIMENTAL. partially merge the lane with the specified component-pattern"
+                    ],
+                    [
+                        "",
+                        "include-deps",
+                        "EXPERIMENTAL. relevant for \"--pattern\" and \"--existing\". merge also dependencies of the given components"
                     ]
                 ],
                 "description": "merge a local or a remote lane",

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; }
 
@@ -111,21 +111,6 @@ function MDXContent(_ref) {
     "align": null
   }, (0, _react2.mdx)("inlineCode", {
     parentName: "td"
-  }, "--tests <file>/\"<file>,<file>\"")), (0, _react2.mdx)("td", {
-    parentName: "tr",
-    "align": "center"
-  }, (0, _react2.mdx)("inlineCode", {
-    parentName: "td"
-  }, "-t")), (0, _react2.mdx)("td", {
-    parentName: "tr",
-    "align": null
-  }, "LEGACY ONLY. specify test files to track. use quotation marks to list files or use a glob pattern")), (0, _react2.mdx)("tr", {
-    parentName: "tbody"
-  }, (0, _react2.mdx)("td", {
-    parentName: "tr",
-    "align": null
-  }, (0, _react2.mdx)("inlineCode", {
-    parentName: "td"
   }, "--namespace <namespace>")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": "center"
@@ -141,21 +126,6 @@ function MDXContent(_ref) {
     "align": null
   }, (0, _react2.mdx)("inlineCode", {
     parentName: "td"
-  }, "--exclude <file>/\"<file>,<file>\"")), (0, _react2.mdx)("td", {
-    parentName: "tr",
-    "align": "center"
-  }, (0, _react2.mdx)("inlineCode", {
-    parentName: "td"
-  }, "-e")), (0, _react2.mdx)("td", {
-    parentName: "tr",
-    "align": null
-  }, "LEGACY ONLY. exclude file from being tracked. use quotation marks to list files or use a glob pattern")), (0, _react2.mdx)("tr", {
-    parentName: "tbody"
-  }, (0, _react2.mdx)("td", {
-    parentName: "tr",
-    "align": null
-  }, (0, _react2.mdx)("inlineCode", {
-    parentName: "td"
   }, "--override <boolean>")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": "center"
@@ -1021,7 +991,7 @@ function MDXContent(_ref) {
   }, "-r")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
-  }, "remove local changes")), (0, _react2.mdx)("tr", {
+  }, "revert changes that were not snapped")), (0, _react2.mdx)("tr", {
     parentName: "tbody"
   }, (0, _react2.mdx)("td", {
     parentName: "tr",
@@ -1532,9 +1502,9 @@ function MDXContent(_ref) {
     parentName: "p"
   }), "\n", (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": EXPERIMENTAL. show dependencies (direct and indirect) of the given component"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
+  }, "Description"), ": EXPERIMENTAL. show direct and indirect dependencies of the given component"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
     parentName: "p"
-  }, "bit dependencies <id>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
+  }, "bit dependencies <component-name>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
     parentName: "table"
   }, (0, _react2.mdx)("tr", {
     parentName: "thead"
@@ -1593,7 +1563,7 @@ function MDXContent(_ref) {
     parentName: "p"
   }, "Description"), ": EXPERIMENTAL. show dependents of the given component"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
     parentName: "p"
-  }, "bit dependents <id>")), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "deprecate"), (0, _react2.mdx)("p", null, (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"
   }, "Alias"), ": ", (0, _react2.mdx)("inlineCode", {
     parentName: "p"
@@ -1607,7 +1577,7 @@ function MDXContent(_ref) {
     parentName: "p"
   }, "Description"), ": deprecate a component"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
     parentName: "p"
-  }, "bit deprecate <id>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
+  }, "bit deprecate <component-name>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
     parentName: "table"
   }, (0, _react2.mdx)("tr", {
     parentName: "thead"
@@ -2643,7 +2613,7 @@ function MDXContent(_ref) {
   }), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
-  }, "EXPERIMENTAL. import component dependents to allow auto-tag updating them upon tag")), (0, _react2.mdx)("tr", {
+  }, "EXPERIMENTAL. import the components' dependents. this enables changes to propagate from (modified) components to their dependents")), (0, _react2.mdx)("tr", {
     parentName: "tbody"
   }, (0, _react2.mdx)("td", {
     parentName: "tr",
@@ -3650,45 +3620,7 @@ function MDXContent(_ref) {
     "href": "https://bit.dev/docs/workspace/moving-components"
   }, "https://bit.dev/docs/workspace/moving-components")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
     parentName: "p"
-  }, "bit move <current-component-dir> <new-component-dir>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
-    parentName: "table"
-  }, (0, _react2.mdx)("tr", {
-    parentName: "thead"
-  }, (0, _react2.mdx)("th", {
-    parentName: "tr",
-    "align": null
-  }, (0, _react2.mdx)("strong", {
-    parentName: "th"
-  }, "Option")), (0, _react2.mdx)("th", {
-    parentName: "tr",
-    "align": "center"
-  }, (0, _react2.mdx)("strong", {
-    parentName: "th"
-  }, "Option alias")), (0, _react2.mdx)("th", {
-    parentName: "tr",
-    "align": null
-  }, (0, _react2.mdx)("strong", {
-    parentName: "th"
-  }, "Description")))), (0, _react2.mdx)("tbody", {
-    parentName: "table"
-  }, (0, _react2.mdx)("tr", {
-    parentName: "tbody"
-  }, (0, _react2.mdx)("td", {
-    parentName: "tr",
-    "align": null
-  }, (0, _react2.mdx)("inlineCode", {
-    parentName: "td"
-  }, "--component")), (0, _react2.mdx)("td", {
-    parentName: "tr",
-    "align": "center"
-  }, (0, _react2.mdx)("inlineCode", {
-    parentName: "td"
-  }, "-c")), (0, _react2.mdx)("td", {
-    parentName: "tr",
-    "align": null
-  }, "LEGACY ONLY. move component files that are spread over multiple directories to one directory. synopsis: ", (0, _react2.mdx)("inlineCode", {
-    parentName: "td"
-  }, "move <component-id> <directory>"))))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "new"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
+  }, "bit move <current-component-dir> <new-component-dir>")), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "new"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
     parentName: "p"
   }, "Workspace only"), ": yes", (0, _react2.mdx)("br", {
     parentName: "p"
@@ -4622,7 +4554,7 @@ function MDXContent(_ref) {
   }, "-r")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
-  }, "change the source code of all components using the original scope-name with the new scope-name")))), (0, _react2.mdx)("h3", null, "scope fork"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
+  }, "update the import statements in all dependent components to the new package name (that contains the new scope name)")))), (0, _react2.mdx)("h3", null, "scope fork"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
     parentName: "p"
   }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
     parentName: "p"
@@ -5239,7 +5171,7 @@ function MDXContent(_ref) {
   }, "-i")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
-  }, "ignore component issues (shown in \"bit status\" as \"issues found\"), issues to ignore:")))), (0, _react2.mdx)("p", null, "[MissingPackagesDependenciesOnFs, MissingComponents, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingLinks, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, MissingCustomModuleResolutionLinks, ImportNonMainFiles, CustomModuleResolutionUsed, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies]", "\nto ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify \"", "*", "\".|\n|", (0, _react2.mdx)("inlineCode", {
+  }, "ignore component issues (shown in \"bit status\" as \"issues found\"), issues to ignore:")))), (0, _react2.mdx)("p", null, "[MissingPackagesDependenciesOnFs, MissingComponents, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, CustomModuleResolutionUsed, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies]", "\nto ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify \"", "*", "\".|\n|", (0, _react2.mdx)("inlineCode", {
     parentName: "p"
   }, "--ignore-newest-version"), "|", (0, _react2.mdx)("inlineCode", {
     parentName: "p"