@teambit/harmony.content.cli-reference 1.95.214 → 1.95.216

package/cli-reference.docs.mdx

@@ -1,5 +1,5 @@
 ---
-description: 'Bit command synopses. Bit version: 0.2.36'
+description: 'Bit command synopses. Bit version: 0.2.38'
 labels: ['cli', 'mdx', 'docs']
 ---
       

package/cli-reference.json

@@ -1490,20 +1490,20 @@
     ],
     "examples": [
       {
-        "cmd": "bit create react ui/button",
+        "cmd": "bit create react ui/button --aspect teambit.react/react-env",
         "description": "creates a component named 'ui/button' using the 'react' template"
       },
       {
-        "cmd": "bit create react ui/button pages/register",
-        "description": "creates two components, 'ui/button' and 'pages/register', using the 'react' template"
+        "cmd": "bit create node utils/is-string utils/is-number --aspect teambit.node/node",
+        "description": "creates two components, 'utils/is-string' and 'utils/is-number' using the 'node' template from the 'node' aspect(env)"
       },
       {
-        "cmd": "bit create react ui/button --scope my-org.my-scope",
-        "description": "creates a component named 'ui/button' and sets it scope to 'my-org.my-scope'. \nby default, the scope is the `defaultScope` value, configured in your `workspace.jsonc`."
+        "cmd": "bit create mdx docs/create-components --aspect teambit.mdx/mdx-env --scope my-org.my-scope",
+        "description": "creates an mdx component named 'docs/create-components' and sets it scope to 'my-org.my-scope'. \nby default, the scope is the `defaultScope` value, configured in your `workspace.jsonc`."
       },
       {
-        "cmd": "bit create react ui/button --env teambit.community/envs/community-react@1.95.13",
-        "description": "creates a component named 'ui/button' and sets it to use the 'community-react' env. \n(the template's default env is 'teambit.react/react')."
+        "cmd": "bit create react ui/button --aspect teambit.react/react-env --env teambit.community/envs/community-react@3.0.3",
+        "description": "creates a component named 'ui/button' from the teambit.react/react-env env and sets it to use the 'community-react' env. \n(the template's default env is 'teambit.react/react-env')."
       }
     ]
   },
@@ -3355,9 +3355,15 @@
         ]
       },
       {
-        "name": "change-scope <lane-name> <remote-scope-name>",
+        "name": "change-scope <remote-scope-name>",
         "alias": "",
-        "options": [],
+        "options": [
+          [
+            "l",
+            "lane-name <lane-name>",
+            "the name of the lane to change its remote scope. if not specified, the current lane is used"
+          ]
+        ],
         "description": "changes the remote scope of a lane",
         "extendedDescription": "NOTE: available only before the lane is exported to the remote",
         "group": "ungrouped",
@@ -3373,9 +3379,15 @@
         "private": false
       },
       {
-        "name": "rename <current-name> <new-name>",
+        "name": "rename <new-name>",
         "alias": "",
-        "options": [],
+        "options": [
+          [
+            "l",
+            "lane-name <lane-name>",
+            "the name of the lane to rename. if not specified, the current lane is used"
+          ]
+        ],
         "description": "EXPERIMENTAL. change the lane-name locally and on the remote (if exported)",
         "extendedDescription": "",
         "group": "ungrouped",
@@ -3591,7 +3603,7 @@
           ]
         ],
         "description": "merge a local or a remote lane to the current lane",
