@teambit/harmony.content.cli-reference 2.0.785 → 2.0.787

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.139'
2
+ description: 'Bit command synopses. Bit version: 1.12.141'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
@@ -5453,27 +5453,32 @@
5453
5453
  "private": true
5454
5454
  },
5455
5455
  {
5456
- "name": "format [component-pattern]",
5456
+ "name": "lint [component-pattern]",
5457
5457
  "alias": "",
5458
5458
  "options": [
5459
5459
  [
5460
5460
  "c",
5461
5461
  "changed",
5462
- "format only new and modified components"
5462
+ "lint only new and modified components"
5463
+ ],
5464
+ [
5465
+ "f",
5466
+ "fix",
5467
+ "automatically fix problems"
5463
5468
  ],
5464
5469
  [
5465
5470
  "",
5466
- "check",
5467
- "will output a human-friendly message and a list of unformatted files, if any"
5471
+ "fix-type <fixType>",
5472
+ "specify the types of fixes to apply (problem, suggestion, layout)"
5468
5473
  ],
5469
5474
  [
5470
5475
  "j",
5471
5476
  "json",
5472
- "return the format results in json format"
5477
+ "return the lint results in json format"
5473
5478
  ]
5474
5479
  ],
5475
- "description": "auto-format component source code",
5476
- "extendedDescription": "formats component files using the formatter configured by each component's environment (Prettier, etc.).\nby default formats all components. use --changed to format only new and modified components.\nsupports check mode to verify formatting without making changes.",
5480
+ "description": "analyze component code for issues and style violations",
5481
+ "extendedDescription": "runs linters configured by each component's environment (ESLint, etc.) to check for code quality issues.\nby default lints all components. use --changed to lint only new and modified components.\nsupports automatic fixing of certain issues with --fix flag.",
5477
5482
  "group": "testing",
5478
5483
  "private": false,
5479
5484
  "arguments": [
@@ -5484,32 +5489,53 @@
5484
5489
  ]
5485
5490
  },
