@teambit/harmony.content.cli-reference 1.95.39 → 1.95.42

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.
@@ -572,7 +572,7 @@
572
572
  [
573
573
  "r",
574
574
  "reset",
575
- "revert changes that were not snapped"
575
+ "revert changes that were not snapped/tagged"
576
576
  ],
577
577
  [
578
578
  "a",
@@ -611,7 +611,7 @@
611
611
  ]
612
612
  ],
613
613
  "description": "switch between component versions or remove local changes",
614
- "extendedDescription": "\n `bit checkout <version> [ids...]` => checkout the specified ids (or all components when --all is used) to the specified version\n `bit checkout latest` => checkout all components to their latest versions\n `bit checkout latest [ids...]` => checkout the specified ids to their latest versions\n `bit checkout [ids...] --reset` => remove local modifications from the specified ids (or all components when --all is used)\n you can use a pattern for multiple ids, such as bit checkout 0.0.1 \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
614
+ "extendedDescription": "\n `bit checkout <version> [ids...]` => checkout the specified ids (or all components when --all is used) to the specified version\n `bit checkout head` => checkout all components to their latest versions\n `bit checkout head [ids...]` => checkout the specified ids to their latest versions\n `bit checkout [ids...] --reset` => remove local modifications from the specified ids (or all components when --all is used)\n you can use a pattern for multiple ids, such as bit checkout 0.0.1 \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
615
615
  "group": "development",
616
616
  "private": false
617
617
  },
@@ -2023,7 +2023,7 @@
2023
2023
  ]
2024
2024
  },