-        "extendedDescription": "by default, the provided lane will be fetched from the remote before merging.\nto merge the lane from the local scope without updating it first, use \"--skip-fetch\" flag.\n\nwhen the current and merge candidate lanes are diverged in history and the files could be merged with no conflicts,\nthese components will be snap-merged to complete the merge. use \"no-snap\" to opt-out, or \"tag\" to tag instead",
+        "extendedDescription": "by default, the provided lane will be fetched from the remote before merging.\nto merge the lane from the local scope without updating it first, use \"--skip-fetch\" flag.\n\nwhen the current and merge candidate lanes are diverged in history and the files could be merged with no conflicts,\nthese components will be snap-merged to complete the merge. use \"no-snap\" to opt-out, or \"tag\" to tag instead.\n\nin case a component in both ends don't share history (no snap is found in common), the merge will require \"--resolve-unrelated\" flag.\nthis flag keeps the history of one end and saves a reference to the other end. the decision of which end to keep is determined by the following:\n1. if the component exists on main, then the history linked to main will be kept.\nin this case, the strategy of \"--resolve-unrelated\" only determines which source-code to keep. it's not about the history.\n2. if the component doesn't exist on main, then by default, the history of the current lane will be kept.\nunless \"--resolve-unrelated\" is set to \"theirs\", in which case the history of the other lane will be kept.\n2. a. an edge case: if the component is deleted on the current lane, the strategy will always be \"theirs\".\nso then the history (and the source-code) of the other lane will be kept.\n",
         "private": true,
         "remoteOp": true,
         "arguments": [

package/cli-reference.mdx

@@ -1044,11 +1044,15 @@ a lane created from another lane contains all the components of the original lan
 
 ### lane change-scope
 
-**Usage**: `lane change-scope <lane-name> <remote-scope-name>`
+**Usage**: `lane change-scope <remote-scope-name>`
 
 **Description**: changes the remote scope of a lane  
 NOTE: available only before the lane is exported to the remote
 
+| **Option**                | **Option alias** | **Description**                                                                             |
+| ------------------------- | :--------------: | ------------------------------------------------------------------------------------------- |
+| `--lane-name <lane-name>` |       `-l`       | the name of the lane to change its remote scope. if not specified, the current lane is used |
+
 ### lane alias
 
 **Usage**: `lane alias <lane-name> <alias>`
@@ -1059,10 +1063,14 @@ it is useful e.g. when having multiple lanes with the same name, but with differ
 
 ### lane rename
 
-**Usage**: `lane rename <current-name> <new-name>`
+**Usage**: `lane rename <new-name>`
 
 **Description**: EXPERIMENTAL. change the lane-name locally and on the remote (if exported)
 
+| **Option**                | **Option alias** | **Description**                                                            |
+| ------------------------- | :--------------: | -------------------------------------------------------------------------- |
+| `--lane-name <lane-name>` |       `-l`       | the name of the lane to rename. if not specified, the current lane is used |
+
 ### lane diff
 
 **Usage**: `lane diff [values...]`
@@ -1137,7 +1145,17 @@ 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 merge candidate lanes are diverged in history and the files could be merged with no conflicts,  
-these components will be snap-merged to complete the merge. use "no-snap" to opt-out, or "tag" to tag instead
+these components will be snap-merged to complete the merge. use "no-snap" to opt-out, or "tag" to tag instead.
+
+in case a component in both ends don't share history (no snap is found in common), the merge will require "--resolve-unrelated" flag.  
+this flag keeps the history of one end and saves a reference to the other end. the decision of which end to keep is determined by the following:
+
+1. if the component exists on main, then the history linked to main will be kept.  
+   in this case, the strategy of "--resolve-unrelated" only determines which source-code to keep. it's not about the history.
+2. if the component doesn't exist on main, then by default, the history of the current lane will be kept.  
+   unless "--resolve-unrelated" is set to "theirs", in which case the history of the other lane will be kept.
+3. a. an edge case: if the component is deleted on the current lane, the strategy will always be "theirs".  
+   so then the history (and the source-code) of the other lane will be kept.
 
 | **Arg**   |                                                                                                                                                           **Description**                                                                                                                                                           |
 | --------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |

package/dist/cli-reference.docs.mdx

@@ -1,5 +1,5 @@
 ---
-description: 'Bit command synopses. Bit version: 0.2.36'
+description: 'Bit command synopses. Bit version: 0.2.38'
 labels: ['cli', 'mdx', 'docs']
 ---
       

package/dist/cli-reference.json

@@ -1490,20 +1490,20 @@
         ],
         "examples": [
             {
-                "cmd": "bit create react ui/button",
+                "cmd": "bit create react ui/button --aspect teambit.react/react-env",
                 "description": "creates a component named 'ui/button' using the 'react' template"
             },
             {
-                "cmd": "bit create react ui/button pages/register",
-                "description": "creates two components, 'ui/button' and 'pages/register', using the 'react' template"
+                "cmd": "bit create node utils/is-string utils/is-number --aspect teambit.node/node",
+                "description": "creates two components, 'utils/is-string' and 'utils/is-number' using the 'node' template from the 'node' aspect(env)"
             },
             {
-                "cmd": "bit create react ui/button --scope my-org.my-scope",
-                "description": "creates a component named 'ui/button' and sets it scope to 'my-org.my-scope'. \nby default, the scope is the `defaultScope` value, configured in your `workspace.jsonc`."
+                "cmd": "bit create mdx docs/create-components --aspect teambit.mdx/mdx-env --scope my-org.my-scope",
+                "description": "creates an mdx component named 'docs/create-components' and sets it scope to 'my-org.my-scope'. \nby default, the scope is the `defaultScope` value, configured in your `workspace.jsonc`."
             },
             {
-                "cmd": "bit create react ui/button --env teambit.community/envs/community-react@1.95.13",
-                "description": "creates a component named 'ui/button' and sets it to use the 'community-react' env. \n(the template's default env is 'teambit.react/react')."
+                "cmd": "bit create react ui/button --aspect teambit.react/react-env --env teambit.community/envs/community-react@3.0.3",
+                "description": "creates a component named 'ui/button' from the teambit.react/react-env env and sets it to use the 'community-react' env. \n(the template's default env is 'teambit.react/react-env')."
             }
         ]
     },