5486
5491
  {
5487
- "name": "lint [component-pattern]",
5492
+ "name": "validate [component-pattern]",
5488
5493
  "alias": "",
5489
5494
  "options": [
5490
5495
  [
5491
- "c",
5492
- "changed",
5493
- "lint only new and modified components"
5496
+ "a",
5497
+ "all",
5498
+ "validate all components, not only modified and new"
5494
5499
  ],
5495
5500
  [
5496
- "f",
5497
- "fix",
5498
- "automatically fix problems"
5501
+ "c",
5502
+ "continue-on-error",
5503
+ "run all validation checks even when errors are found"
5504
+ ]
5505
+ ],
5506
+ "description": "run type-checking, linting, and testing in sequence",
5507
+ "extendedDescription": "validates components by running check-types, lint, and test commands in sequence.\nstops at the first failure and returns a non-zero exit code.\nby default validates only new and modified components. use --all to validate all components.",
5508
+ "group": "testing",
5509
+ "private": false,
5510
+ "arguments": [
5511
+ {
5512
+ "name": "component-pattern",
5513
+ "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."
5514
+ }
5515
+ ]
5516
+ },
5517
+ {
5518
+ "name": "format [component-pattern]",
5519
+ "alias": "",
5520
+ "options": [
5521
+ [
5522
+ "c",
5523
+ "changed",
5524
+ "format only new and modified components"
5499
5525
  ],
5500
5526
  [
5501
5527
  "",
5502
- "fix-type <fixType>",
5503
- "specify the types of fixes to apply (problem, suggestion, layout)"
5528
+ "check",
5529
+ "will output a human-friendly message and a list of unformatted files, if any"
5504
5530
  ],
5505
5531
  [
5506
5532
  "j",
5507
5533
  "json",
5508
- "return the lint results in json format"
5534
+ "return the format results in json format"
5509
5535
  ]
5510
5536
  ],
5511
- "description": "analyze component code for issues and style violations",
5512
- "extendedDescription": "runs linters configured by each component's environment (ESLint, etc.) to check for code quality issues.\nby default lints all components. use --changed to lint only new and modified components.\nsupports automatic fixing of certain issues with --fix flag.",
5537
+ "description": "auto-format component source code",
5538
+ "extendedDescription": "formats component files using the formatter configured by each component's environment (Prettier, etc.).\nby default formats all components. use --changed to format only new and modified components.\nsupports check mode to verify formatting without making changes.",
5513
5539
  "group": "testing",
5514
5540
  "private": false,
5515
5541
  "arguments": [
package/cli-reference.mdx CHANGED
@@ -2550,6 +2550,26 @@ supports glob patterns to update specific packages. prompts for confirmation unl
2550
2550
 
2551
2551
  ---
2552
2552
 
2553
+ ## validate
2554
+
2555
+ **Description**: run type-checking, linting, and testing in sequence
2556
+ validates components by running check-types, lint, and test commands in sequence.
2557
+ stops at the first failure and returns a non-zero exit code.
2558
+ by default validates only new and modified components. use --all to validate all components.
2559
+
2560
+ `bit validate [component-pattern]`
2561
+
2562
+ | **Arg** | **Description** |
2563
+ | ------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
2564
+ | `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. |
2565
+
2566
+ | **Option** | **Option alias** | **Description** |
2567
+ | --------------------- | :--------------: | ---------------------------------------------------- |
2568
+ | `--all` | `-a` | validate all components, not only modified and new |
2569
+ | `--continue-on-error` | `-c` | run all validation checks even when errors are found |
2570
+
2571
+ ---
2572
+
2553
2573
  ## version
2554
2574
 
2555
2575
  **Description**: display the installed Bit version
@@ -1,4 +1,4 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.12.139'
2
+ description: 'Bit command synopses. Bit version: 1.12.141'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
@@ -5453,27 +5453,32 @@
5453
5453
  "private": true
5454
5454
  },
5455
5455
  {
5456
- "name": "format [component-pattern]",
5456
+ "name": "lint [component-pattern]",
5457
5457
  "alias": "",
5458
5458
  "options": [
5459
5459
  [
5460
5460
  "c",
5461
5461
  "changed",
5462
- "format only new and modified components"
5462
+ "lint only new and modified components"
5463
+ ],
5464
+ [
5465
+ "f",
5466
+ "fix",
5467
+ "automatically fix problems"
5463
5468
  ],
5464
5469
  [
5465
5470
  "",
5466
- "check",
5467
- "will output a human-friendly message and a list of unformatted files, if any"
5471
+ "fix-type <fixType>",
5472
+ "specify the types of fixes to apply (problem, suggestion, layout)"
5468
5473
  ],
5469
5474
  [
5470
5475
  "j",
5471
5476
  "json",
5472
- "return the format results in json format"
5477
+ "return the lint results in json format"
5473
5478
  ]
5474
5479
  ],
5475
- "description": "auto-format component source code",
5476
- "extendedDescription": "formats component files using the formatter configured by each component's environment (Prettier, etc.).\nby default formats all components. use --changed to format only new and modified components.\nsupports check mode to verify formatting without making changes.",
5480
+ "description": "analyze component code for issues and style violations",
5481
+ "extendedDescription": "runs linters configured by each component's environment (ESLint, etc.) to check for code quality issues.\nby default lints all components. use --changed to lint only new and modified components.\nsupports automatic fixing of certain issues with --fix flag.",
5477
5482
  "group": "testing",
5478
5483
  "private": false,
5479
5484
  "arguments": [
@@ -5484,32 +5489,53 @@
5484
5489
  ]
5485
5490
  },
5486
5491
  {
5487
- "name": "lint [component-pattern]",
5492
+ "name": "validate [component-pattern]",
5488
5493
  "alias": "",
5489
5494
  "options": [
5490
5495
  [
5491
- "c",
5492
- "changed",
5493
- "lint only new and modified components"
5496
+ "a",
5497
+ "all",
5498
+ "validate all components, not only modified and new"
5494
5499
  ],
5495
5500
  [
5496
- "f",
5497
- "fix",
5498
- "automatically fix problems"
5501
+ "c",
5502
+ "continue-on-error",
5503
+ "run all validation checks even when errors are found"
5504
+ ]
5505
+ ],
5506
+ "description": "run type-checking, linting, and testing in sequence",
5507
+ "extendedDescription": "validates components by running check-types, lint, and test commands in sequence.\nstops at the first failure and returns a non-zero exit code.\nby default validates only new and modified components. use --all to validate all components.",
5508
+ "group": "testing",
5509
+ "private": false,
5510
+ "arguments": [
5511
+ {
5512
+ "name": "component-pattern",
5513
+ "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."
5514
+ }
5515
+ ]
5516
+ },
5517
+ {
5518
+ "name": "format [component-pattern]",
5519
+ "alias": "",
5520
+ "options": [
5521
+ [
5522
+ "c",
5523
+ "changed",
5524
+ "format only new and modified components"
5499
5525
  ],
5500
5526
  [
5501
5527
  "",
5502
- "fix-type <fixType>",
5503
- "specify the types of fixes to apply (problem, suggestion, layout)"
5528
+ "check",
5529
+ "will output a human-friendly message and a list of unformatted files, if any"
5504
5530
  ],
5505
5531
  [
5506
5532
  "j",
5507
5533
  "json",
5508
- "return the lint results in json format"
5534
+ "return the format results in json format"
5509
5535
  ]
5510
5536
  ],
5511
- "description": "analyze component code for issues and style violations",
5512
- "extendedDescription": "runs linters configured by each component's environment (ESLint, etc.) to check for code quality issues.\nby default lints all components. use --changed to lint only new and modified components.\nsupports automatic fixing of certain issues with --fix flag.",
5537
+ "description": "auto-format component source code",
5538
+ "extendedDescription": "formats component files using the formatter configured by each component's environment (Prettier, etc.).\nby default formats all components. use --changed to format only new and modified components.\nsupports check mode to verify formatting without making changes.",
5513
5539
  "group": "testing",
5514
5540
  "private": false,
5515
5541
  "arguments": [
@@ -13392,7 +13392,98 @@ function MDXContent(_ref) {
13392
13392
  }), (0, _react2.mdx)("td", {
13393
13393
  parentName: "tr",
13394
13394
  "align": null
13395
- }, "update to the newest version respecting semver")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "version"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
13395
+ }, "update to the newest version respecting semver")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "validate"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
13396
+ parentName: "p"
13397
+ }, "Description"), ": run type-checking, linting, and testing in sequence", (0, _react2.mdx)("br", {
13398
+ parentName: "p"
13399
+ }), "\n", "validates components by running check-types, lint, and test commands in sequence.", (0, _react2.mdx)("br", {
13400
+ parentName: "p"
13401
+ }), "\n", "stops at the first failure and returns a non-zero exit code.", (0, _react2.mdx)("br", {
13402
+ parentName: "p"
13403
+ }), "\n", "by default validates only new and modified components. use --all to validate all components."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
13404
+ parentName: "p"
13405
+ }, "bit validate [component-pattern]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
13406
+ parentName: "table"
13407
+ }, (0, _react2.mdx)("tr", {
13408
+ parentName: "thead"
13409
+ }, (0, _react2.mdx)("th", {
13410
+ parentName: "tr",
13411
+ "align": null
13412
+ }, (0, _react2.mdx)("strong", {
13413
+ parentName: "th"
13414
+ }, "Arg")), (0, _react2.mdx)("th", {
13415
+ parentName: "tr",
13416
+ "align": "center"
13417
+ }, (0, _react2.mdx)("strong", {
13418
+ parentName: "th"
13419
+ }, "Description")))), (0, _react2.mdx)("tbody", {
13420
+ parentName: "table"
13421
+ }, (0, _react2.mdx)("tr", {
13422
+ parentName: "tbody"
13423
+ }, (0, _react2.mdx)("td", {
13424
+ parentName: "tr",
13425
+ "align": null
13426
+ }, (0, _react2.mdx)("inlineCode", {
13427
+ parentName: "td"
13428
+ }, "component-pattern")), (0, _react2.mdx)("td", {
13429
+ parentName: "tr",
13430
+ "align": "center"
13431
+ }, "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", {
13432
+ parentName: "td"
13433
+ }, "bit pattern --help"), " to understand patterns better and ", (0, _react2.mdx)("inlineCode", {
13434
+ parentName: "td"
13435
+ }, "bit pattern <pattern>"), " to validate the pattern.")))), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
13436
+ parentName: "table"
13437
+ }, (0, _react2.mdx)("tr", {
13438
+ parentName: "thead"
13439
+ }, (0, _react2.mdx)("th", {
13440
+ parentName: "tr",
13441
+ "align": null
13442
+ }, (0, _react2.mdx)("strong", {
13443
+ parentName: "th"
13444
+ }, "Option")), (0, _react2.mdx)("th", {
13445
+ parentName: "tr",
13446
+ "align": "center"
13447
+ }, (0, _react2.mdx)("strong", {
13448
+ parentName: "th"
13449
+ }, "Option alias")), (0, _react2.mdx)("th", {
13450
+ parentName: "tr",
13451
+ "align": null
13452
+ }, (0, _react2.mdx)("strong", {
13453
+ parentName: "th"
13454
+ }, "Description")))), (0, _react2.mdx)("tbody", {
13455
+ parentName: "table"
13456
+ }, (0, _react2.mdx)("tr", {
13457
+ parentName: "tbody"
13458
+ }, (0, _react2.mdx)("td", {
13459
+ parentName: "tr",
13460
+ "align": null
13461
+ }, (0, _react2.mdx)("inlineCode", {
13462
+ parentName: "td"
13463
+ }, "--all")), (0, _react2.mdx)("td", {
13464
+ parentName: "tr",
13465
+ "align": "center"
13466
+ }, (0, _react2.mdx)("inlineCode", {
13467
+ parentName: "td"
13468
+ }, "-a")), (0, _react2.mdx)("td", {
13469
+ parentName: "tr",
13470
+ "align": null
13471
+ }, "validate all components, not only modified and new")), (0, _react2.mdx)("tr", {
13472
+ parentName: "tbody"
13473
+ }, (0, _react2.mdx)("td", {
13474
+ parentName: "tr",
13475
+ "align": null
13476
+ }, (0, _react2.mdx)("inlineCode", {
13477
+ parentName: "td"
13478
+ }, "--continue-on-error")), (0, _react2.mdx)("td", {
13479
+ parentName: "tr",
13480
+ "align": "center"
13481
+ }, (0, _react2.mdx)("inlineCode", {
13482
+ parentName: "td"
13483
+ }, "-c")), (0, _react2.mdx)("td", {
13484
+ parentName: "tr",
13485
+ "align": null
13486
+ }, "run all validation checks even when errors are found")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "version"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
13396
13487
  parentName: "p"
13397
13488
  }, "Description"), ": display the installed Bit version"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
13398
13489
  parentName: "p"