@teambit/harmony.content.cli-reference 1.95.155 → 1.95.157

package/cli-reference.json

@@ -1330,6 +1330,11 @@
         "aspect <string>",
         "aspect-id of the template. helpful when multiple aspects use the same template name"
       ],
+      [
+        "t",
+        "template <string>",
+        "env-id of the template. alias for --aspect."
+      ],
       [
         "p",
         "path <string>",
@@ -1403,6 +1408,11 @@
         "aspect <aspect-id>",
         "aspect-id of the template. mandatory for non-core aspects. helpful for core aspects in case of a name collision"
       ],
+      [
+        "t",
+        "template <env-id>",
+        "env-id of the template. alias for --env."
+      ],
       [
         "",
         "env <env-id>",
@@ -1996,31 +2006,16 @@
     "name": "remove <component-pattern>",
     "alias": "rm",
     "options": [
-      [
-        "",
-        "soft",
-        "DEPRECATED. use --delete instead"
-      ],
       [
         "",
         "delete",
         "mark the component as deleted. after tag/snap and export the remote will be updated"
       ],
-      [
-        "",
-        "remote",
-        "DEPRECATED. use --hard instead"
-      ],
       [
         "",
         "hard",
         "remove a component completely from a remote scope. careful! this is a permanent change that could corrupt dependents. prefer --delete"
       ],
-      [
-        "",
-        "from-lane",
-        "revert to main if exists on currently checked out lane, otherwise, remove it"
-      ],
       [
         "t",
         "track",
@@ -2043,7 +2038,7 @@
       ]
     ],
     "description": "remove component(s) from the workspace, or a remote scope",
-    "extendedDescription": "to remove components from your local workspace only, use \"bit remove\" (with no flags).\n\nto remove a component from the remote scope, use \"bit remove --delete\", to mark the components as deleted.\nonce tagged/snapped and exported, the remote scope will be updated and it'll be marked as deleted there as well.\nin case this is running on a lane, it'll mark the component as deleted on the lane only, which tells bit not to merge them. the main will not be affected.\n",
+    "extendedDescription": "to remove components from your local workspace only, use \"bit remove\" (with no flags).\n\nto remove a component from the remote scope, use \"bit remove --delete\", to mark the components as deleted.\nonce tagged/snapped and exported, the remote scope will be updated and it'll be marked as deleted there as well.\n\nto remove components from lanes, use \"bit lane remove-comp\".\n",
     "group": "collaborate",
     "private": false,
     "remoteOp": true,
@@ -2770,7 +2765,7 @@
   },
   {
     "name": "lane [lane-name]",
-    "alias": "",
+    "alias": "l",
     "options": [
       [
         "d",
@@ -3072,6 +3067,32 @@
           }
         ]
       },
