@teambit/harmony.content.cli-reference 1.95.129 → 1.95.130

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.
@@ -3421,6 +3421,162 @@
3421
3421
  "group": "development",
3422
3422
  "private": false
3423
3423
  },
3424
+ {
3425
+ "name": "ws-config <sub-command>",
3426
+ "alias": "workspace-config",
3427
+ "options": [],
3428
+ "description": "manage workspace config files",
3429
+ "extendedDescription": "",
3430
+ "group": "development",
3431
+ "private": false,
3432
+ "commands": [
3433
+ {
3434
+ "name": "write",
3435
+ "alias": "",
3436
+ "options": [
3437
+ [
3438
+ "c",
3439
+ "clean",
3440
+ "delete existing config files from the workspace. highly recommended to run it with \"--dry-run\" first"
3441
+ ],
3442
+ [
3443
+ "w",
3444
+ "writers <writers>",
3445
+ "only write config files for the given writers. use comma to separate multiple writers. use ws-config list to see all writers"
3446
+ ],
3447
+ [
3448
+ "s",
3449
+ "silent",
3450
+ "do not prompt for confirmation"
3451
+ ],
3452
+ [
3453
+ "",
3454
+ "no-dedupe",
3455
+ "write configs inside each one of the component's dir, avoid deduping"
3456
+ ],
3457
+ [
3458
+ "",
3459
+ "dry-run",
3460
+ "show the paths that configs will be written per env"
3461
+ ],
3462
+ [
3463
+ "",
3464
+ "dry-run-with-content",
3465
+ "use with --json flag. show the config content and the paths it will be written per env"
3466
+ ],
3467
+ [
3468
+ "j",
3469
+ "json",
3470
+ "json format"
3471
+ ]
3472
+ ],
3473
+ "description": "EXPERIMENTAL. write config files in the workspace. useful for IDEs",
3474
+ "extendedDescription": "",
3475
+ "group": "development",
3476
+ "private": false
3477
+ },
3478
+ {
3479
+ "name": "clean",
3480
+ "alias": "",
3481
+ "options": [
3482
+ [
3483
+ "s",
3484
+ "silent",
3485
+ "do not prompt for confirmation"
3486
+ ],
3487
+ [
3488
+ "w",
3489
+ "writers <writers>",
3490
+ "only write config files for the given writers. use comma to separate multiple writers. use ws-config list to see all writers"
3491
+ ],
3492
+ [
3493
+ "",
3494
+ "dry-run",
3495
+ "show the paths that configs will be written per env"
3496
+ ],
3497
+ [
3498
+ "j",
3499
+ "json",
3500
+ "json format"
3501
+ ]
3502
+ ],
3503
+ "description": "EXPERIMENTAL. clean (delete) written config files in the workspace. useful for IDEs",
3504
+ "extendedDescription": "",
3505
+ "group": "development",
3506
+ "private": false
3507
+ },
3508
+ {
3509
+ "name": "list",
3510
+ "alias": "",
3511
+ "options": [
3512
+ [
3513
+ "j",
3514
+ "json",
3515
+ "json format"
3516
+ ]
3517
+ ],
3518
+ "description": "EXPERIMENTAL. list config writers",
3519
+ "extendedDescription": "",
3520
+ "group": "development",
3521
+ "private": false
3522
+ }
3523
+ ]
3524
+ },
3525
+ {
3526
+ "name": "format [component...]",
3527
+ "alias": "",
3528
+ "options": [
3529
+ [
3530
+ "c",
3531
+ "changed",
3532
+ "format only new and modified components"
3533
+ ],
3534
+ [
3535
+ "",
3536
+ "check",
3537
+ "will output a human-friendly message and a list of unformatted files, if any"
3538
+ ],
3539
+ [
3540
+ "j",
3541
+ "json",
3542
+ "return the format results in json format"
3543
+ ]
3544
+ ],
3545
+ "description": "format components in the development workspace",
3546
+ "extendedDescription": "",
3547
+ "group": "development",
3548
+ "private": false
3549
+ },
3550
+ {
3551
+ "name": "lint [component...]",
3552
+ "alias": "",
3553
+ "options": [
3554
+ [
3555
+ "c",
3556
+ "changed",
3557
+ "lint only new and modified components"
3558
+ ],
3559
+ [
3560
+ "f",
3561
+ "fix",
3562
+ "automatically fix problems"
3563
+ ],
3564
+ [
3565
+ "",
3566
+ "fix-type <fixType>",
3567
+ "specify the types of fixes to apply (problem, suggestion, layout)"
3568
+ ],
3569
+ [
3570
+ "j",
3571
+ "json",
3572
+ "return the lint results in json format"
3573
+ ]
3574
+ ],
3575
+ "description": "lint components in the development workspace",
3576
+ "extendedDescription": "",
3577
+ "group": "development",
3578
+ "private": false
3579
+ },
3424
3580
  {
3425
3581
  "name": "test [component-pattern]",
3426
3582
  "alias": "at",
@@ -4006,60 +4162,5 @@
4006
4162
  "extendedDescription": "without --multiple, this will be running on the original scope.\nwith --multiple, a new bare-scope needs to be created and it will import the components to this scope first",
4007
4163
  "group": "development",
4008
4164
  "private": true
4009
- },
4010
- {
4011
- "name": "format [component...]",
4012
- "alias": "",
4013
- "options": [
4014
- [
4015
- "c",
4016
- "changed",
4017
- "format only new and modified components"
4018
- ],
4019
- [
4020
- "",
4021
- "check",
4022
- "will output a human-friendly message and a list of unformatted files, if any"
4023
- ],
4024
- [
4025
- "j",
4026
- "json",
4027
- "return the format results in json format"
4028
- ]
4029
- ],
4030
- "description": "format components in the development workspace",
4031
- "extendedDescription": "",
4032
- "group": "development",
4033
- "private": false
4034
- },
4035
- {
4036
- "name": "lint [component...]",
4037
- "alias": "",
4038
- "options": [
4039
- [
4040
- "c",
4041
- "changed",
4042
- "lint only new and modified components"
4043
- ],
4044
- [
4045
- "f",
4046
- "fix",
4047
- "automatically fix problems"
4048
- ],
4049
- [
4050
- "",
4051
- "fix-type <fixType>",
4052
- "specify the types of fixes to apply (problem, suggestion, layout)"
4053
- ],
4054
- [
4055
- "j",
4056
- "json",
4057
- "return the lint results in json format"
4058
- ]
4059
- ],
4060
- "description": "lint components in the development workspace",
4061
- "extendedDescription": "",
4062
- "group": "development",
4063
- "private": false
4064
4165
  }
