@teambit/harmony.content.cli-reference 2.0.848 → 2.0.850

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,4 +1,4 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.12.202'
2
+ description: 'Bit command synopses. Bit version: 1.12.204'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
@@ -5204,7 +5204,7 @@
5204
5204
  ]
5205
5205
  },
5206
5206
  {
5207
- "name": "fork <source-component-id> [target-component-name]",
5207
+ "name": "fork <pattern> [target-component-name]",
5208
5208
  "alias": "",
5209
5209
  "options": [
5210
5210
  [
@@ -5254,19 +5254,19 @@
5254
5254
  ]
5255
5255
  ],
5256
5256
  "description": "create a new component by copying from an existing one",
5257
- "extendedDescription": "duplicates an existing component's source files and configuration to create a new independent component.\nuseful for creating variations or starting development from a similar component.\nautomatically handles import/require statement updates and provides refactoring options.",
5257
+ "extendedDescription": "duplicates an existing component's source files and configuration to create a new independent component.\nuseful for creating variations or starting development from a similar component.\nautomatically handles import/require statement updates and provides refactoring options.\n\nwhen using a pattern, all matching components are forked with the same name to a target scope.\nthe target-component-name argument is not allowed when using patterns.",
5258
5258
  "group": "collaborate",
5259
5259
  "private": false,
5260
5260
  "remoteOp": true,
5261
5261
  "skipWorkspace": true,
5262
5262
  "arguments": [
5263
5263
  {
5264
- "name": "source-component-id",
5265
- "description": "the component id of the source component"
5264
+ "name": "pattern",
5265
+ "description": "component name, component id, or component pattern. use component pattern to select multiple components.\nwrap the pattern with quotes. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\".\nuse '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern."
5266
5266
  },
5267
5267
  {
5268
5268
  "name": "target-component-name",
5269
- "description": "the name for the new component (component name without scope, e.g. name/spaces/my-button). to set a different scope, use the '--scope' flag"
5269
+ "description": "the name for the new component (component name without scope, e.g. name/spaces/my-button). to set a different scope, use the '--scope' flag. not allowed when using patterns"
5270
5270
  }
5271
5271
  ]
5272
5272
  },
package/cli-reference.mdx CHANGED
@@ -959,12 +959,15 @@ duplicates an existing component's source files and configuration to create a ne
959
959
  useful for creating variations or starting development from a similar component.
960
960
  automatically handles import/require statement updates and provides refactoring options.
961
961
 
962
- `bit fork <source-component-id> [target-component-name]`
962
+ when using a pattern, all matching components are forked with the same name to a target scope.
963
+ the target-component-name argument is not allowed when using patterns.
963
964
 
964
- | **Arg** | **Description** |
965
- | ----------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------: |
966
- | `source-component-id` | the component id of the source component |
967
- | `target-component-name` | the name for the new component (component name without scope, e.g. name/spaces/my-button). to set a different scope, use the '--scope' flag |
965
+ `bit fork <pattern> [target-component-name]`
966
+
967
+ | **Arg** | **Description** |
968
+ | ----------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
969
+ | `pattern` | component name, component id, or component pattern. use component pattern to select multiple components. wrap the pattern with quotes. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button". use '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'. use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
970
+ | `target-component-name` | the name for the new component (component name without scope, e.g. name/spaces/my-button). to set a different scope, use the '--scope' flag. not allowed when using patterns |
968
971
 
969
972
  | **Option** | **Option alias** | **Description** |
970
973
  | -------------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------- |
@@ -1,4 +1,4 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.12.202'
2
+ description: 'Bit command synopses. Bit version: 1.12.204'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
@@ -5204,7 +5204,7 @@
5204
5204
  ]
5205
5205
  },
