@teambit/harmony.content.cli-reference 1.95.128 → 1.95.130

package/cli-reference.json

@@ -1839,8 +1839,8 @@
       ],
       [
         "e",
-        "entire-lane",
-        "write also new components that were introduced on the remote lane and do not exist locally"
+        "workspace-only",
+        "when on a lane, avoid introducing new components from the remote lane that do not exist locally"
       ],
       [
         "v",
@@ -2647,8 +2647,8 @@
     ],
     "description": "manage lanes",
     "extendedDescription": "",
-    "group": "ungrouped",
-    "private": true,
+    "group": "collaborate",
+    "private": false,
     "remoteOp": true,
     "skipWorkspace": true,
     "commands": [
@@ -2685,7 +2685,7 @@
         "description": "list lanes",
         "extendedDescription": "",
         "group": "ungrouped",
-        "private": true,
+        "private": false,
         "remoteOp": true,
         "skipWorkspace": true
       },
@@ -2742,7 +2742,7 @@
         "description": "show lane details. if no lane specified, show the current lane",
         "extendedDescription": "",
         "group": "ungrouped",
-        "private": true,
+        "private": false,
         "remoteOp": true,
         "skipWorkspace": true
       },
@@ -2758,13 +2758,13 @@
           [
             "",
             "alias <name>",
-            "a local alias to refer to this lane, defaults to the <lane-name> (can be added later with \"bit lane alias\")"
+            "a local alias to refer to this lane, defaults to the `<lane-name>` (can be added later with \"bit lane alias\")"
           ]
         ],
         "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": false,
         "arguments": [
           {
             "name": "lane-name",
@@ -2810,7 +2810,7 @@
         "description": "changes the remote scope of a lane",
         "extendedDescription": "",
         "group": "ungrouped",
-        "private": true
+        "private": false
       },
       {
         "name": "alias <lane-name> <alias>",
@@ -2819,7 +2819,7 @@
         "description": "adds an alias to a lane",
         "extendedDescription": "an alias is a name that can be used to refer to a lane. it is saved locally and never reach the remote.\nit is useful when having multiple lanes with the same name, but with different remote scopes.",
         "group": "ungrouped",
-        "private": true
+        "private": false
       },
       {
         "name": "rename <current-name> <new-name>",
@@ -2828,7 +2828,7 @@
         "description": "EXPERIMENTAL. change the lane-name locally and on the remote (if exported)",
         "extendedDescription": "",
         "group": "ungrouped",
-        "private": true
+        "private": false
       },
       {
         "name": "diff [values...]",
@@ -2854,7 +2854,7 @@
         "description": "EXPERIMENTAL. adds a readme component to a lane",
         "extendedDescription": "",
         "group": "ungrouped",
-        "private": true,
+        "private": false,
         "skipWorkspace": false,
         "arguments": [
           {
@@ -2874,7 +2874,7 @@
         "description": "EXPERIMENTAL. remove lane readme component",
         "extendedDescription": "",
         "group": "ungrouped",
-        "private": true,
+        "private": false,
         "skipWorkspace": false
       },
       {
@@ -2890,7 +2890,7 @@
         "description": "import a remote lane to your workspace",
         "extendedDescription": "",
         "group": "ungrouped",
-        "private": true,
+        "private": false,
         "arguments": [
           {
             "name": "lane",
@@ -3421,6 +3421,162 @@
     "group": "development",
     "private": false
   },
+  {
+    "name": "ws-config <sub-command>",
+    "alias": "workspace-config",
+    "options": [],
+    "description": "manage workspace config files",
+    "extendedDescription": "",
+    "group": "development",
+    "private": false,
+    "commands": [
+      {
+        "name": "write",
+        "alias": "",
+        "options": [
+          [
+            "c",
+            "clean",
+            "delete existing config files from the workspace. highly recommended to run it with \"--dry-run\" first"
+          ],
+          [
+            "w",
+            "writers <writers>",
+            "only write config files for the given writers. use comma to separate multiple writers. use ws-config list to see all writers"
+          ],
+          [
+            "s",
+            "silent",
+            "do not prompt for confirmation"
+          ],
+          [
+            "",
+            "no-dedupe",
+            "write configs inside each one of the component's dir, avoid deduping"
+          ],
+          [
+            "",
+            "dry-run",
+            "show the paths that configs will be written per env"
+          ],
+          [
+            "",
+            "dry-run-with-content",
+            "use with --json flag. show the config content and the paths it will be written per env"
+          ],
+          [
+            "j",
+            "json",
+            "json format"
+          ]
+        ],
+        "description": "EXPERIMENTAL. write config files in the workspace. useful for IDEs",
+        "extendedDescription": "",
+        "group": "development",
+        "private": false
+      },
+      {
+        "name": "clean",
+        "alias": "",
+        "options": [
+          [
+            "s",
+            "silent",
+            "do not prompt for confirmation"
+          ],
+          [
+            "w",
+            "writers <writers>",
+            "only write config files for the given writers. use comma to separate multiple writers. use ws-config list to see all writers"
+          ],
+          [
+            "",
+            "dry-run",
+            "show the paths that configs will be written per env"
+          ],
+          [
+            "j",
+            "json",
+            "json format"
+          ]
+        ],
+        "description": "EXPERIMENTAL. clean (delete) written config files in the workspace. useful for IDEs",
+        "extendedDescription": "",
+        "group": "development",
+        "private": false
+      },
+      {
+        "name": "list",
+        "alias": "",
+        "options": [
+          [
+            "j",
+            "json",
+            "json format"
+          ]
+        ],
+        "description": "EXPERIMENTAL. list config writers",
+        "extendedDescription": "",
+        "group": "development",
+        "private": false
+      }
+    ]
+  },
+  {
+    "name": "format [component...]",
+    "alias": "",
+    "options": [
+      [
+        "c",
+        "changed",
+        "format only new and modified components"
+      ],
+      [
+        "",
+        "check",
+        "will output a human-friendly message and a list of unformatted files, if any"
+      ],
+      [
+        "j",
+        "json",
+        "return the format results in json format"
+      ]
+    ],
+    "description": "format components in the development workspace",
+    "extendedDescription": "",
+    "group": "development",
+    "private": false
+  },
+  {
+    "name": "lint [component...]",
+    "alias": "",
+    "options": [
+      [
+        "c",
+        "changed",
+        "lint only new and modified components"
+      ],
+      [
+        "f",
+        "fix",
+        "automatically fix problems"
+      ],
+      [
+        "",
+        "fix-type <fixType>",
+        "specify the types of fixes to apply (problem, suggestion, layout)"
+      ],
+      [
+        "j",
+        "json",
+        "return the lint results in json format"
+      ]
+    ],
+    "description": "lint components in the development workspace",
+    "extendedDescription": "",
+    "group": "development",
+    "private": false
+  },
   {
     "name": "test [component-pattern]",
     "alias": "at",
@@ -4006,60 +4162,5 @@
     "extendedDescription": "without --multiple, this will be running on the original scope.\nwith --multiple, a new bare-scope needs to be created and it will import the components to this scope first",
     "group": "development",
     "private": true
-  },
-  {
-    "name": "format [component...]",
-    "alias": "",
-    "options": [
-      [
-        "c",
-        "changed",
-        "format only new and modified components"
-      ],
-      [
-        "",
-        "check",
-        "will output a human-friendly message and a list of unformatted files, if any"
-      ],
-      [
-        "j",
-        "json",
-        "return the format results in json format"
-      ]
-    ],
-    "description": "format components in the development workspace",
-    "extendedDescription": "",
-    "group": "development",
-    "private": false
-  },
-  {
-    "name": "lint [component...]",
-    "alias": "",
-    "options": [
-      [
-        "c",
-        "changed",
-        "lint only new and modified components"
-      ],
-      [
-        "f",
-        "fix",
-        "automatically fix problems"
-      ],
-      [
-        "",
-        "fix-type <fixType>",
-        "specify the types of fixes to apply (problem, suggestion, layout)"
-      ],
-      [
-        "j",
-        "json",
-        "return the lint results in json format"
-      ]
-    ],
-    "description": "lint components in the development workspace",
-    "extendedDescription": "",
-    "group": "development",
-    "private": false
   }
 ]

package/cli-reference.mdx

@@ -240,7 +240,7 @@ with no args, only workspace's capsules are deleted
 | `--manual`                       |       `-m`       | in case of a conflict, leave the files with a conflict state to resolve them manually later         |
 | `--reset`                        |       `-r`       | revert changes that were not snapped/tagged                                                         |
 | `--all`                          |       `-a`       | all components                                                                                      |
-| `--entire-lane`                  |       `-e`       | write also new components that were introduced on the remote lane and do not exist locally          |
+| `--workspace-only`               |       `-e`       | when on a lane, avoid introducing new components from the remote lane that do not exist locally     |
 | `--verbose`                      |       `-v`       | showing verbose output for inspection                                                               |
 | `--reset`                        |                  | DEPRECATED. run "bit checkout reset" instead                                                        |
 | `--skip-npm-install`             |                  | DEPRECATED. use "--skip-dependency-installation" instead                                            |
@@ -745,6 +745,171 @@ when no package is specified, all workspace dependencies are installed and all w
 
 ---
 
+## lane
+
+**Description**: manage lanes
+
+`bit lane [lane-name]`
+
+### lane list
+
+**Usage**: `lane list`
+
+**Description**: list lanes
+
+| **Option**                     | **Option alias** | **Description**                                               |
+| ------------------------------ | :--------------: | ------------------------------------------------------------- |
+| `--details`                    |       `-d`       | show more details on the state of each component in each lane |
+| `--json`                       |       `-j`       | show lanes details in a json format                           |
+| `--remote <remote-scope-name>` |       `-r`       | show remote lanes                                             |
+| `--merged`                     |                  | show merged lanes                                             |
+| `--not-merged`                 |                  | show lanes that are not merged                                |
+
+### lane switch
+
+**Usage**: `lane switch <lane>`
+
+**Description**: switch to the specified lane
+
+| **Option**                       | **Option alias** | **Description**                                                                                       |
+| -------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------- |
+| `--alias <string>`               |       `-n`       | relevant when the specified lane is a remote late. name a local lane differently than the remote lane |
+| `--merge [strategy]`             |       `-m`       | merge local changes with the checked out version. strategy should be "theirs", "ours" or "manual"     |
+| `--get-all`                      |       `-a`       | checkout all components in a lane include ones that do not exist in the workspace                     |
+| `--skip-dependency-installation` |       `-x`       | do not install packages of the imported components                                                    |
+| `--json`                         |       `-j`       | return the output as JSON                                                                             |
+
+### lane show
+
+**Usage**: `lane show [lane-name]`
+
+**Description**: show lane details. if no lane specified, show the current lane
+
+| **Option**          | **Option alias** | **Description**                      |
+| ------------------- | :--------------: | ------------------------------------ |
+| `--json`            |       `-j`       | show the lane details in json format |
+| `--remote <string>` |       `-r`       | show remote lanes                    |
+
+### lane create
+
+**Usage**: `lane create <lane-name>`
+
+**Description**: creates a new lane and switches to it  
+a lane created from main (default-lane) is empty until components are snapped.  
+a lane created from another lane has all the components of the original lane.
+
+| **Option**                    | **Option alias** | **Description**                                                                                                                   |
+| ----------------------------- | :--------------: | --------------------------------------------------------------------------------------------------------------------------------- |
+| `--remote-scope <scope-name>` |                  | remote scope where this lane will be exported to, default to the defaultScope (can be changed later with "bit lane change-scope") |
+| `--alias <name>`              |                  | a local alias to refer to this lane, defaults to the `<lane-name>` (can be added later with "bit lane alias")                     |
+
+### lane remove
+
+**Usage**: `lane remove <lanes...>`
+
+**Description**: remove lanes
+
+| **Option** | **Option alias** | **Description**                                                   |
+| ---------- | :--------------: | ----------------------------------------------------------------- |
+| `--remote` |       `-r`       | remove a remote lane (in the lane arg, use remote/lane-id syntax) |
+| `--force`  |       `-f`       | removes the lane even when the lane was not merged yet            |
+| `--silent` |       `-s`       | skip confirmation                                                 |
+
+### lane change-scope
+
+**Usage**: `lane change-scope <lane-name> <remote-scope-name>`
+
+**Description**: changes the remote scope of a lane
+
+### lane alias
+
+**Usage**: `lane alias <lane-name> <alias>`
+
+**Description**: adds an alias to a lane  
+an alias is a name that can be used to refer to a lane. it is saved locally and never reach the remote.  
+it is useful when having multiple lanes with the same name, but with different remote scopes.
+
+### lane rename
+
+**Usage**: `lane rename <current-name> <new-name>`
+
+**Description**: EXPERIMENTAL. change the lane-name locally and on the remote (if exported)
+
+### lane diff
+
+**Usage**: `lane diff [values...]`
+
+**Description**: show diff between lanes  
+bit lane diff => diff between the current lane and default lane. (only inside workspace).  
+bit lane diff to => diff between the current lane (or default-lane when in scope) and "to" lane.  
+bit lane diff from to => diff between "from" lane and "to" lane.
+
+| **Option**                      | **Option alias** | **Description**                                                       |
+| ------------------------------- | :--------------: | --------------------------------------------------------------------- |
+| `--pattern <component-pattern>` |                  | EXPERIMENTAL. show lane-diff for the specified component-pattern only |
+
+### lane add-readme
+
+**Usage**: `lane add-readme <component-name> [lane-name]`
+
+**Description**: EXPERIMENTAL. adds a readme component to a lane
+
+### lane remove-readme
+
+**Usage**: `lane remove-readme [laneName]`
+
+**Description**: EXPERIMENTAL. remove lane readme component
+
+### lane import
+
+**Usage**: `lane import <lane>`
+
+**Description**: import a remote lane to your workspace
+
+| **Option**                       | **Option alias** | **Description**                                    |
+| -------------------------------- | :--------------: | -------------------------------------------------- |
+| `--skip-dependency-installation` |       `-x`       | do not install packages of the imported components |
+
+### lane merge
+
+**Usage**: `lane merge <lane> [pattern]`
+
+**Description**: merge a local or a remote lane  
+by default, the provided lane will be fetched from the remote before merging.  
+to merge the lane from the local scope without updating it first, use "--skip-fetch" flag.
+
+when the current and the other lanes are diverged in history and the files could be merged with no conflicts,  
+it will snap-merge these components to complete the merge. use "no-snap" to opt-out, or "tag" to tag instead
+
+| **Option**                             | **Option alias** | **Description**                                                                                                                                       |
+| -------------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `--ours`                               |                  | in case of a conflict, override the used version with the current modification                                                                        |
+| `--theirs`                             |                  | in case of a conflict, override the current modification with the specified version                                                                   |
+| `--manual`                             |                  | in case of a conflict, leave the files with a conflict state to resolve them manually later                                                           |
+| `--workspace`                          |                  | merge only components in a lane that exist in the workspace                                                                                           |
+| `--no-snap`                            |                  | do not auto snap in case the merge completed without conflicts                                                                                        |
+| `--tag`                                |                  | tag all lane components after merging into main (also tag-merge in case of snap-merge)                                                                |
+| `--build`                              |                  | in case of snap during the merge, run the build-pipeline (similar to bit snap --build)                                                                |
+| `--message <message>`                  |       `-m`       | override the default message for the auto snap                                                                                                        |
+| `--keep-readme`                        |                  | skip deleting the lane readme component after merging                                                                                                 |
+| `--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`                            |                  | show details of components that were not merged legitimately                                                                                          |
+| `--skip-dependency-installation`       |       `-x`       | do not install packages of the imported components                                                                                                    |
+| `--skip-fetch`                         |                  | use the current target-lane if exits locally without updating it from the remote                                                                      |
+| `--include-deps`                       |                  | EXPERIMENTAL. relevant for "--pattern" and "--workspace". merge also dependencies of the given components                                             |
+| `--resolve-unrelated [merge-strategy]` |                  | EXPERIMENTAL. relevant when a component on a lane and the component on main has nothing in common. merge-strategy can be "ours" (default) or "theirs" |
+
+| **Option**          | **Option alias** | **Description**                                               |
+| ------------------- | :--------------: | ------------------------------------------------------------- |
+| `--details`         |       `-d`       | show more details on the state of each component in each lane |
+| `--json`            |       `-j`       | show lanes details in json format                             |
+| `--remote <string>` |       `-r`       | show remote lanes                                             |
+| `--merged`          |                  | show merged lanes                                             |
+| `--not-merged`      |                  | show not merged lanes                                         |
+
+---
+
 ## link
 
 **Description**: create links in the node_modules directory, to core aspects and to components in the workspace  
@@ -1357,3 +1522,51 @@ list components templates when inside bit-workspace (for bit-create), otherwise,
 | `--json`                  |       `-j`       | json format                                                                                   |
 
 ---
+
+## ws-config
+
+**Alias**: `workspace-config`  
+**Description**: manage workspace config files
+
+`bit ws-config <sub-command>`
+
+### ws-config write
+
+**Usage**: `ws-config write`
+
+**Description**: EXPERIMENTAL. write config files in the workspace. useful for IDEs
+
+| **Option**               | **Option alias** | **Description**                                                                                                              |
+| ------------------------ | :--------------: | ---------------------------------------------------------------------------------------------------------------------------- |
+| `--clean`                |       `-c`       | delete existing config files from the workspace. highly recommended to run it with "--dry-run" first                         |
+| `--writers <writers>`    |       `-w`       | only write config files for the given writers. use comma to separate multiple writers. use ws-config list to see all writers |
+| `--silent`               |       `-s`       | do not prompt for confirmation                                                                                               |
+| `--no-dedupe`            |                  | write configs inside each one of the component's dir, avoid deduping                                                         |
+| `--dry-run`              |                  | show the paths that configs will be written per env                                                                          |
+| `--dry-run-with-content` |                  | use with --json flag. show the config content and the paths it will be written per env                                       |
+| `--json`                 |       `-j`       | json format                                                                                                                  |
+
+### ws-config clean
+
+**Usage**: `ws-config clean`
+
+**Description**: EXPERIMENTAL. clean (delete) written config files in the workspace. useful for IDEs
+
+| **Option**            | **Option alias** | **Description**                                                                                                              |
+| --------------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------- |
+| `--silent`            |       `-s`       | do not prompt for confirmation                                                                                               |
+| `--writers <writers>` |       `-w`       | only write config files for the given writers. use comma to separate multiple writers. use ws-config list to see all writers |
+| `--dry-run`           |                  | show the paths that configs will be written per env                                                                          |
+| `--json`              |       `-j`       | json format                                                                                                                  |
+
+### ws-config list
+
+**Usage**: `ws-config list`
+
+**Description**: EXPERIMENTAL. list config writers
+
+| **Option** | **Option alias** | **Description** |
+| ---------- | :--------------: | --------------- |
+| `--json`   |       `-j`       | json format     |
+
+---