@teambit/harmony.content.cli-reference 2.0.150 → 2.0.152

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,5 +1,5 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.6.35'
2
+ description: 'Bit command synopses. Bit version: 1.6.37'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
5
5
 
@@ -450,31 +450,6 @@
450
450
  "group": "ungrouped",
451
451
  "private": true
452
452
  },
453
- {
454
- "name": "untag [component-name] [component-version]",
455
- "alias": "",
456
- "options": [
457
- [
458
- "a",
459
- "all",
460
- "revert tag for all tagged components"
461
- ],
462
- [
463
- "",
464
- "soft",
465
- "harmony - revert only soft-tags (components tagged with --soft flag)"
466
- ],
467
- [
468
- "f",
469
- "force",
470
- "revert the tag even if used as a dependency. WARNING: components that depend on this tag will corrupt"
471
- ]
472
- ],
473
- "description": "revert tagged or snapped versions for component(s)",
474
- "extendedDescription": "https://bit.dev/components/tags#undoing-a-tag\nyou can use a pattern for multiple ids, such as bit untag \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
475
- "group": "development",
476
- "private": true
477
- },
478
453
  {
479
454
  "name": "_delete <path> <args>",
480
455
  "alias": "",
@@ -983,7 +958,7 @@
983
958
  "update the import statements in all dependent components to the new package name (i.e. with the new scope name)"
984
959
  ]
985
960
  ],
986
- "description": "Renames the scope name for all components with the specified 'current scope name' - only available for new components that have not yet been snapped/tagged",
961
+ "description": "rename the scope name for all components with the specified 'current scope name', if exported, create new components and deprecate the original ones",
987
962
  "extendedDescription": "Note: if `<current-scope-name>` is also the defaultScope for the workspace, this command will set `<new-scope-name>`\nas the defaultScope instead, and that will then be set for all components by default. You may see updates in your .bitmap file\nas a result of this change",
988
963
  "group": "development",
989
964
  "arguments": [
@@ -4470,11 +4445,6 @@
4470
4445
  "scope <scope-name>",
4471
4446
  "define the scope for the newly created component"
4472
4447
  ],
4473
- [
4474
- "p",
4475
- "path <relative-path>",
4476
- "relative path in the workspace to place new component in. by default, the directory of the new component is from your workspace's \"defaultScope\" value"
4477
- ],
4478
4448
  [
4479
4449
  "r",
4480
4450
  "refactor",
@@ -4494,9 +4464,14 @@
4494
4464
  "",
4495
4465
  "delete",
4496
4466
  "EXPERIMENTAL. instead of deprecating the original component, delete it"
4467
+ ],
4468
+ [
4469
+ "p",
4470
+ "path <relative-path>",
4471
+ "relative path in the workspace to place new component in. by default, the directory of the new component is from your workspace's \"defaultScope\" value"
4497
4472
  ]
4498
4473
  ],
4499
- "description": "rename component. if tagged/exported, create a new component and deprecate the original component. otherwise just renames current component",
4474
+ "description": "rename component. if exported, create a new component and deprecate the original component. otherwise just renames current component",
4500
4475
  "extendedDescription": "",
4501
4476
  "group": "collaborate",
4502
4477
  "private": false,
package/cli-reference.mdx CHANGED
@@ -1546,7 +1546,7 @@ to mark components as deleted on the remote scope, use "bit delete".
1546
1546
 
1547
1547
  ## rename
1548
1548
 
1549
- **Description**: rename component. if tagged/exported, create a new component and deprecate the original component. otherwise just renames current component
1549
+ **Description**: rename component. if exported, create a new component and deprecate the original component. otherwise just renames current component
1550
1550
 
1551
1551
  `bit rename <current-name> <new-name>`
1552
1552
 
@@ -1558,11 +1558,11 @@ to mark components as deleted on the remote scope, use "bit delete".
1558
1558
  | **Option** | **Option alias** | **Description** |
1559
1559
  | ------------------------ | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
1560
1560
  | `--scope <scope-name>` | `-s` | define the scope for the newly created component |
1561
- | `--path <relative-path>` | `-p` | relative path in the workspace to place new component in. by default, the directory of the new component is from your workspace's "defaultScope" value |
1562
1561
  | `--refactor` | `-r` | update the import/require statements in all dependent components (in the same workspace) |
1563
1562
  | `--preserve` | | avoid renaming files and variables/classes according to the new component name |
1564
1563
  | `--ast` | | EXPERIMENTAL. use ast to transform files instead of regex |
1565
1564
  | `--delete` | | EXPERIMENTAL. instead of deprecating the original component, delete it |
1565
+ | `--path <relative-path>` | `-p` | relative path in the workspace to place new component in. by default, the directory of the new component is from your workspace's "defaultScope" value |
1566
1566
 
1567
1567
  ---
1568
1568
 
@@ -1670,7 +1670,7 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
1670
1670
 
1671
1671
  **Usage**: `scope rename <current-scope-name> <new-scope-name>`
1672
1672
 