4065
4166
  ]
package/cli-reference.mdx CHANGED
@@ -1522,3 +1522,51 @@ list components templates when inside bit-workspace (for bit-create), otherwise,
1522
1522
  | `--json` | `-j` | json format |
1523
1523
 
1524
1524
  ---
1525
+
1526
+ ## ws-config
1527
+
1528
+ **Alias**: `workspace-config`
1529
+ **Description**: manage workspace config files
1530
+
1531
+ `bit ws-config <sub-command>`
1532
+
1533
+ ### ws-config write
1534
+
1535
+ **Usage**: `ws-config write`
1536
+
1537
+ **Description**: EXPERIMENTAL. write config files in the workspace. useful for IDEs
1538
+
1539
+ | **Option** | **Option alias** | **Description** |
1540
+ | ------------------------ | :--------------: | ---------------------------------------------------------------------------------------------------------------------------- |
1541
+ | `--clean` | `-c` | delete existing config files from the workspace. highly recommended to run it with "--dry-run" first |
1542
+ | `--writers <writers>` | `-w` | only write config files for the given writers. use comma to separate multiple writers. use ws-config list to see all writers |
1543
+ | `--silent` | `-s` | do not prompt for confirmation |
1544
+ | `--no-dedupe` | | write configs inside each one of the component's dir, avoid deduping |
1545
+ | `--dry-run` | | show the paths that configs will be written per env |
1546
+ | `--dry-run-with-content` | | use with --json flag. show the config content and the paths it will be written per env |
1547
+ | `--json` | `-j` | json format |
1548
+
1549
+ ### ws-config clean
1550
+
1551
+ **Usage**: `ws-config clean`
1552
+
1553
+ **Description**: EXPERIMENTAL. clean (delete) written config files in the workspace. useful for IDEs
1554
+
1555
+ | **Option** | **Option alias** | **Description** |
1556
+ | --------------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------- |
1557
+ | `--silent` | `-s` | do not prompt for confirmation |
1558
+ | `--writers <writers>` | `-w` | only write config files for the given writers. use comma to separate multiple writers. use ws-config list to see all writers |
1559
+ | `--dry-run` | | show the paths that configs will be written per env |
1560
+ | `--json` | `-j` | json format |
1561
+
1562
+ ### ws-config list
1563
+
1564
+ **Usage**: `ws-config list`
1565
+
1566
+ **Description**: EXPERIMENTAL. list config writers
1567
+
1568
+ | **Option** | **Option alias** | **Description** |
1569
+ | ---------- | :--------------: | --------------- |
1570
+ | `--json` | `-j` | json format |
1571
+
1572
+ ---
@@ -3421,6 +3421,162 @@
3421
3421
  "group": "development",
