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

package/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/cli-reference.mdx

@@ -12,15 +12,13 @@ all flags support glob patterns and {PARENT} {FILE_NAME} annotations
 
 `bit add [path...]`
 
-| **Option**                         | **Option alias** | **Description**                                                                                       |
-| ---------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------- |
-| `--id <name>`                      |       `-i`       | manually set component id                                                                             |
-| `--main <file>`                    |       `-m`       | define entry point for the components                                                                 |
-| `--tests <file>/"<file>,<file>"`   |       `-t`       | LEGACY ONLY. specify test files to track. use quotation marks to list files or use a glob pattern     |
-| `--namespace <namespace>`          |       `-n`       | organize component in a namespace                                                                     |
-| `--exclude <file>/"<file>,<file>"` |       `-e`       | LEGACY ONLY. exclude file from being tracked. use quotation marks to list files or use a glob pattern |
-| `--override <boolean>`             |       `-o`       | override existing component if exists (default = false)                                               |
-| `--scope <string>`                 |       `-s`       | sets the component's scope-name. if not entered, the default-scope will be used                       |
+| **Option**                | **Option alias** | **Description**                                                                 |
+| ------------------------- | :--------------: | ------------------------------------------------------------------------------- |
+| `--id <name>`             |       `-i`       | manually set component id                                                       |
+| `--main <file>`           |       `-m`       | define entry point for the components                                           |
+| `--namespace <namespace>` |       `-n`       | organize component in a namespace                                               |
+| `--override <boolean>`    |       `-o`       | override existing component if exists (default = false)                         |
+| `--scope <string>`        |       `-s`       | sets the component's scope-name. if not entered, the default-scope will be used |
 
 ---
 
@@ -216,7 +214,7 @@ with no args, only workspace's capsules are deleted
 | `--ours`                         |       `-o`       | in case of a conflict, override the used version with the current modification                                                                    |
 | `--theirs`                       |       `-t`       | in case of a conflict, override the current modification with the specified version                                                               |
 | `--manual`                       |       `-m`       | in case of a conflict, leave the files with a conflict state to resolve them manually later                                                       |
-| `--reset`                        |       `-r`       | remove local changes                                                                                                                              |
+| `--reset`                        |       `-r`       | revert changes that were not snapped                                                                                                              |
 | `--all`                          |       `-a`       | all components                                                                                                                                    |
 | `--verbose`                      |       `-v`       | showing verbose output for inspection                                                                                                             |
 | `--skip-npm-install`             |                  | DEPRECATED. use "--skip-dependency-installation" instead                                                                                          |
@@ -359,9 +357,9 @@ https://bit.dev/docs/config/bit-config
 ## dependencies
 
 **Workspace only**: yes  
-**Description**: EXPERIMENTAL. show dependencies (direct and indirect) of the given component
+**Description**: EXPERIMENTAL. show direct and indirect dependencies of the given component
 
-`bit dependencies <id>`
+`bit dependencies <component-name>`
 
 | **Option** | **Option alias** | **Description**                                                      |
 | ---------- | :--------------: | -------------------------------------------------------------------- |
@@ -375,7 +373,7 @@ https://bit.dev/docs/config/bit-config
 **Workspace only**: yes  
 **Description**: EXPERIMENTAL. show dependents of the given component
 
-`bit dependents <id>`
+`bit dependents <component-name>`
 
 ---
 
@@ -385,7 +383,7 @@ https://bit.dev/docs/config/bit-config
 **Workspace only**: no  
 **Description**: deprecate a component
 
-`bit deprecate <id>`
+`bit deprecate <component-name>`
 
 | **Option**          | **Option alias** | **Description**                                              |
 | ------------------- | :--------------: | ------------------------------------------------------------ |
@@ -624,7 +622,7 @@ you can use a pattern for multiple ids, such as bit import "utils/\*". (wrap the
 | `--skip-dependency-installation` |                  | do not install packages of the imported components                                                                                                                 |
 | `--merge [strategy]`             |       `-m`       | merge local changes with the imported version. strategy should be "theirs", "ours" or "manual"                                                                     |
 | `--dependencies`                 |                  | EXPERIMENTAL. import all dependencies and write them to the workspace                                                                                              |
-| `--dependents`                   |                  | EXPERIMENTAL. import component dependents to allow auto-tag updating them upon tag                                                                                 |
+| `--dependents`                   |                  | EXPERIMENTAL. import the components' dependents. this enables changes to propagate from (modified) components to their dependents                                  |
 | `--save-in-lane`                 |                  | EXPERIMENTAL. when checked out to a lane and the component is not on the remote-lane, save it in the lane (default to save on main)                                |
 | `--all-history`                  |                  | relevant for fetching all components objects. avoid optimizations, fetch all history versions, always                                                              |
 
@@ -804,10 +802,6 @@ move files or directories of component(s)
 
 `bit move <current-component-dir> <new-component-dir>`
 
-| **Option**    | **Option alias** | **Description**                                                                                                                           |
-| ------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------------- |
-| `--component` |       `-c`       | LEGACY ONLY. move component files that are spread over multiple directories to one directory. synopsis: `move <component-id> <directory>` |
-
 ---
 
 ## new
@@ -1027,9 +1021,9 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
 
 **Description**: Renames the scope name for all components with the specified 'current scope name'
 
-| **Option**   | **Option alias** | **Description**                                                                                |
-| ------------ | :--------------: | ---------------------------------------------------------------------------------------------- |
-| `--refactor` |       `-r`       | change the source code of all components using the original scope-name with the new scope-name |
+| **Option**   | **Option alias** | **Description**                                                                                                     |
+| ------------ | :--------------: | ------------------------------------------------------------------------------------------------------------------- |
+| `--refactor` |       `-r`       | update the import statements in all dependent components to the new package name (that contains the new scope name) |
 
 ### scope fork
 
@@ -1155,7 +1149,7 @@ https://bit.dev/components/tags
 | `--increment-by <number>`    |                  | (default to 1) increment semver flag (patch/minor/major) by. e.g. incrementing patch by 2: 0.0.1 -> 0.0.3.                     |
 | `--ignore-issues [issues]`   |       `-i`       | ignore component issues (shown in "bit status" as "issues found"), issues to ignore:                                           |
 
-[MissingPackagesDependenciesOnFs, MissingComponents, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingLinks, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, MissingCustomModuleResolutionLinks, ImportNonMainFiles, CustomModuleResolutionUsed, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies]
+[MissingPackagesDependenciesOnFs, MissingComponents, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, CustomModuleResolutionUsed, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies]
 to ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify "\*".|
 |`--ignore-newest-version`|`-I`|ignore existing of newer versions (default = false)|
 |`--build`|`-b`|EXPERIMENTAL. not needed for now. run the pipeline build and complete the tag|