1673
- **Description**: Renames the scope name for all components with the specified 'current scope name' - only available for new components that have not yet been snapped/tagged
1673
+ **Description**: rename the scope name for all components with the specified 'current scope name', if exported, create new components and deprecate the original ones
1674
1674
  Note: if `<current-scope-name>` is also the defaultScope for the workspace, this command will set `<new-scope-name>`
1675
1675
  as the defaultScope instead, and that will then be set for all components by default. You may see updates in your .bitmap file
1676
1676
  as a result of this change
@@ -1,5 +1,5 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.6.35'
2
+ description: 'Bit command synopses. Bit version: 1.6.37'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
5
5
 
@@ -450,31 +450,6 @@
450
450
  "group": "ungrouped",
451
451
  "private": true
452
452
  },
453
- {
454
- "name": "untag [component-name] [component-version]",
455
- "alias": "",
456
- "options": [
457
- [
458
- "a",
459
- "all",
460
- "revert tag for all tagged components"
461
- ],
462
- [
463
- "",
464
- "soft",
465
- "harmony - revert only soft-tags (components tagged with --soft flag)"
466
- ],
467
- [
468
- "f",
469
- "force",
470
- "revert the tag even if used as a dependency. WARNING: components that depend on this tag will corrupt"
471
- ]
472
- ],
473
- "description": "revert tagged or snapped versions for component(s)",
474
- "extendedDescription": "https://bit.dev/components/tags#undoing-a-tag\nyou can use a pattern for multiple ids, such as bit untag \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
475
- "group": "development",
476
- "private": true
477
- },
478
453
  {
479
454
  "name": "_delete <path> <args>",
480
455
  "alias": "",
@@ -983,7 +958,7 @@
983
958
  "update the import statements in all dependent components to the new package name (i.e. with the new scope name)"
984
959
  ]
985
960
  ],
986
- "description": "Renames the scope name for all components with the specified 'current scope name' - only available for new components that have not yet been snapped/tagged",
961
+ "description": "rename the scope name for all components with the specified 'current scope name', if exported, create new components and deprecate the original ones",
987
962
  "extendedDescription": "Note: if `<current-scope-name>` is also the defaultScope for the workspace, this command will set `<new-scope-name>`\nas the defaultScope instead, and that will then be set for all components by default. You may see updates in your .bitmap file\nas a result of this change",
988
963
  "group": "development",
989
964
  "arguments": [
@@ -4470,11 +4445,6 @@
4470
4445
  "scope <scope-name>",
4471
4446
  "define the scope for the newly created component"
4472
4447
  ],
4473
- [
4474
- "p",
4475
- "path <relative-path>",
4476
- "relative path in the workspace to place new component in. by default, the directory of the new component is from your workspace's \"defaultScope\" value"
4477
- ],
4478
4448
  [
4479
4449
  "r",
4480
4450
  "refactor",
@@ -4494,9 +4464,14 @@
4494
4464
  "",
4495
4465
  "delete",
4496
4466
  "EXPERIMENTAL. instead of deprecating the original component, delete it"
4467
+ ],
4468
+ [
4469
+ "p",
4470
+ "path <relative-path>",
4471
+ "relative path in the workspace to place new component in. by default, the directory of the new component is from your workspace's \"defaultScope\" value"
4497
4472
  ]
4498
4473
  ],
4499
- "description": "rename component. if tagged/exported, create a new component and deprecate the original component. otherwise just renames current component",
4474
+ "description": "rename component. if exported, create a new component and deprecate the original component. otherwise just renames current component",
4500
4475
  "extendedDescription": "",
4501
4476
  "group": "collaborate",
4502
4477
  "private": false,
@@ -7979,7 +7979,7 @@ function MDXContent(_ref) {
7979
7979
  "align": null
7980
7980
  }, "skip confirmation")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "rename"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
7981
7981
  parentName: "p"
7982
- }, "Description"), ": rename component. if tagged/exported, create a new component and deprecate the original component. otherwise just renames current component"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
7982
+ }, "Description"), ": rename component. if exported, create a new component and deprecate the original component. otherwise just renames current component"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
7983
7983
  parentName: "p"
7984
7984
  }, "bit rename <current-name> <new-name>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
7985
7985
  parentName: "table"