+      {
+        "name": "remove-comp <component-pattern>",
+        "alias": "rc",
+        "options": [
+          [
+            "",
+            "workspace-only",
+            "do not mark the components as removed. instead, remove them from the workspace only"
+          ],
+          [
+            "",
+            "update-main",
+            "NOT IMPLEMENTED YET. mark as removed on main after merging this lane into main"
+          ]
+        ],
+        "description": "remove components when on a lane",
+        "extendedDescription": "in case the components are part of the lane and the lane is exported, it marks the components as removed,\nand then after snap+export, the remote-lane gets updated as well. upon lane-merge, these components are skipped.\n\nin case the components are not part of the lane or the lane is new, it simply removes the components from the workspace",
+        "group": "collaborate",
+        "private": false,
+        "arguments": [
+          {
+            "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": "merge <lane> [pattern]",
         "alias": "",

package/cli-reference.mdx

@@ -357,6 +357,7 @@ https://bit.dev/docs/config/bit-config
 | `--namespace <string>` |       `-n`       | sets the component's namespace and nested dirs inside the scope                     |
 | `--scope <string>`     |       `-s`       | sets the component's scope-name. if not entered, the default-scope will be used     |
 | `--aspect <string>`    |       `-a`       | aspect-id of the template. helpful when multiple aspects use the same template name |
+| `--template <string>`  |       `-t`       | env-id of the template. alias for --aspect.                                         |
 | `--path <string>`      |       `-p`       | relative path in the workspace. by default the path is `<scope>/<namespace>/<name>` |
 | `--env <string>`       |       `-e`       | set the component's environment. (overrides the env from variants and the template) |
 
@@ -753,6 +754,7 @@ when no package is specified, all workspace dependencies are installed and all w
 
 ## lane
 
+**Alias**: `l`  
 **Description**: manage lanes
 
 `bit lane [lane-name]`
@@ -879,6 +881,21 @@ bit lane diff from to => diff between "from" lane and "to" lane.
 | `--skip-dependency-installation` |       `-x`       | do not install packages of the imported components                                                |
 | `--pattern <component-pattern>`  |       `-p`       | EXPERIMENTAL. switch only the specified component-pattern. works only when the workspace is empty |
 
+### lane remove-comp
+
+**Usage**: `lane remove-comp <component-pattern>`
+
+**Description**: remove components when on a lane  
+in case the components are part of the lane and the lane is exported, it marks the components as removed,  
+and then after snap+export, the remote-lane gets updated as well. upon lane-merge, these components are skipped.
+
+in case the components are not part of the lane or the lane is new, it simply removes the components from the workspace
+
+| **Option**         | **Option alias** | **Description**                                                                     |
+| ------------------ | :--------------: | ----------------------------------------------------------------------------------- |
+| `--workspace-only` |                  | do not mark the components as removed. instead, remove them from the workspace only |
+| `--update-main`    |                  | NOT IMPLEMENTED YET. mark as removed on main after merging this lane into main      |
+
 ### lane merge
 
 **Usage**: `lane merge <lane> [pattern]`
@@ -1066,6 +1083,7 @@ move files or directories of component(s)
 | **Option**                       | **Option alias** | **Description**                                                                                                 |
 | -------------------------------- | :--------------: | --------------------------------------------------------------------------------------------------------------- |
 | `--aspect <aspect-id>`           |       `-a`       | aspect-id of the template. mandatory for non-core aspects. helpful for core aspects in case of a name collision |
+| `--template <env-id>`            |       `-t`       | env-id of the template. alias for --env.                                                                        |
 | `--env <env-id>`                 |                  | env-id of the template                                                                                          |
 | `--default-scope <scope-name>`   |       `-d`       | set defaultScope in the new workspace.jsonc                                                                     |
 | `--standalone`                   |                  | DEPRECATED. use --skip-git instead                                                                              |
@@ -1163,18 +1181,16 @@ for example: "http://localhost:3000", "file:///tmp/local-scope"
 to remove components from your local workspace only, use "bit remove" (with no flags).
 
 to remove a component from the remote scope, use "bit remove --delete", to mark the components as deleted.  
-once tagged/snapped and exported, the remote scope will be updated and it'll be marked as deleted there as well.  
-in case this is running on a lane, it'll mark the component as deleted on the lane only, which tells bit not to merge them. the main will not be affected.
+once tagged/snapped and exported, the remote scope will be updated and it'll be marked as deleted there as well.
+
+to remove components from lanes, use "bit lane remove-comp".
 
 `bit remove <component-pattern>`
 
 | **Option**     | **Option alias** | **Description**                                                                                                                       |
 | -------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------- |
-| `--soft`       |                  | DEPRECATED. use --delete instead                                                                                                      |
 | `--delete`     |                  | mark the component as deleted. after tag/snap and export the remote will be updated                                                   |
-| `--remote`     |                  | DEPRECATED. use --hard instead                                                                                                        |
 | `--hard`       |                  | remove a component completely from a remote scope. careful! this is a permanent change that could corrupt dependents. prefer --delete |
-| `--from-lane`  |                  | revert to main if exists on currently checked out lane, otherwise, remove it                                                          |
 | `--track`      |       `-t`       | keep tracking component in .bitmap (default = false), helps transform a tagged-component to new                                       |
 | `--keep-files` |                  | keep component files (just untrack the component)                                                                                     |
 | `--force`      |       `-f`       | removes the component from the scope, even if used as a dependency. WARNING: components that depend on this component will corrupt    |

package/dist/cli-reference.json

@@ -1330,6 +1330,11 @@
                 "aspect <string>",
                 "aspect-id of the template. helpful when multiple aspects use the same template name"
             ],
+            [
+                "t",
+                "template <string>",
+                "env-id of the template. alias for --aspect."
+            ],
             [
                 "p",
                 "path <string>",
@@ -1403,6 +1408,11 @@
                 "aspect <aspect-id>",
                 "aspect-id of the template. mandatory for non-core aspects. helpful for core aspects in case of a name collision"
             ],
+            [
+                "t",
+                "template <env-id>",
+                "env-id of the template. alias for --env."
+            ],
             [
                 "",
                 "env <env-id>",
@@ -1996,31 +2006,16 @@
         "name": "remove <component-pattern>",
         "alias": "rm",
         "options": [
-            [
-                "",
-                "soft",
-                "DEPRECATED. use --delete instead"
-            ],
             [
                 "",
                 "delete",
                 "mark the component as deleted. after tag/snap and export the remote will be updated"
             ],
-            [
-                "",
-                "remote",
-                "DEPRECATED. use --hard instead"
-            ],
             [
                 "",
                 "hard",
                 "remove a component completely from a remote scope. careful! this is a permanent change that could corrupt dependents. prefer --delete"
             ],
-            [
-                "",
-                "from-lane",
-                "revert to main if exists on currently checked out lane, otherwise, remove it"
-            ],
             [
                 "t",
                 "track",
@@ -2043,7 +2038,7 @@
             ]
         ],
         "description": "remove component(s) from the workspace, or a remote scope",
-        "extendedDescription": "to remove components from your local workspace only, use \"bit remove\" (with no flags).\n\nto remove a component from the remote scope, use \"bit remove --delete\", to mark the components as deleted.\nonce tagged/snapped and exported, the remote scope will be updated and it'll be marked as deleted there as well.\nin case this is running on a lane, it'll mark the component as deleted on the lane only, which tells bit not to merge them. the main will not be affected.\n",
+        "extendedDescription": "to remove components from your local workspace only, use \"bit remove\" (with no flags).\n\nto remove a component from the remote scope, use \"bit remove --delete\", to mark the components as deleted.\nonce tagged/snapped and exported, the remote scope will be updated and it'll be marked as deleted there as well.\n\nto remove components from lanes, use \"bit lane remove-comp\".\n",
         "group": "collaborate",
         "private": false,
         "remoteOp": true,
@@ -2770,7 +2765,7 @@
     },
     {
         "name": "lane [lane-name]",
-        "alias": "",
+        "alias": "l",
         "options": [
             [
                 "d",
@@ -3072,6 +3067,32 @@
                     }
                 ]
             },
+            {
+                "name": "remove-comp <component-pattern>",
+                "alias": "rc",
+                "options": [
+                    [
+                        "",
+                        "workspace-only",
+                        "do not mark the components as removed. instead, remove them from the workspace only"
+                    ],
+                    [
+                        "",
+                        "update-main",
+                        "NOT IMPLEMENTED YET. mark as removed on main after merging this lane into main"
+                    ]
+                ],
+                "description": "remove components when on a lane",
+                "extendedDescription": "in case the components are part of the lane and the lane is exported, it marks the components as removed,\nand then after snap+export, the remote-lane gets updated as well. upon lane-merge, these components are skipped.\n\nin case the components are not part of the lane or the lane is new, it simply removes the components from the workspace",
+                "group": "collaborate",
+                "private": false,
+                "arguments": [
+                    {
+                        "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": "merge <lane> [pattern]",
                 "alias": "",

package/dist/cli-reference.mdx.js

@@ -1542,6 +1542,21 @@ function MDXContent(_ref) {
     "align": null
   }, (0, _react2.mdx)("inlineCode", {
     parentName: "td"
+  }, "--template <string>")), (0, _react2.mdx)("td", {
+    parentName: "tr",
+    "align": "center"
+  }, (0, _react2.mdx)("inlineCode", {
+    parentName: "td"
+  }, "-t")), (0, _react2.mdx)("td", {
+    parentName: "tr",
+    "align": null
+  }, "env-id of the template. alias for --aspect.")), (0, _react2.mdx)("tr", {
+    parentName: "tbody"
+  }, (0, _react2.mdx)("td", {
+    parentName: "tr",
+    "align": null
+  }, (0, _react2.mdx)("inlineCode", {
+    parentName: "td"
   }, "--path <string>")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": "center"
@@ -3417,6 +3432,12 @@ function MDXContent(_ref) {
     "align": null
   }, "do not install optional dependencies (works with pnpm only)")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "lane"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
     parentName: "p"
+  }, "Alias"), ": ", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "l"), (0, _react2.mdx)("br", {
+    parentName: "p"
+  }), "\n", (0, _react2.mdx)("strong", {
+    parentName: "p"
   }, "Description"), ": manage lanes"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
     parentName: "p"
   }, "bit lane [lane-name]")), (0, _react2.mdx)("h3", null, "lane list"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
@@ -3974,7 +3995,64 @@ function MDXContent(_ref) {
   }, "-p")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": null
