@teambit/harmony.content.cli-reference 1.95.170 → 1.95.172

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: 0.1.89'
2
+ description: 'Bit command synopses. Bit version: 0.1.91'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
5
5
 
@@ -1749,11 +1749,6 @@
1749
1749
  "name": "install [packages...]",
1750
1750
  "alias": "in",
1751
1751
  "options": [
1752
- [
1753
- "v",
1754
- "variants <variants>",
1755
- "add packages to specific variants"
1756
- ],
1757
1752
  [
1758
1753
  "t",
1759
1754
  "type [lifecycleType]",
@@ -2279,7 +2274,12 @@
2279
2274
  [
2280
2275
  "",
2281
2276
  "force-deploy",
2282
- "run the tag pipeline although the build failed"
2277
+ "DEPRECATED. use --ignore-build-error instead"
2278
+ ],
2279
+ [
2280
+ "",
2281
+ "ignore-build-errors",
2282
+ "run the tag pipeline although the build pipeline failed"
2283
2283
  ],
2284
2284
  [
2285
2285
  "",
@@ -2392,7 +2392,12 @@
2392
2392
  [
2393
2393
  "",
2394
2394
  "force-deploy",
2395
- "run the deploy pipeline although the build failed"
2395
+ "DEPRECATED. use --ignore-build-error instead"
2396
+ ],
2397
+ [
2398
+ "",
2399
+ "ignore-build-errors",
2400
+ "run the snap pipeline although the build pipeline failed"
2396
2401
  ],
2397
2402
  [
2398
2403
  "i",
@@ -2528,7 +2533,12 @@
2528
2533
  [
2529
2534
  "",
2530
2535
  "force-deploy",
2531
- "run the tag pipeline although the build failed"
2536
+ "DEPRECATED. use --ignore-build-error instead"
2537
+ ],
2538
+ [
2539
+ "",
2540
+ "ignore-build-errors",
2541
+ "run the tag pipeline although the build pipeline failed"
2532
2542
  ],
2533
2543
  [
2534
2544
  "",
@@ -2589,7 +2599,12 @@
2589
2599
  [
2590
2600
  "",
2591
2601
  "force-deploy",
2592
- "run the deploy pipeline although the build failed"
2602
+ "DEPRECATED. use --ignore-build-error instead"
2603
+ ],
2604
+ [
2605
+ "",
2606
+ "ignore-build-errors",
2607
+ "run the snap pipeline although the build pipeline failed"
2593
2608
  ],
2594
2609
  [
2595
2610
  "i",
@@ -3707,167 +3722,6 @@
3707
3722
  }
3708
3723
  ]
3709
3724
  },
3710
- {
3711
- "name": "ws-config <sub-command>",
3712
- "alias": "workspace-config",
3713
- "options": [],
3714
- "description": "manage workspace config files",
3715
- "extendedDescription": "",
3716
- "group": "development",
3717
- "private": false,
3718
- "commands": [
3719
- {
3720
- "name": "write",
3721
- "alias": "",
3722
- "options": [
3723
- [
3724
- "c",
3725
- "clean",
3726
- "delete existing config files from the workspace. highly recommended to run it with \"--dry-run\" first"
3727
- ],
3728
- [
3729
- "w",
3730
- "writers <writers>",
3731
- "only write config files for the given writers. use comma to separate multiple writers. use ws-config list to see all writers"
3732
- ],
3733
- [
3734
- "s",
3735
- "silent",
3736
- "do not prompt for confirmation"
3737
- ],
3738
- [
3739
- "",
3740
- "no-dedupe",
3741
- "write configs inside each one of the component's dir, avoid deduping"
3742
- ],
3743
- [
3744
- "",
3745
- "dry-run",
3746
- "show the paths that configs will be written per env"
3747
- ],
3748
- [
3749
- "",
3750
- "dry-run-with-content",
3751
- "use with --json flag. show the config content and the paths it will be written per env"
3752
- ],
3753
- [
3754
- "v",
3755
- "verbose",
3756
- "showing verbose output for writing"
3757
- ],
3758
- [
3759
- "j",
3760
- "json",
3761
- "json format"
3762
- ]
3763
- ],
3764
- "description": "EXPERIMENTAL. write config files in the workspace. useful for IDEs",
3765
- "extendedDescription": "",
3766
- "group": "development",
3767
- "private": false
3768
- },
3769
- {
3770
- "name": "clean",
3771
- "alias": "",
3772
- "options": [
3773
- [
3774
- "s",
3775
- "silent",
3776
- "do not prompt for confirmation"
3777
- ],
3778
- [
3779
- "w",
3780
- "writers <writers>",
3781
- "only write config files for the given writers. use comma to separate multiple writers. use ws-config list to see all writers"
3782
- ],
3783
- [
3784
- "",
3785
- "dry-run",
3786
- "show the paths that configs will be written per env"
3787
- ],
3788
- [
3789
- "j",
3790
- "json",
3791
- "json format"
3792
- ]
3793
- ],
3794
- "description": "EXPERIMENTAL. clean (delete) written config files in the workspace. useful for IDEs",
3795
- "extendedDescription": "",
3796
- "group": "development",
3797
- "private": false
3798
- },
3799
- {
3800
- "name": "list",
3801
- "alias": "",
3802
- "options": [
3803
- [
3804
- "j",
3805
- "json",
3806
- "json format"
3807
- ]
3808
- ],
3809
- "description": "EXPERIMENTAL. list config writers",
3810
- "extendedDescription": "",
3811
- "group": "development",
3812
- "private": false
3813
- }
3814
- ]
3815
- },
3816
- {
3817
- "name": "format [component...]",
3818
- "alias": "",
3819
- "options": [
3820
- [
3821
- "c",
3822
- "changed",
3823
- "format only new and modified components"
3824
- ],
3825
- [
3826
- "",
3827
- "check",
3828
- "will output a human-friendly message and a list of unformatted files, if any"
3829
- ],
3830
- [
3831
- "j",
3832
- "json",
3833
- "return the format results in json format"
3834
- ]
3835
- ],
3836
- "description": "format components in the development workspace",
3837
- "extendedDescription": "",
3838
- "group": "development",
3839
- "private": false
3840
- },
3841
- {
3842
- "name": "lint [component...]",
3843
- "alias": "",
3844
- "options": [
3845
- [
3846
- "c",
3847
- "changed",
3848
- "lint only new and modified components"
3849
- ],
3850
- [
3851
- "f",
3852
- "fix",
3853
- "automatically fix problems"
3854
- ],
3855
- [
3856
- "",
3857
- "fix-type <fixType>",
3858
- "specify the types of fixes to apply (problem, suggestion, layout)"
3859
- ],
3860
- [
3861
- "j",
3862
- "json",
3863
- "return the lint results in json format"
3864
- ]
3865
- ],
3866
- "description": "lint components in the development workspace",
3867
- "extendedDescription": "",
3868
- "group": "development",
3869
- "private": false
3870
- },
3871
3725
  {
3872
3726
  "name": "test [component-pattern]",
3873
3727
  "alias": "at",
@@ -4463,5 +4317,166 @@
4463
4317
  "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",
4464
4318
  "group": "development",
4465
4319
  "private": true
4320
+ },
4321
+ {
4322
+ "name": "format [component...]",
4323
+ "alias": "",
4324
+ "options": [
4325
+ [
4326
+ "c",
4327
+ "changed",
4328
+ "format only new and modified components"
4329
+ ],
4330
+ [
4331
+ "",
4332
+ "check",
4333
+ "will output a human-friendly message and a list of unformatted files, if any"
4334
+ ],
4335
+ [
4336
+ "j",
4337
+ "json",
4338
+ "return the format results in json format"
4339
+ ]
4340
+ ],
4341
+ "description": "format components in the development workspace",
4342
+ "extendedDescription": "",
4343
+ "group": "development",
4344
+ "private": false
4345
+ },
4346
+ {
4347
+ "name": "lint [component...]",
4348
+ "alias": "",
4349
+ "options": [
4350
+ [
4351
+ "c",
4352
+ "changed",
4353
+ "lint only new and modified components"
4354
+ ],
4355
+ [
4356
+ "f",
4357
+ "fix",
4358
+ "automatically fix problems"
4359
+ ],
4360
+ [
4361
+ "",
4362
+ "fix-type <fixType>",
4363
+ "specify the types of fixes to apply (problem, suggestion, layout)"
4364
+ ],
4365
+ [
4366
+ "j",
4367
+ "json",
4368
+ "return the lint results in json format"
4369
+ ]
4370
+ ],
4371
+ "description": "lint components in the development workspace",
4372
+ "extendedDescription": "",
4373
+ "group": "development",
4374
+ "private": false
4375
+ },
4376
+ {
4377
+ "name": "ws-config <sub-command>",
4378
+ "alias": "workspace-config",
4379
+ "options": [],
4380
+ "description": "manage workspace config files",
4381
+ "extendedDescription": "",
4382
+ "group": "development",
4383
+ "private": false,
4384
+ "commands": [
4385
+ {
4386
+ "name": "write",
4387
+ "alias": "",
4388
+ "options": [
4389
+ [
4390
+ "c",
4391
+ "clean",
4392
+ "delete existing config files from the workspace. highly recommended to run it with \"--dry-run\" first"
4393
+ ],
4394
+ [
4395
+ "w",
4396
+ "writers <writers>",
4397
+ "only write config files for the given writers. use comma to separate multiple writers. use ws-config list to see all writers"
4398
+ ],
4399
+ [
4400
+ "s",
4401
+ "silent",
4402
+ "do not prompt for confirmation"
4403
+ ],
4404
+ [
4405
+ "",
4406
+ "no-dedupe",
4407
+ "write configs inside each one of the component's dir, avoid deduping"
4408
+ ],
4409
+ [
4410
+ "",
4411
+ "dry-run",
4412
+ "show the paths that configs will be written per env"
4413
+ ],
4414
+ [
4415
+ "",
4416
+ "dry-run-with-content",
4417
+ "use with --json flag. show the config content and the paths it will be written per env"
4418
+ ],
4419
+ [
4420
+ "v",
4421
+ "verbose",
4422
+ "showing verbose output for writing"
4423
+ ],
4424
+ [
4425
+ "j",
4426
+ "json",
4427
+ "json format"
4428
+ ]
4429
+ ],
4430
+ "description": "EXPERIMENTAL. write config files in the workspace. useful for IDEs",
4431
+ "extendedDescription": "",
4432
+ "group": "development",
4433
+ "private": false
4434
+ },
4435
+ {
4436
+ "name": "clean",
4437
+ "alias": "",
4438
+ "options": [
4439
+ [
4440
+ "s",
4441
+ "silent",
4442
+ "do not prompt for confirmation"
4443
+ ],
4444
+ [
4445
+ "w",
4446
+ "writers <writers>",
4447
+ "only write config files for the given writers. use comma to separate multiple writers. use ws-config list to see all writers"
4448
+ ],
4449
+ [
4450
+ "",
4451
+ "dry-run",
4452
+ "show the paths that configs will be written per env"
4453
+ ],
4454
+ [
4455
+ "j",
4456
+ "json",
4457
+ "json format"
4458
+ ]
4459
+ ],
4460
+ "description": "EXPERIMENTAL. clean (delete) written config files in the workspace. useful for IDEs",
4461
+ "extendedDescription": "",
4462
+ "group": "development",
4463
+ "private": false
4464
+ },
4465
+ {
4466
+ "name": "list",
4467
+ "alias": "",
4468
+ "options": [
4469
+ [
4470
+ "j",
4471
+ "json",
4472
+ "json format"
4473
+ ]
4474
+ ],
4475
+ "description": "EXPERIMENTAL. list config writers",
4476
+ "extendedDescription": "",
4477
+ "group": "development",
4478
+ "private": false
4479
+ }
4480
+ ]
4466
4481
  }
4467
4482
  ]
package/cli-reference.mdx CHANGED
@@ -767,7 +767,6 @@ when no package is specified, all workspace dependencies are installed and all w
767
767
 
768
768
  | **Option** | **Option alias** | **Description** |
769
769
  | --------------------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------ |
770
- | `--variants <variants>` | `-v` | add packages to specific variants |
771
770
  | `--type [lifecycleType]` | `-t` | "runtime" (default) or "peer" (dev is not a valid option) |
772
771
  | `--update` | `-u` | update all dependencies |
773
772
  | `--update-existing [updateExisting]` | | DEPRECATED (not needed anymore, it is the default now). update existing dependencies version and types |
@@ -1425,7 +1424,8 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
1425
1424
  | `--skip-tests` | | skip running component tests during snap process |
1426
1425
  | `--skip-auto-snap` | | skip auto snapping dependents |
1427
1426
  | `--disable-snap-pipeline` | | skip the snap pipeline |
1428
- | `--force-deploy` | | run the deploy pipeline although the build failed |
1427
+ | `--force-deploy` | | DEPRECATED. use --ignore-build-error instead |
1428
+ | `--ignore-build-errors` | | run the snap pipeline although the build pipeline failed |
1429
1429
  | `--ignore-issues [issues]` | `-i` | ignore component issues (shown in "bit status" as "issues found"), issues to ignore: [MissingPackagesDependenciesOnFs, MissingManuallyConfiguredPackages, MissingComponents, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies, DuplicateComponentAndPackage, MergeConfigHasConflict, NonLoadedEnv, ExternalEnvWithoutVersion] to ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify "\*". |
1430
1430
  | `--all` | `-a` | DEPRECATED (not needed anymore, it is the default now). snap all new and modified components |
1431
1431
  | `--fail-fast` | | stop pipeline execution on the first failed task (by default a task is skipped only when its dependent failed) |
@@ -1511,7 +1511,8 @@ if patterns are entered, you can specify a version per pattern using "@" sign, e
1511
1511
  | `--soft` | | do not persist. only keep note of the changes to be made |
1512
1512
  | `--persist` | | persist the changes generated by --soft tag |
1513
1513
  | `--disable-tag-pipeline` | | skip the tag pipeline to avoid publishing the components |
1514
- | `--force-deploy` | | run the tag pipeline although the build failed |
1514
+ | `--force-deploy` | | DEPRECATED. use --ignore-build-error instead |
1515
+ | `--ignore-build-errors` | | run the tag pipeline although the build pipeline failed |
1515
1516
  | `--increment-by <number>` | | (default to 1) increment semver flag (patch/minor/major) by. e.g. incrementing patch by 2: 0.0.1 -> 0.0.3. |
1516
1517
  | `--ignore-issues [issues]` | `-i` | ignore component issues (shown in "bit status" as "issues found"), issues to ignore: [MissingPackagesDependenciesOnFs, MissingManuallyConfiguredPackages, MissingComponents, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies, DuplicateComponentAndPackage, MergeConfigHasConflict, NonLoadedEnv, ExternalEnvWithoutVersion] to ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify "\*". |
1517
1518
  | `--ignore-newest-version` | `-I` | ignore existing of newer versions (default = false) |
@@ -1,5 +1,5 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 0.1.89'
2
+ description: 'Bit command synopses. Bit version: 0.1.91'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
5
5