@@ -8060,69 +8060,69 @@ function MDXContent(_ref) {
8060
8060
  "align": null
8061
8061
  }, (0, _react2.mdx)("inlineCode", {
8062
8062
  parentName: "td"
8063
- }, "--path <relative-path>")), (0, _react2.mdx)("td", {
8063
+ }, "--refactor")), (0, _react2.mdx)("td", {
8064
8064
  parentName: "tr",
8065
8065
  "align": "center"
8066
8066
  }, (0, _react2.mdx)("inlineCode", {
8067
8067
  parentName: "td"
8068
- }, "-p")), (0, _react2.mdx)("td", {
8068
+ }, "-r")), (0, _react2.mdx)("td", {
8069
8069
  parentName: "tr",
8070
8070
  "align": null
8071
- }, "relative path in the workspace to place new component in. by default, the directory of the new component is from your workspace's \"defaultScope\" value")), (0, _react2.mdx)("tr", {
8071
+ }, "update the import/require statements in all dependent components (in the same workspace)")), (0, _react2.mdx)("tr", {
8072
8072
  parentName: "tbody"
8073
8073
  }, (0, _react2.mdx)("td", {
8074
8074
  parentName: "tr",
8075
8075
  "align": null
8076
8076
  }, (0, _react2.mdx)("inlineCode", {
8077
8077
  parentName: "td"
8078
- }, "--refactor")), (0, _react2.mdx)("td", {
8078
+ }, "--preserve")), (0, _react2.mdx)("td", {
8079
8079
  parentName: "tr",
8080
8080
  "align": "center"
8081
- }, (0, _react2.mdx)("inlineCode", {
8082
- parentName: "td"
8083
- }, "-r")), (0, _react2.mdx)("td", {
8081
+ }), (0, _react2.mdx)("td", {
8084
8082
  parentName: "tr",
8085
8083
  "align": null
8086
- }, "update the import/require statements in all dependent components (in the same workspace)")), (0, _react2.mdx)("tr", {
8084
+ }, "avoid renaming files and variables/classes according to the new component name")), (0, _react2.mdx)("tr", {
8087
8085
  parentName: "tbody"
8088
8086
  }, (0, _react2.mdx)("td", {
8089
8087
  parentName: "tr",
8090
8088
  "align": null
8091
8089
  }, (0, _react2.mdx)("inlineCode", {
8092
8090
  parentName: "td"
8093
- }, "--preserve")), (0, _react2.mdx)("td", {
8091
+ }, "--ast")), (0, _react2.mdx)("td", {
8094
8092
  parentName: "tr",
8095
8093
  "align": "center"
8096
8094
  }), (0, _react2.mdx)("td", {
8097
8095
  parentName: "tr",
8098
8096
  "align": null
8099
- }, "avoid renaming files and variables/classes according to the new component name")), (0, _react2.mdx)("tr", {
8097
+ }, "EXPERIMENTAL. use ast to transform files instead of regex")), (0, _react2.mdx)("tr", {
8100
8098
  parentName: "tbody"
8101
8099
  }, (0, _react2.mdx)("td", {
8102
8100
  parentName: "tr",
8103
8101
  "align": null
8104
8102
  }, (0, _react2.mdx)("inlineCode", {
8105
8103
  parentName: "td"
8106
- }, "--ast")), (0, _react2.mdx)("td", {
8104
+ }, "--delete")), (0, _react2.mdx)("td", {
8107
8105
  parentName: "tr",
8108
8106
  "align": "center"
8109
8107
  }), (0, _react2.mdx)("td", {
8110
8108
  parentName: "tr",
8111
8109
  "align": null
8112
- }, "EXPERIMENTAL. use ast to transform files instead of regex")), (0, _react2.mdx)("tr", {
8110
+ }, "EXPERIMENTAL. instead of deprecating the original component, delete it")), (0, _react2.mdx)("tr", {
8113
8111
  parentName: "tbody"
8114
8112
  }, (0, _react2.mdx)("td", {
8115
8113
  parentName: "tr",
8116
8114
  "align": null
8117
8115
  }, (0, _react2.mdx)("inlineCode", {
8118
8116
  parentName: "td"
8119
- }, "--delete")), (0, _react2.mdx)("td", {
8117
+ }, "--path <relative-path>")), (0, _react2.mdx)("td", {
8120
8118
  parentName: "tr",
8121
8119
  "align": "center"
8122
- }), (0, _react2.mdx)("td", {
8120
+ }, (0, _react2.mdx)("inlineCode", {
8121
+ parentName: "td"
8122
+ }, "-p")), (0, _react2.mdx)("td", {
8123
8123
  parentName: "tr",
8124
8124
  "align": null
8125
- }, "EXPERIMENTAL. instead of deprecating the original component, delete it")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "reset"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
8125
+ }, "relative path in the workspace to place new component in. by default, the directory of the new component is from your workspace's \"defaultScope\" value")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "reset"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
8126
8126
  parentName: "p"
8127
8127
  }, "Description"), ": revert tagged or snapped versions for component(s)", (0, _react2.mdx)("br", {
8128
8128
  parentName: "p"
@@ -8603,7 +8603,7 @@ function MDXContent(_ref) {
8603
8603
  parentName: "p"
8604
8604
  }, "scope rename <current-scope-name> <new-scope-name>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
8605
8605
  parentName: "p"
8606
- }, "Description"), ": Renames the scope name for all components with the specified 'current scope name' - only available for new components that have not yet been snapped/tagged", (0, _react2.mdx)("br", {
8606
+ }, "Description"), ": rename the scope name for all components with the specified 'current scope name', if exported, create new components and deprecate the original ones", (0, _react2.mdx)("br", {
8607
8607
  parentName: "p"
8608
8608
  }), "\n", "Note: if ", (0, _react2.mdx)("inlineCode", {
8609
8609
  parentName: "p"