-  }, "EXPERIMENTAL. switch only the specified component-pattern. works only when the workspace is empty")))), (0, _react2.mdx)("h3", null, "lane merge"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
+  }, "EXPERIMENTAL. switch only the specified component-pattern. works only when the workspace is empty")))), (0, _react2.mdx)("h3", null, "lane remove-comp"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
+    parentName: "p"
+  }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
+    parentName: "p"
+  }, "lane remove-comp <component-pattern>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
+    parentName: "p"
+  }, "Description"), ": remove components when on a lane", (0, _react2.mdx)("br", {
+    parentName: "p"
+  }), "\n", "in case the components are part of the lane and the lane is exported, it marks the components as removed,", (0, _react2.mdx)("br", {
+    parentName: "p"
+  }), "\n", "and then after snap+export, the remote-lane gets updated as well. upon lane-merge, these components are skipped."), (0, _react2.mdx)("p", null, "in case the components are not part of the lane or the lane is new, it simply removes the components from the workspace"), (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"
+  }, "--workspace-only")), (0, _react2.mdx)("td", {
+    parentName: "tr",
+    "align": "center"
+  }), (0, _react2.mdx)("td", {
+    parentName: "tr",
+    "align": null
+  }, "do not mark the components as removed. instead, remove them from the workspace only")), (0, _react2.mdx)("tr", {
+    parentName: "tbody"
+  }, (0, _react2.mdx)("td", {
+    parentName: "tr",
+    "align": null
+  }, (0, _react2.mdx)("inlineCode", {
+    parentName: "td"
+  }, "--update-main")), (0, _react2.mdx)("td", {
+    parentName: "tr",
+    "align": "center"
+  }), (0, _react2.mdx)("td", {
+    parentName: "tr",
+    "align": null
+  }, "NOT IMPLEMENTED YET. mark as removed on main after merging this lane into main")))), (0, _react2.mdx)("h3", null, "lane merge"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
     parentName: "p"
   }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
     parentName: "p"