@@ -3355,9 +3355,15 @@
                 ]
             },
             {
-                "name": "change-scope <lane-name> <remote-scope-name>",
+                "name": "change-scope <remote-scope-name>",
                 "alias": "",
-                "options": [],
+                "options": [
+                    [
+                        "l",
+                        "lane-name <lane-name>",
+                        "the name of the lane to change its remote scope. if not specified, the current lane is used"
+                    ]
+                ],
                 "description": "changes the remote scope of a lane",
                 "extendedDescription": "NOTE: available only before the lane is exported to the remote",
                 "group": "ungrouped",
@@ -3373,9 +3379,15 @@
                 "private": false
             },
             {
-                "name": "rename <current-name> <new-name>",
+                "name": "rename <new-name>",
                 "alias": "",
-                "options": [],
+                "options": [
+                    [
+                        "l",
+                        "lane-name <lane-name>",
+                        "the name of the lane to rename. if not specified, the current lane is used"
+                    ]
+                ],
                 "description": "EXPERIMENTAL. change the lane-name locally and on the remote (if exported)",
                 "extendedDescription": "",
                 "group": "ungrouped",
@@ -3591,7 +3603,7 @@
                     ]
                 ],
                 "description": "merge a local or a remote lane to the current lane",
-                "extendedDescription": "by default, the provided lane will be fetched from the remote before merging.\nto merge the lane from the local scope without updating it first, use \"--skip-fetch\" flag.\n\nwhen the current and merge candidate lanes are diverged in history and the files could be merged with no conflicts,\nthese components will be snap-merged to complete the merge. use \"no-snap\" to opt-out, or \"tag\" to tag instead",
+                "extendedDescription": "by default, the provided lane will be fetched from the remote before merging.\nto merge the lane from the local scope without updating it first, use \"--skip-fetch\" flag.\n\nwhen the current and merge candidate lanes are diverged in history and the files could be merged with no conflicts,\nthese components will be snap-merged to complete the merge. use \"no-snap\" to opt-out, or \"tag\" to tag instead.\n\nin case a component in both ends don't share history (no snap is found in common), the merge will require \"--resolve-unrelated\" flag.\nthis flag keeps the history of one end and saves a reference to the other end. the decision of which end to keep is determined by the following:\n1. if the component exists on main, then the history linked to main will be kept.\nin this case, the strategy of \"--resolve-unrelated\" only determines which source-code to keep. it's not about the history.\n2. if the component doesn't exist on main, then by default, the history of the current lane will be kept.\nunless \"--resolve-unrelated\" is set to \"theirs\", in which case the history of the other lane will be kept.\n2. a. an edge case: if the component is deleted on the current lane, the strategy will always be \"theirs\".\nso then the history (and the source-code) of the other lane will be kept.\n",
                 "private": true,
                 "remoteOp": true,
                 "arguments": [

package/dist/cli-reference.mdx.js

@@ -5193,11 +5193,47 @@ function MDXContent(_ref) {
     parentName: "p"
   }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
     parentName: "p"
-  }, "lane change-scope <lane-name> <remote-scope-name>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
+  }, "lane change-scope <remote-scope-name>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
     parentName: "p"
   }, "Description"), ": changes the remote scope of a lane", (0, _react2.mdx)("br", {
     parentName: "p"
-  }), "\n", "NOTE: available only before the lane is exported to the remote"), (0, _react2.mdx)("h3", null, "lane alias"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
+  }), "\n", "NOTE: available only before the lane is exported to the remote"), (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"
+  }, "--lane-name <lane-name>")), (0, _react2.mdx)("td", {
+    parentName: "tr",
+    "align": "center"
+  }, (0, _react2.mdx)("inlineCode", {
+    parentName: "td"
+  }, "-l")), (0, _react2.mdx)("td", {
+    parentName: "tr",
+    "align": null
+  }, "the name of the lane to change its remote scope. if not specified, the current lane is used")))), (0, _react2.mdx)("h3", null, "lane alias"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
     parentName: "p"
   }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
     parentName: "p"