2025
2025
  {
2026
- "name": "snap [component-name]",
2026
+ "name": "snap [component-pattern]",
2027
2027
  "alias": "",
2028
2028
  "options": [
2029
2029
  [
@@ -2083,8 +2083,8 @@
2083
2083
  "private": true,
2084
2084
  "arguments": [
2085
2085
  {
2086
- "name": "component_name",
2087
- "description": "component names or component ID (defaults to all components)"
2086
+ "name": "component-pattern",
2087
+ "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. By default, all new and modified components are snapped."
2088
2088
  }
2089
2089
  ]
2090
2090
  },
@@ -2182,6 +2182,11 @@
2182
2182
  "json",
2183
2183
  "return a json version of the component"
2184
2184
  ],
2185
+ [
2186
+ "",
2187
+ "verbose",
2188
+ "show full snap hashes"
2189
+ ],
2185
2190
  [
2186
2191
  "",
2187
2192
  "strict",
@@ -2502,7 +2507,7 @@
2502
2507
  "arguments": [
2503
2508
  {
2504
2509
  "name": "aspect-id",
2505
- "description": "the aspect's component id"
2510
+ "description": "the aspect's component id. optionally, add a version (id@version), otherwise, it finds the latest version on the remote"
2506
2511
  },
2507
2512
  {
2508
2513
  "name": "pattern",
@@ -2660,6 +2665,11 @@
2660
2665
  "r",
2661
2666
  "refactor",
2662
2667
  "update the import/require statements in all dependent components (in the same workspace)"
2668
+ ],
2669
+ [
2670
+ "",
2671
+ "skip-dependency-installation",
2672
+ "do not install packages of the imported components"
2663
2673
  ]
2664
2674
  ],
2665
2675
  "description": "EXPERIMENTAL. create a new component out of an existing one (copies source files and config)",
package/cli-reference.mdx CHANGED
@@ -201,8 +201,8 @@ with no args, only workspace's capsules are deleted
201
201
  **Description**: switch between component versions or remove local changes
202
202
 
203
203
  `bit checkout <version> [ids...]` => checkout the specified ids (or all components when --all is used) to the specified version
204
- `bit checkout latest` => checkout all components to their latest versions
205
- `bit checkout latest [ids...]` => checkout the specified ids to their latest versions
204
+ `bit checkout head` => checkout all components to their latest versions
205
+ `bit checkout head [ids...]` => checkout the specified ids to their latest versions
206
206
  `bit checkout [ids...] --reset` => remove local modifications from the specified ids (or all components when --all is used)
207
207
  you can use a pattern for multiple ids, such as bit checkout 0.0.1 "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
208
208
 
@@ -214,7 +214,7 @@ with no args, only workspace's capsules are deleted
214
214
  | `--ours` | `-o` | in case of a conflict, override the used version with the current modification |
215
215
  | `--theirs` | `-t` | in case of a conflict, override the current modification with the specified version |
216
216
  | `--manual` | `-m` | in case of a conflict, leave the files with a conflict state to resolve them manually later |
217
- | `--reset` | `-r` | revert changes that were not snapped |
217
+ | `--reset` | `-r` | revert changes that were not snapped/tagged |
218
218
  | `--all` | `-a` | all components |
219
219
  | `--verbose` | `-v` | showing verbose output for inspection |
220
220
  | `--skip-npm-install` | | DEPRECATED. use "--skip-dependency-installation" instead |
@@ -538,11 +538,12 @@ you can use a pattern for multiple ids, such as bit export remote-scope "utils/\
538
538
 
539
539
  `bit fork <source-component-id> [target-component-name]`
540
540
 
541
- | **Option** | **Option alias** | **Description** |
542
- | ------------------ | :--------------: | --------------------------------------------------------------------------------------------------------- |
543
- | `--scope <string>` | `-s` | default scope for the new component |
544
- | `--path <string>` | `-p` | relative path in the workspace for the new component. by default the path is `<scope>/<namespace>/<name>` |
545
- | `--refactor` | `-r` | update the import/require statements in all dependent components (in the same workspace) |
541
+ | **Option** | **Option alias** | **Description** |
542
+ | -------------------------------- | :--------------: | --------------------------------------------------------------------------------------------------------- |
543
+ | `--scope <string>` | `-s` | default scope for the new component |
544
+ | `--path <string>` | `-p` | relative path in the workspace for the new component. by default the path is `<scope>/<namespace>/<name>` |
545
+ | `--refactor` | `-r` | update the import/require statements in all dependent components (in the same workspace) |
546
+ | `--skip-dependency-installation` | | do not install packages of the imported components |
546
547
 
547
548
  ---
548
549
 
@@ -1109,10 +1110,11 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
1109
1110
 
1110
1111
  `bit status`
1111
1112
 
1112
- | **Option** | **Option alias** | **Description** |
1113
- | ---------- | :--------------: | -------------------------------------- |
1114
- | `--json` | `-j` | return a json version of the component |
1115
- | `--strict` | | in case issues found, exit with code 1 |
1113
+ | **Option** | **Option alias** | **Description** |
1114
+ | ----------- | :--------------: | -------------------------------------- |
1115
+ | `--json` | `-j` | return a json version of the component |
1116
+ | `--verbose` | | show full snap hashes |
1117
+ | `--strict` | | in case issues found, exit with code 1 |
1116
1118
 
1117
1119
  ---
1118
1120
 
@@ -572,7 +572,7 @@
572
572
  [
573
573
  "r",
574
574
  "reset",
575
- "revert changes that were not snapped"
575
+ "revert changes that were not snapped/tagged"
576
576
  ],
577
577
  [
578
578
  "a",
@@ -611,7 +611,7 @@
611
611
  ]
612
612
  ],
613
613
  "description": "switch between component versions or remove local changes",
614
- "extendedDescription": "\n `bit checkout <version> [ids...]` => checkout the specified ids (or all components when --all is used) to the specified version\n `bit checkout latest` => checkout all components to their latest versions\n `bit checkout latest [ids...]` => checkout the specified ids to their latest versions\n `bit checkout [ids...] --reset` => remove local modifications from the specified ids (or all components when --all is used)\n you can use a pattern for multiple ids, such as bit checkout 0.0.1 \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
614
+ "extendedDescription": "\n `bit checkout <version> [ids...]` => checkout the specified ids (or all components when --all is used) to the specified version\n `bit checkout head` => checkout all components to their latest versions\n `bit checkout head [ids...]` => checkout the specified ids to their latest versions\n `bit checkout [ids...] --reset` => remove local modifications from the specified ids (or all components when --all is used)\n you can use a pattern for multiple ids, such as bit checkout 0.0.1 \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
615
615
  "group": "development",
616
616
  "private": false
617
617
  },
@@ -2023,7 +2023,7 @@
2023
2023
  ]
2024
2024
  },