3422
3422
  "private": false
3423
3423
  },
3424
+ {
3425
+ "name": "ws-config <sub-command>",
3426
+ "alias": "workspace-config",
3427
+ "options": [],
3428
+ "description": "manage workspace config files",
3429
+ "extendedDescription": "",
3430
+ "group": "development",
3431
+ "private": false,
3432
+ "commands": [
3433
+ {
3434
+ "name": "write",
3435
+ "alias": "",
3436
+ "options": [
3437
+ [
3438
+ "c",
3439
+ "clean",
3440
+ "delete existing config files from the workspace. highly recommended to run it with \"--dry-run\" first"
3441
+ ],
3442
+ [
3443
+ "w",
3444
+ "writers <writers>",
3445
+ "only write config files for the given writers. use comma to separate multiple writers. use ws-config list to see all writers"
3446
+ ],
3447
+ [
3448
+ "s",
3449
+ "silent",
3450
+ "do not prompt for confirmation"
3451
+ ],
3452
+ [
3453
+ "",
3454
+ "no-dedupe",
3455
+ "write configs inside each one of the component's dir, avoid deduping"
3456
+ ],
3457
+ [
3458
+ "",
3459
+ "dry-run",
3460
+ "show the paths that configs will be written per env"
3461
+ ],
3462
+ [
3463
+ "",
3464
+ "dry-run-with-content",
3465
+ "use with --json flag. show the config content and the paths it will be written per env"
3466
+ ],
3467
+ [
3468
+ "j",
3469
+ "json",
3470
+ "json format"
3471
+ ]
3472
+ ],
3473
+ "description": "EXPERIMENTAL. write config files in the workspace. useful for IDEs",
3474
+ "extendedDescription": "",
3475
+ "group": "development",
3476
+ "private": false
3477
+ },
3478
+ {
3479
+ "name": "clean",
3480
+ "alias": "",
3481
+ "options": [
3482
+ [
3483
+ "s",
3484
+ "silent",
3485
+ "do not prompt for confirmation"
3486
+ ],
3487
+ [
3488
+ "w",
3489
+ "writers <writers>",
3490
+ "only write config files for the given writers. use comma to separate multiple writers. use ws-config list to see all writers"
3491
+ ],
3492
+ [
3493
+ "",
3494
+ "dry-run",
3495
+ "show the paths that configs will be written per env"
3496
+ ],
3497
+ [
3498
+ "j",
3499
+ "json",
3500
+ "json format"
3501
+ ]
3502
+ ],
3503
+ "description": "EXPERIMENTAL. clean (delete) written config files in the workspace. useful for IDEs",
3504
+ "extendedDescription": "",
3505
+ "group": "development",
3506
+ "private": false
3507
+ },
3508
+ {
3509
+ "name": "list",
3510
+ "alias": "",
3511
+ "options": [
3512
+ [
3513
+ "j",
3514
+ "json",
3515
+ "json format"
3516
+ ]
3517
+ ],
3518
+ "description": "EXPERIMENTAL. list config writers",
3519
+ "extendedDescription": "",
3520
+ "group": "development",
3521
+ "private": false
3522
+ }
3523
+ ]
3524
+ },
3525
+ {
3526
+ "name": "format [component...]",
3527
+ "alias": "",
3528
+ "options": [
3529
+ [
3530
+ "c",
3531
+ "changed",
3532
+ "format only new and modified components"
3533
+ ],
3534
+ [
3535
+ "",
3536
+ "check",
3537
+ "will output a human-friendly message and a list of unformatted files, if any"
3538
+ ],
3539
+ [
3540
+ "j",
3541
+ "json",
3542
+ "return the format results in json format"
3543
+ ]
3544
+ ],
3545
+ "description": "format components in the development workspace",
3546
+ "extendedDescription": "",
3547
+ "group": "development",
3548
+ "private": false
3549
+ },
3550
+ {
3551
+ "name": "lint [component...]",
3552
+ "alias": "",
3553
+ "options": [
3554
+ [
3555
+ "c",
3556
+ "changed",
3557
+ "lint only new and modified components"
3558
+ ],
3559
+ [
3560
+ "f",
3561
+ "fix",
3562
+ "automatically fix problems"
3563
+ ],
3564
+ [
3565
+ "",
3566
+ "fix-type <fixType>",
3567
+ "specify the types of fixes to apply (problem, suggestion, layout)"
3568
+ ],
3569
+ [
3570
+ "j",
3571
+ "json",
3572
+ "return the lint results in json format"
3573
+ ]
3574
+ ],
3575
+ "description": "lint components in the development workspace",
3576
+ "extendedDescription": "",
3577
+ "group": "development",
3578
+ "private": false
3579
+ },
3424
3580
  {
3425
3581
  "name": "test [component-pattern]",
3426
3582
  "alias": "at",
@@ -4006,60 +4162,5 @@
4006
4162
  "extendedDescription": "without --multiple, this will be running on the original scope.\nwith --multiple, a new bare-scope needs to be created and it will import the components to this scope first",
4007
4163
  "group": "development",
4008
4164
  "private": true
4009
- },
4010
- {
4011
- "name": "format [component...]",
4012
- "alias": "",
4013
- "options": [
4014
- [
4015
- "c",
4016
- "changed",
4017
- "format only new and modified components"
4018
- ],
4019
- [
4020
- "",
4021
- "check",
4022
- "will output a human-friendly message and a list of unformatted files, if any"
4023
- ],
4024
- [
4025
- "j",
4026
- "json",
4027
- "return the format results in json format"
4028
- ]
4029
- ],
4030
- "description": "format components in the development workspace",
4031
- "extendedDescription": "",
4032
- "group": "development",
4033
- "private": false
4034
- },
4035
- {
4036
- "name": "lint [component...]",
4037
- "alias": "",
4038
- "options": [
4039
- [
4040
- "c",
4041
- "changed",
4042
- "lint only new and modified components"
4043
- ],
4044
- [
4045
- "f",
4046
- "fix",
4047
- "automatically fix problems"
4048
- ],
4049
- [
4050
- "",
4051
- "fix-type <fixType>",
4052
- "specify the types of fixes to apply (problem, suggestion, layout)"
4053
- ],
4054
- [
4055
- "j",
4056
- "json",
4057
- "return the lint results in json format"
4058
- ]
4059
- ],
4060
- "description": "lint components in the development workspace",
4061
- "extendedDescription": "",
4062
- "group": "development",
4063
- "private": false
4064
4165
  }
4065
4166
  ]