@@ -5211,9 +5247,45 @@ function MDXContent(_ref) {
     parentName: "p"
   }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
     parentName: "p"
-  }, "lane rename <current-name> <new-name>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
+  }, "lane rename <new-name>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
     parentName: "p"
-  }, "Description"), ": EXPERIMENTAL. change the lane-name locally and on the remote (if exported)"), (0, _react2.mdx)("h3", null, "lane diff"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
+  }, "Description"), ": EXPERIMENTAL. change the lane-name locally and on the remote (if exported)"), (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"
+  }, "--lane-name <lane-name>")), (0, _react2.mdx)("td", {
+    parentName: "tr",
+    "align": "center"
+  }, (0, _react2.mdx)("inlineCode", {
+    parentName: "td"
+  }, "-l")), (0, _react2.mdx)("td", {
+    parentName: "tr",
+    "align": null
+  }, "the name of the lane to rename. if not specified, the current lane is used")))), (0, _react2.mdx)("h3", null, "lane diff"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
     parentName: "p"
   }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
     parentName: "p"
@@ -5517,7 +5589,21 @@ function MDXContent(_ref) {
     parentName: "p"
   }), "\n", "to merge the lane from the local scope without updating it first, use \"--skip-fetch\" flag."), (0, _react2.mdx)("p", null, "when the current and merge candidate lanes are diverged in history and the files could be merged with no conflicts,", (0, _react2.mdx)("br", {
     parentName: "p"
-  }), "\n", "these components will be snap-merged to complete the merge. use \"no-snap\" to opt-out, or \"tag\" to tag instead"), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
+  }), "\n", "these components will be snap-merged to complete the merge. use \"no-snap\" to opt-out, or \"tag\" to tag instead."), (0, _react2.mdx)("p", null, "in case a component in both ends don't share history (no snap is found in common), the merge will require \"--resolve-unrelated\" flag.", (0, _react2.mdx)("br", {
+    parentName: "p"
+  }), "\n", "this flag keeps the history of one end and saves a reference to the other end. the decision of which end to keep is determined by the following:"), (0, _react2.mdx)("ol", null, (0, _react2.mdx)("li", {
+    parentName: "ol"
+  }, "if the component exists on main, then the history linked to main will be kept.", (0, _react2.mdx)("br", {
+    parentName: "li"
+  }), "in this case, the strategy of \"--resolve-unrelated\" only determines which source-code to keep. it's not about the history."), (0, _react2.mdx)("li", {
+    parentName: "ol"
+  }, "if the component doesn't exist on main, then by default, the history of the current lane will be kept.", (0, _react2.mdx)("br", {
+    parentName: "li"
+  }), "unless \"--resolve-unrelated\" is set to \"theirs\", in which case the history of the other lane will be kept."), (0, _react2.mdx)("li", {
+    parentName: "ol"
+  }, "a. an edge case: if the component is deleted on the current lane, the strategy will always be \"theirs\".", (0, _react2.mdx)("br", {
+    parentName: "li"
+  }), "so then the history (and the source-code) of the other lane will be kept.")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
     parentName: "table"
   }, (0, _react2.mdx)("tr", {
     parentName: "thead"