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

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",
@@ -3815,6 +3971,11 @@
3815
3971
  "r",
3816
3972
  "refactor",
3817
3973
  "update the import/require statements in all dependent components (in the same workspace)"
3974
+ ],
3975
+ [
3976
+ "",
3977
+ "preserve",
3978
+ "avoid renaming files and variables/classes according to the new component name"
3818
3979
  ]
3819
3980
  ],
3820
3981
  "description": "EXPERIMENTAL. rename component. if tagged/exported, create a new component and deprecate the original component",
@@ -4006,60 +4167,5 @@
4006
4167
  "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
4168
  "group": "development",
4008
4169
  "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
4170
  }
4065
4171
  ]
package/cli-reference.mdx CHANGED
@@ -1165,6 +1165,7 @@ for example: "http://localhost:3000", "file:///tmp/local-scope"
1165
1165
  | `--scope <scope-name>` | `-s` | default scope for the newly created component |
1166
1166
  | `--path <relative-path>` | `-p` | relative path in the workspace. by default the path is `<scope>/<namespace>/<name>` |
1167
1167
  | `--refactor` | `-r` | update the import/require statements in all dependent components (in the same workspace) |
1168
+ | `--preserve` | | avoid renaming files and variables/classes according to the new component name |
1168
1169
 
1169
1170
  ---
1170
1171
 
@@ -1522,3 +1523,51 @@ list components templates when inside bit-workspace (for bit-create), otherwise,
1522
1523
  | `--json` | `-j` | json format |
1523
1524
 
1524
1525
  ---
1526
+
1527
+ ## ws-config
1528
+
1529
+ **Alias**: `workspace-config`
1530
+ **Description**: manage workspace config files
1531
+
1532
+ `bit ws-config <sub-command>`
1533
+
1534
+ ### ws-config write
1535
+
1536
+ **Usage**: `ws-config write`
1537
+
1538
+ **Description**: EXPERIMENTAL. write config files in the workspace. useful for IDEs
1539
+
1540
+ | **Option** | **Option alias** | **Description** |
1541
+ | ------------------------ | :--------------: | ---------------------------------------------------------------------------------------------------------------------------- |
1542
+ | `--clean` | `-c` | delete existing config files from the workspace. highly recommended to run it with "--dry-run" first |
1543
+ | `--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 |
1544
+ | `--silent` | `-s` | do not prompt for confirmation |
1545
+ | `--no-dedupe` | | write configs inside each one of the component's dir, avoid deduping |
1546
+ | `--dry-run` | | show the paths that configs will be written per env |
1547
+ | `--dry-run-with-content` | | use with --json flag. show the config content and the paths it will be written per env |
1548
+ | `--json` | `-j` | json format |
1549
+
1550
+ ### ws-config clean
1551
+
1552
+ **Usage**: `ws-config clean`
1553
+
1554
+ **Description**: EXPERIMENTAL. clean (delete) written config files in the workspace. useful for IDEs
1555
+
1556
+ | **Option** | **Option alias** | **Description** |
1557
+ | --------------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------- |
1558
+ | `--silent` | `-s` | do not prompt for confirmation |
1559
+ | `--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 |
1560
+ | `--dry-run` | | show the paths that configs will be written per env |
1561
+ | `--json` | `-j` | json format |
1562
+
1563
+ ### ws-config list
1564
+
1565
+ **Usage**: `ws-config list`
1566
+
1567
+ **Description**: EXPERIMENTAL. list config writers
1568
+
1569
+ | **Option** | **Option alias** | **Description** |
1570
+ | ---------- | :--------------: | --------------- |
1571
+ | `--json` | `-j` | json format |
1572
+
1573
+ ---
@@ -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",
@@ -3815,6 +3971,11 @@
3815
3971
  "r",
3816
3972
  "refactor",
3817
3973
  "update the import/require statements in all dependent components (in the same workspace)"
3974
+ ],
3975
+ [
3976
+ "",
3977
+ "preserve",
3978
+ "avoid renaming files and variables/classes according to the new component name"
3818
3979
  ]
3819
3980
  ],
3820
3981
  "description": "EXPERIMENTAL. rename component. if tagged/exported, create a new component and deprecate the original component",
@@ -4006,60 +4167,5 @@
4006
4167
  "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
4168
  "group": "development",
4008
4169
  "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
4170
  }
4065
4171
  ]