@teambit/harmony.content.cli-reference 2.0.280 → 2.0.282

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.165'
2
+ description: 'Bit command synopses. Bit version: 1.6.167'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
5
5
 
@@ -3196,13 +3196,13 @@
3196
3196
  ]
3197
3197
  ],
3198
3198
  "description": "switch between component versions or remove local changes",
3199
- "extendedDescription": "\n`bit checkout <version> [component-pattern]` => checkout the specified ids (or all components when --all is used) to the specified version\n`bit checkout head [component-pattern]` => checkout to the last snap/tag (use --latest if you only want semver tags), omit [component-pattern] to checkout head for all\n`bit checkout latest [component-pattern]` => checkout to the latest satisfying semver tag, omit [component-pattern] to checkout latest for all\n`bit checkout reset [component-pattern]` => remove local modifications from the specified ids (or all components when --all is used). also, if a component dir is deleted from the filesystem, it'll be restored\nwhen on a lane, \"checkout head\" only checks out components on this lane. to update main components, run \"bit lane merge main\"",
3199
+ "extendedDescription": "\n`bit checkout <version> [component-pattern]` => checkout the specified ids (or all components when --all is used) to the specified version\n`bit checkout head [component-pattern]` => checkout to the last snap/tag (use --latest if you only want semver tags), omit [component-pattern] to checkout head for all\n`bit checkout head~x [component-pattern]` => go backward x generations from the head and checkout to that version\n`bit checkout latest [component-pattern]` => checkout to the latest satisfying semver tag, omit [component-pattern] to checkout latest for all\n`bit checkout reset [component-pattern]` => remove local modifications from the specified ids (or all components when --all is used). also, if a component dir is deleted from the filesystem, it'll be restored\nwhen on a lane, \"checkout head\" only checks out components on this lane. to update main components, run \"bit lane merge main\"",
3200
3200
  "group": "development",
3201
3201
  "private": false,