2025
2025
  {
2026
- "name": "snap [component-name]",
2026
+ "name": "snap [component-pattern]",
2027
2027
  "alias": "",
2028
2028
  "options": [
2029
2029
  [
@@ -2083,8 +2083,8 @@
2083
2083
  "private": true,
2084
2084
  "arguments": [
2085
2085
  {
2086
- "name": "component_name",
2087
- "description": "component names or component ID (defaults to all components)"
2086
+ "name": "component-pattern",
2087
+ "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. By default, all new and modified components are snapped."
2088
2088
  }
2089
2089
  ]
2090
2090
  },
@@ -2182,6 +2182,11 @@
2182
2182
  "json",
2183
2183
  "return a json version of the component"
2184
2184
  ],
2185
+ [
2186
+ "",
2187
+ "verbose",
2188
+ "show full snap hashes"
2189
+ ],
2185
2190
  [
2186
2191
  "",
2187
2192
  "strict",
@@ -2502,7 +2507,7 @@
2502
2507
  "arguments": [
2503
2508
  {
2504
2509
  "name": "aspect-id",
2505
- "description": "the aspect's component id"
2510
+ "description": "the aspect's component id. optionally, add a version (id@version), otherwise, it finds the latest version on the remote"
2506
2511
  },
2507
2512
  {
2508
2513
  "name": "pattern",
@@ -2660,6 +2665,11 @@
2660
2665
  "r",
2661
2666
  "refactor",
2662
2667
  "update the import/require statements in all dependent components (in the same workspace)"
2668
+ ],
2669
+ [
2670
+ "",
2671
+ "skip-dependency-installation",
2672
+ "do not install packages of the imported components"
2663
2673
  ]
2664
2674
  ],
2665
2675
  "description": "EXPERIMENTAL. create a new component out of an existing one (copies source files and config)",
@@ -883,11 +883,11 @@ function MDXContent(_ref) {
883
883
  parentName: "p"
884
884
  }), "\n", "", (0, _react2.mdx)("inlineCode", {
885
885
  parentName: "p"
886
- }, "bit checkout latest"), " => checkout all components to their latest versions", (0, _react2.mdx)("br", {
886
+ }, "bit checkout head"), " => checkout all components to their latest versions", (0, _react2.mdx)("br", {
887
887
  parentName: "p"
888
888
  }), "\n", "", (0, _react2.mdx)("inlineCode", {
889
889
  parentName: "p"
890
- }, "bit checkout latest [ids...]"), " => checkout the specified ids to their latest versions", (0, _react2.mdx)("br", {
890
+ }, "bit checkout head [ids...]"), " => checkout the specified ids to their latest versions", (0, _react2.mdx)("br", {
891
891
  parentName: "p"
892
892
  }), "\n", "", (0, _react2.mdx)("inlineCode", {
893
893
  parentName: "p"
@@ -991,7 +991,7 @@ function MDXContent(_ref) {
991
991
  }, "-r")), (0, _react2.mdx)("td", {
992
992
  parentName: "tr",
993
993
  "align": null
994
- }, "revert changes that were not snapped")), (0, _react2.mdx)("tr", {
994
+ }, "revert changes that were not snapped/tagged")), (0, _react2.mdx)("tr", {
995
995
  parentName: "tbody"
996
996
  }, (0, _react2.mdx)("td", {
997
997
  parentName: "tr",
@@ -2192,7 +2192,20 @@ function MDXContent(_ref) {
2192
2192
  }, "-r")), (0, _react2.mdx)("td", {
2193
2193
  parentName: "tr",
2194
2194
  "align": null
2195
- }, "update the import/require statements in all dependent components (in the same workspace)")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "format"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2195
+ }, "update the import/require statements in all dependent components (in the same workspace)")), (0, _react2.mdx)("tr", {
2196
+ parentName: "tbody"
2197
+ }, (0, _react2.mdx)("td", {
2198
+ parentName: "tr",
2199
+ "align": null
2200
+ }, (0, _react2.mdx)("inlineCode", {
2201
+ parentName: "td"
2202
+ }, "--skip-dependency-installation")), (0, _react2.mdx)("td", {
2203
+ parentName: "tr",
2204
+ "align": "center"
2205
+ }), (0, _react2.mdx)("td", {
2206
+ parentName: "tr",
2207
+ "align": null
2208
+ }, "do not install packages of the imported components")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "format"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2196
2209
  parentName: "p"
2197
2210
  }, "Workspace only"), ": yes", (0, _react2.mdx)("br", {
2198
2211
  parentName: "p"
@@ -4859,6 +4872,19 @@ function MDXContent(_ref) {
4859
4872
  "align": null
4860
4873
  }, (0, _react2.mdx)("inlineCode", {
4861
4874
  parentName: "td"
4875
+ }, "--verbose")), (0, _react2.mdx)("td", {
4876
+ parentName: "tr",
4877
+ "align": "center"
4878
+ }), (0, _react2.mdx)("td", {
4879
+ parentName: "tr",
4880
+ "align": null
4881
+ }, "show full snap hashes")), (0, _react2.mdx)("tr", {
4882
+ parentName: "tbody"
4883
+ }, (0, _react2.mdx)("td", {
4884
+ parentName: "tr",
4885
+ "align": null
4886
+ }, (0, _react2.mdx)("inlineCode", {
4887
+ parentName: "td"
4862
4888
  }, "--strict")), (0, _react2.mdx)("td", {
4863
4889
  parentName: "tr",
4864
4890
  "align": "center"