@@ -5080,6 +5158,21 @@ function MDXContent(_ref) {
     "align": null
   }, (0, _react2.mdx)("inlineCode", {
     parentName: "td"
+  }, "--template <env-id>")), (0, _react2.mdx)("td", {
+    parentName: "tr",
+    "align": "center"
+  }, (0, _react2.mdx)("inlineCode", {
+    parentName: "td"
+  }, "-t")), (0, _react2.mdx)("td", {
+    parentName: "tr",
+    "align": null
+  }, "env-id of the template. alias for --env.")), (0, _react2.mdx)("tr", {
+    parentName: "tbody"
+  }, (0, _react2.mdx)("td", {
+    parentName: "tr",
+    "align": null
+  }, (0, _react2.mdx)("inlineCode", {
+    parentName: "td"
   }, "--env <env-id>")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": "center"
@@ -5419,9 +5512,7 @@ function MDXContent(_ref) {
     parentName: "p"
   }), "\n", "to remove components from your local workspace only, use \"bit remove\" (with no flags)."), (0, _react2.mdx)("p", null, "to remove a component from the remote scope, use \"bit remove --delete\", to mark the components as deleted.", (0, _react2.mdx)("br", {
     parentName: "p"
-  }), "\n", "once tagged/snapped and exported, the remote scope will be updated and it'll be marked as deleted there as well.", (0, _react2.mdx)("br", {
-    parentName: "p"
-  }), "\n", "in case this is running on a lane, it'll mark the component as deleted on the lane only, which tells bit not to merge them. the main will not be affected."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
+  }), "\n", "once tagged/snapped and exported, the remote scope will be updated and it'll be marked as deleted there as well."), (0, _react2.mdx)("p", null, "to remove components from lanes, use \"bit lane remove-comp\"."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
     parentName: "p"
   }, "bit remove <component-pattern>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
     parentName: "table"