3202
3202
  "arguments": [
3203
3203
  {
3204
3204
  "name": "to",
3205
- "description": "permitted values: [head, latest, reset, specific-version]. 'head' - last snap/tag. 'latest' - semver latest tag. 'reset' - removes local changes"
3205
+ "description": "permitted values: [head, latest, reset, {specific-version}, {head~x}]. 'head' - last snap/tag. 'latest' - semver latest tag. 'reset' - removes local changes"
3206
3206
  },
3207
3207
  {
3208
3208
  "name": "component-pattern",
@@ -4508,6 +4508,11 @@
4508
4508
  "json",
4509
4509
  "return a json version of the component"
4510
4510
  ],
4511
+ [
4512
+ "w",
4513
+ "warnings",
4514
+ "show warnings. by default, only issues that block tag/snap are shown"
4515
+ ],
4511
4516
  [
4512
4517
  "",
4513
4518
  "verbose",
package/cli-reference.mdx CHANGED
@@ -283,6 +283,7 @@ with no args, only workspace's capsules are deleted
283
283
 
284
284
  `bit checkout <version> [component-pattern]` => checkout the specified ids (or all components when --all is used) to the specified version
285
285
  `bit checkout head [component-pattern]` => checkout to the last snap/tag (use --latest if you only want semver tags), omit [component-pattern] to checkout head for all
286
+ `bit checkout head~x [component-pattern]` => go backward x generations from the head and checkout to that version
286
287
  `bit checkout latest [component-pattern]` => checkout to the latest satisfying semver tag, omit [component-pattern] to checkout latest for all
287
288
  `bit checkout reset [component-pattern]` => remove local modifications from the specified ids (or all components when --all is used). also, if a component dir is deleted from the filesystem, it'll be restored
288
289
  when on a lane, "checkout head" only checks out components on this lane. to update main components, run "bit lane merge main"
@@ -291,7 +292,7 @@ when on a lane, "checkout head" only checks out components on this lane. to upda
291
292
 
292
293
  | **Arg** | **Description** |
293
294
  | ------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
294
- | `to` | permitted values: [head, latest, reset, specific-version]. 'head' - last snap/tag. 'latest' - semver latest tag. 'reset' - removes local changes |
295
+ | `to` | permitted values: [head, latest, reset, {specific-version}, {head~x}]. 'head' - last snap/tag. 'latest' - semver latest tag. 'reset' - removes local changes |
295
296
  | `component-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. |
296
297
 
297
298
  | **Option** | **Option alias** | **Description** |
@@ -1984,6 +1985,7 @@ optionally, provide [pattern] to limit the fork to specific components
1984
1985
  | **Option** | **Option alias** | **Description** |
1985
1986
  | -------------------------------- | :--------------: | --------------------------------------------------------------------------------------- |
1986
1987
  | `--json` | `-j` | return a json version of the component |
1988
+ | `--warnings` | `-w` | show warnings. by default, only issues that block tag/snap are shown |
1987
1989
  | `--verbose` | | show extra data: full snap hashes for staged components, and divergence point for lanes |
1988
1990
  | `--lanes` | `-l` | when on a lane, show updates from main and updates from forked lanes |
1989
1991
  | `--strict` | | in case issues found, exit with code 1 |
@@ -1,5 +1,5 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.6.165'
2
+ description: 'Bit command synopses. Bit version: 1.6.167'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
5
5
 
@@ -3196,13 +3196,13 @@
3196
3196
  ]
3197
3197
  ],
3198
3198
  "description": "switch between component versions or remove local changes",
3199
- "extendedDescription": "\n`bit checkout <version> [component-pattern]` => checkout the specified ids (or all components when --all is used) to the specified version\n`bit checkout head [component-pattern]` => checkout to the last snap/tag (use --latest if you only want semver tags), omit [component-pattern] to checkout head for all\n`bit checkout latest [component-pattern]` => checkout to the latest satisfying semver tag, omit [component-pattern] to checkout latest for all\n`bit checkout reset [component-pattern]` => remove local modifications from the specified ids (or all components when --all is used). also, if a component dir is deleted from the filesystem, it'll be restored\nwhen on a lane, \"checkout head\" only checks out components on this lane. to update main components, run \"bit lane merge main\"",
3199
+ "extendedDescription": "\n`bit checkout <version> [component-pattern]` => checkout the specified ids (or all components when --all is used) to the specified version\n`bit checkout head [component-pattern]` => checkout to the last snap/tag (use --latest if you only want semver tags), omit [component-pattern] to checkout head for all\n`bit checkout head~x [component-pattern]` => go backward x generations from the head and checkout to that version\n`bit checkout latest [component-pattern]` => checkout to the latest satisfying semver tag, omit [component-pattern] to checkout latest for all\n`bit checkout reset [component-pattern]` => remove local modifications from the specified ids (or all components when --all is used). also, if a component dir is deleted from the filesystem, it'll be restored\nwhen on a lane, \"checkout head\" only checks out components on this lane. to update main components, run \"bit lane merge main\"",
3200
3200
  "group": "development",
3201
3201
  "private": false,
3202
3202
  "arguments": [
3203
3203
  {
3204
3204
  "name": "to",
3205
- "description": "permitted values: [head, latest, reset, specific-version]. 'head' - last snap/tag. 'latest' - semver latest tag. 'reset' - removes local changes"
3205
+ "description": "permitted values: [head, latest, reset, {specific-version}, {head~x}]. 'head' - last snap/tag. 'latest' - semver latest tag. 'reset' - removes local changes"
3206
3206
  },
3207
3207
  {
3208
3208
  "name": "component-pattern",
@@ -4508,6 +4508,11 @@
4508
4508
  "json",
4509
4509
  "return a json version of the component"
4510
4510
  ],
4511
+ [
4512
+ "w",
4513
+ "warnings",
4514
+ "show warnings. by default, only issues that block tag/snap are shown"
4515
+ ],
4511
4516
  [
4512
4517
  "",
4513
4518
  "verbose",
@@ -1438,6 +1438,10 @@ function MDXContent(_ref) {
1438
1438
  parentName: "p"
1439
1439
  }), "\n", (0, _react2.mdx)("inlineCode", {
1440
1440
  parentName: "p"
1441
+ }, "bit checkout head~x [component-pattern]"), " => go backward x generations from the head and checkout to that version", (0, _react2.mdx)("br", {
1442
+ parentName: "p"
1443
+ }), "\n", (0, _react2.mdx)("inlineCode", {
1444
+ parentName: "p"
1441
1445
  }, "bit checkout latest [component-pattern]"), " => checkout to the latest satisfying semver tag, omit ", "[component-pattern]", " to checkout latest for all", (0, _react2.mdx)("br", {
1442
1446
  parentName: "p"
1443
1447
  }), "\n", (0, _react2.mdx)("inlineCode", {
@@ -1472,7 +1476,7 @@ function MDXContent(_ref) {
1472
1476
  }, "to")), (0, _react2.mdx)("td", {
1473
1477
  parentName: "tr",
1474
1478
  "align": "center"
1475
- }, "permitted values: ", "[head, latest, reset, specific-version]", ". 'head' - last snap/tag. 'latest' - semver latest tag. 'reset' - removes local changes")), (0, _react2.mdx)("tr", {
1479
+ }, "permitted values: ", "[head, latest, reset, {specific-version}, {head~x}]", ". 'head' - last snap/tag. 'latest' - semver latest tag. 'reset' - removes local changes")), (0, _react2.mdx)("tr", {
1476
1480
  parentName: "tbody"
1477
1481
  }, (0, _react2.mdx)("td", {
1478
1482
  parentName: "tr",
@@ -10231,6 +10235,21 @@ function MDXContent(_ref) {
10231
10235
  "align": null
10232
10236
  }, (0, _react2.mdx)("inlineCode", {
10233
10237
  parentName: "td"
10238
+ }, "--warnings")), (0, _react2.mdx)("td", {
10239
+ parentName: "tr",
10240
+ "align": "center"
10241
+ }, (0, _react2.mdx)("inlineCode", {
10242
+ parentName: "td"
10243
+ }, "-w")), (0, _react2.mdx)("td", {
10244
+ parentName: "tr",
10245
+ "align": null
10246
+ }, "show warnings. by default, only issues that block tag/snap are shown")), (0, _react2.mdx)("tr", {
10247
+ parentName: "tbody"
10248
+ }, (0, _react2.mdx)("td", {
10249
+ parentName: "tr",
10250
+ "align": null
10251
+ }, (0, _react2.mdx)("inlineCode", {
10252
+ parentName: "td"
10234
10253
  }, "--verbose")), (0, _react2.mdx)("td", {
10235
10254
  parentName: "tr",
10236
10255
  "align": "center"