5206
5206
  {
5207
- "name": "fork <source-component-id> [target-component-name]",
5207
+ "name": "fork <pattern> [target-component-name]",
5208
5208
  "alias": "",
5209
5209
  "options": [
5210
5210
  [
@@ -5254,19 +5254,19 @@
5254
5254
  ]
5255
5255
  ],
5256
5256
  "description": "create a new component by copying from an existing one",
5257
- "extendedDescription": "duplicates an existing component's source files and configuration to create a new independent component.\nuseful for creating variations or starting development from a similar component.\nautomatically handles import/require statement updates and provides refactoring options.",
5257
+ "extendedDescription": "duplicates an existing component's source files and configuration to create a new independent component.\nuseful for creating variations or starting development from a similar component.\nautomatically handles import/require statement updates and provides refactoring options.\n\nwhen using a pattern, all matching components are forked with the same name to a target scope.\nthe target-component-name argument is not allowed when using patterns.",
5258
5258
  "group": "collaborate",
5259
5259
  "private": false,
5260
5260
  "remoteOp": true,
5261
5261
  "skipWorkspace": true,
5262
5262
  "arguments": [
5263
5263
  {
5264
- "name": "source-component-id",
5265
- "description": "the component id of the source component"
5264
+ "name": "pattern",
5265
+ "description": "component name, component id, or component pattern. use component pattern to select multiple components.\nwrap the pattern with quotes. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\".\nuse '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern."
5266
5266
  },
5267
5267
  {
5268
5268
  "name": "target-component-name",
5269
- "description": "the name for the new component (component name without scope, e.g. name/spaces/my-button). to set a different scope, use the '--scope' flag"
5269
+ "description": "the name for the new component (component name without scope, e.g. name/spaces/my-button). to set a different scope, use the '--scope' flag. not allowed when using patterns"
5270
5270
  }
5271
5271
  ]
5272
5272
  },
@@ -4780,9 +4780,11 @@ function MDXContent(_ref) {
4780
4780
  parentName: "p"
4781
4781
  }), "\n", "useful for creating variations or starting development from a similar component.", (0, _react2.mdx)("br", {
4782
4782
  parentName: "p"
4783
- }), "\n", "automatically handles import/require statement updates and provides refactoring options."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
4783
+ }), "\n", "automatically handles import/require statement updates and provides refactoring options."), (0, _react2.mdx)("p", null, "when using a pattern, all matching components are forked with the same name to a target scope.", (0, _react2.mdx)("br", {
4784
4784
  parentName: "p"
4785
- }, "bit fork <source-component-id> [target-component-name]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
4785
+ }), "\n", "the target-component-name argument is not allowed when using patterns."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
4786
+ parentName: "p"
4787
+ }, "bit fork <pattern> [target-component-name]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
4786
4788
  parentName: "table"
4787
4789
  }, (0, _react2.mdx)("tr", {
4788
4790
  parentName: "thead"
@@ -4805,10 +4807,14 @@ function MDXContent(_ref) {
4805
4807
  "align": null
4806
4808
  }, (0, _react2.mdx)("inlineCode", {
4807
4809
  parentName: "td"
4808
- }, "source-component-id")), (0, _react2.mdx)("td", {
4810
+ }, "pattern")), (0, _react2.mdx)("td", {
4809
4811
  parentName: "tr",
4810
4812
  "align": "center"
4811
- }, "the component id of the source component")), (0, _react2.mdx)("tr", {
4813
+ }, "component name, component id, or component pattern. use component pattern to select multiple components. wrap the pattern with quotes. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/", "*", "*", ", !ui/button\". use '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'. use ", (0, _react2.mdx)("inlineCode", {
4814
+ parentName: "td"
4815
+ }, "bit pattern --help"), " to understand patterns better and ", (0, _react2.mdx)("inlineCode", {
4816
+ parentName: "td"
4817
+ }, "bit pattern <pattern>"), " to validate the pattern.")), (0, _react2.mdx)("tr", {
4812
4818
  parentName: "tbody"
4813
4819
  }, (0, _react2.mdx)("td", {
4814
4820
  parentName: "tr",
@@ -4818,7 +4824,7 @@ function MDXContent(_ref) {
4818
4824
  }, "target-component-name")), (0, _react2.mdx)("td", {
4819
4825
  parentName: "tr",
4820
4826
  "align": "center"
4821
- }, "the name for the new component (component name without scope, e.g. name/spaces/my-button). to set a different scope, use the '--scope' flag")))), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
4827
+ }, "the name for the new component (component name without scope, e.g. name/spaces/my-button). to set a different scope, use the '--scope' flag. not allowed when using patterns")))), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
4822
4828
  parentName: "table"
4823
4829
  }, (0, _react2.mdx)("tr", {
4824
4830
  parentName: "thead"