@@ -5451,19 +5542,6 @@ function MDXContent(_ref) {
     "align": null
   }, (0, _react2.mdx)("inlineCode", {
     parentName: "td"
-  }, "--soft")), (0, _react2.mdx)("td", {
-    parentName: "tr",
-    "align": "center"
-  }), (0, _react2.mdx)("td", {
-    parentName: "tr",
-    "align": null
-  }, "DEPRECATED. use --delete instead")), (0, _react2.mdx)("tr", {
-    parentName: "tbody"
-  }, (0, _react2.mdx)("td", {
-    parentName: "tr",
-    "align": null
-  }, (0, _react2.mdx)("inlineCode", {
-    parentName: "td"
   }, "--delete")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": "center"
@@ -5477,19 +5555,6 @@ function MDXContent(_ref) {
     "align": null
   }, (0, _react2.mdx)("inlineCode", {
     parentName: "td"
-  }, "--remote")), (0, _react2.mdx)("td", {
-    parentName: "tr",
-    "align": "center"
-  }), (0, _react2.mdx)("td", {
-    parentName: "tr",
-    "align": null
-  }, "DEPRECATED. use --hard instead")), (0, _react2.mdx)("tr", {
-    parentName: "tbody"
-  }, (0, _react2.mdx)("td", {
-    parentName: "tr",
-    "align": null
-  }, (0, _react2.mdx)("inlineCode", {
-    parentName: "td"
   }, "--hard")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": "center"
@@ -5503,19 +5568,6 @@ function MDXContent(_ref) {
     "align": null
   }, (0, _react2.mdx)("inlineCode", {
     parentName: "td"
-  }, "--from-lane")), (0, _react2.mdx)("td", {
-    parentName: "tr",
-    "align": "center"
-  }), (0, _react2.mdx)("td", {
-    parentName: "tr",
-    "align": null
-  }, "revert to main if exists on currently checked out lane, otherwise, remove it")), (0, _react2.mdx)("tr", {
-    parentName: "tbody"
-  }, (0, _react2.mdx)("td", {
-    parentName: "tr",
-    "align": null
-  }, (0, _react2.mdx)("inlineCode", {
-    parentName: "td"
   }, "--track")), (0, _react2.mdx)("td", {
     parentName: "tr",
     "align": "center"