@teambit/harmony.content.cli-reference 1.95.21 → 1.95.24

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.
package/cli-reference.mdx CHANGED
@@ -1002,9 +1002,12 @@ alternatively, exporting to any one of the failed scopes, throws server-is-busy
1002
1002
  ## schema
1003
1003
 
1004
1004
  **Workspace only**: yes
1005
- **Description**: shows the API schema of a certain component.
1005
+ **Description**: shows the API schema of a certain component.
1006
+ you can use a `<pattern>` for multiple component ids, such as `bit schema "org.scope/utils/**"`. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
1007
+ always wrap the pattern with quotes to avoid collision with shell commands.
1008
+ to validate the pattern before running this command, run `bit pattern <pattern>`.
1006
1009
 
1007
- `bit schema <id>`
1010
+ `bit schema <pattern>`
1008
1011
 
1009
1012
  | **Option** | **Option alias** | **Description** |
1010
1013
  | ---------- | :--------------: | ---------------------------------------- |
@@ -1021,10 +1024,13 @@ alternatively, exporting to any one of the failed scopes, throws server-is-busy
1021
1024
 
1022
1025
  ### scope set
1023
1026
 
1024
- **Usage**: `scope set <pattern> <scope-name>`
1027
+ **Usage**: `scope set <scope-name> [pattern]`
1028
+
1029
+ **Description**: set the default-scope
1030
+ set a new scope in the workspace.jsonc.
1031
+ if "pattern" is provided, the default-scope will be set to the new components matching the criteria.
1025
1032
 
1026
- **Description**: set a scope name for component(s)
1027
- you can use a `<pattern>` for multiple component ids, such as `bit scope set "org.scope/utils/**"`. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
1033
+ you can use a `<pattern>` for multiple component ids, such as `bit scope set scope-name "org.scope/utils/**"`. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
1028
1034
  always wrap the pattern with quotes to avoid collision with shell commands.
1029
1035
  to validate the pattern before running this command, run `bit pattern <pattern>`.
1030
1036
 
@@ -1038,6 +1044,12 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
1038
1044
  | ------------ | :--------------: | ---------------------------------------------------------------------------------------------- |
1039
1045
  | `--refactor` | `-r` | change the source code of all components using the original scope-name with the new scope-name |
1040
1046
 
1047
+ ### scope fork
1048
+
1049
+ **Usage**: `scope fork <original-scope> <new-scope>`
1050
+
1051
+ **Description**: fork all components of the original-scope and refactor the source-code to use the new package names
1052
+
1041
1053
  ---
1042
1054
 
1043
1055
  ## scope-config
@@ -4531,9 +4531,21 @@ function MDXContent(_ref) {
4531
4531
  parentName: "p"
4532
4532
  }), "\n", (0, _react2.mdx)("strong", {
4533
4533
  parentName: "p"
4534
- }, "Description"), ": shows the API schema of a certain component."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
4534
+ }, "Description"), ": shows the API schema of a certain component.", (0, _react2.mdx)("br", {
4535
4535
  parentName: "p"
4536
- }, "bit schema <id>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
4536
+ }), "\n", "you can use a ", (0, _react2.mdx)("inlineCode", {
4537
+ parentName: "p"
4538
+ }, "<pattern>"), " for multiple component ids, such as ", (0, _react2.mdx)("inlineCode", {
4539
+ parentName: "p"
4540
+ }, "bit schema \"org.scope/utils/**\""), ". use comma to separate patterns and \"!\" to exclude. e.g. \"ui/", "*", "*", ", !ui/button\"", (0, _react2.mdx)("br", {
4541
+ parentName: "p"
4542
+ }), "\n", "always wrap the pattern with quotes to avoid collision with shell commands.", (0, _react2.mdx)("br", {
4543
+ parentName: "p"
4544
+ }), "\n", "to validate the pattern before running this command, run ", (0, _react2.mdx)("inlineCode", {
4545
+ parentName: "p"
4546
+ }, "bit pattern <pattern>"), "."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
4547
+ parentName: "p"
4548
+ }, "bit schema <pattern>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
4537
4549
  parentName: "table"
4538
4550
  }, (0, _react2.mdx)("tr", {
4539
4551
  parentName: "thead"
@@ -4581,15 +4593,17 @@ function MDXContent(_ref) {
4581
4593
  parentName: "p"
4582
4594
  }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
4583
4595
  parentName: "p"
4584
- }, "scope set <pattern> <scope-name>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
4596
+ }, "scope set <scope-name> [pattern]")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
4585
4597
  parentName: "p"
4586
- }, "Description"), ": set a scope name for component(s)", (0, _react2.mdx)("br", {
4598
+ }, "Description"), ": set the default-scope", (0, _react2.mdx)("br", {
4587
4599
  parentName: "p"
4588
- }), "\n", "you can use a ", (0, _react2.mdx)("inlineCode", {
4600
+ }), "\n", "set a new scope in the workspace.jsonc.", (0, _react2.mdx)("br", {
4601
+ parentName: "p"
4602
+ }), "\n", "if \"pattern\" is provided, the default-scope will be set to the new components matching the criteria."), (0, _react2.mdx)("p", null, "you can use a ", (0, _react2.mdx)("inlineCode", {
4589
4603
  parentName: "p"
4590
4604
  }, "<pattern>"), " for multiple component ids, such as ", (0, _react2.mdx)("inlineCode", {
4591
4605
  parentName: "p"
4592
- }, "bit scope set \"org.scope/utils/**\""), ". use comma to separate patterns and \"!\" to exclude. e.g. \"ui/", "*", "*", ", !ui/button\"", (0, _react2.mdx)("br", {
4606
+ }, "bit scope set scope-name \"org.scope/utils/**\""), ". use comma to separate patterns and \"!\" to exclude. e.g. \"ui/", "*", "*", ", !ui/button\"", (0, _react2.mdx)("br", {
4593
4607
  parentName: "p"
4594
4608
  }), "\n", "always wrap the pattern with quotes to avoid collision with shell commands.", (0, _react2.mdx)("br", {
4595
4609
  parentName: "p"
@@ -4637,7 +4651,13 @@ function MDXContent(_ref) {
4637
4651
  }, "-r")), (0, _react2.mdx)("td", {
4638
4652
  parentName: "tr",
4639
4653
  "align": null
4640
- }, "change the source code of all components using the original scope-name with the new scope-name")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "scope-config"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
4654
+ }, "change the source code of all components using the original scope-name with the new scope-name")))), (0, _react2.mdx)("h3", null, "scope fork"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
4655
+ parentName: "p"
4656
+ }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
4657
+ parentName: "p"
4658
+ }, "scope fork <original-scope> <new-scope>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
4659
+ parentName: "p"
4660
+ }, "Description"), ": fork all components of the original-scope and refactor the source-code to use the new package names"), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "scope-config"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
4641
4661
  parentName: "p"
4642
4662
  }, "Workspace only"), ": yes", (0, _react2.mdx)("br", {
4643
4663
  parentName: "p"