@teambit/harmony.content.cli-reference 2.0.113 → 2.0.115

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.
@@ -1844,6 +1844,11 @@
1844
1844
  "",
1845
1845
  "load-from <path-to-template>",
1846
1846
  "local path to the workspace containing the template. Helpful during a development of a workspace-template"
1847
+ ],
1848
+ [
1849
+ "c",
1850
+ "current-dir",
1851
+ "create the new workspace in current directory (default is to create a new directory, inside the current dir)"
1847
1852
  ]
1848
1853
  ],
1849
1854
  "description": "create a new workspace from a template",
@@ -3174,6 +3179,15 @@
3174
3179
  "group": "ungrouped",
3175
3180
  "private": true
3176
3181
  },
3182
+ {
3183
+ "name": "snap-distance <component-id> [source-snap] [target-snap]",
3184
+ "alias": "",
3185
+ "options": [],
3186
+ "description": "show common-snap and distance between two given snaps or between local and remote snaps",
3187
+ "extendedDescription": "in case source and target snaps are not provided, the command will use the local and remote heads.\nby \"head\" we mean component-head if on main, or lane-head if on lane.\nif source and target snaps are provided, the command will use them to calculate the distance.",
3188
+ "group": "ungrouped",
3189
+ "private": true
3190
+ },
3177
3191
  {
3178
3192
  "name": "checkout <to> [component-pattern]",
3179
3193
  "alias": "U",
@@ -4350,222 +4364,6 @@
4350
4364
  }
4351
4365
  ]
4352
4366
  },
4353
- {
4354
- "name": "schema <pattern>",
4355
- "alias": "",
4356
- "options": [
4357
- [
4358
- "j",
4359
- "json",
4360
- "return the component schema in json format"
4361
- ]
4362
- ],
4363
- "description": "shows the API schema of the specified component/s.",
4364
- "extendedDescription": "you can use a `<pattern>` for multiple component ids, such as `bit schema \"org.scope/utils/**\"`.\nuse comma to separate patterns and '!' to exclude. e.g. 'ui/**, !ui/button'\nalways wrap the pattern with single quotes to avoid collision with shell commands.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.\n",
4365
- "group": "development",
4366
- "private": false
4367
- },
4368
- {
4369
- "name": "check-types [component-pattern]",
4370
- "alias": "",
4371
- "options": [
4372
- [
4373
- "a",
4374
- "all",
4375
- "check-types for all components, not only modified and new"
4376
- ],
4377
- [
4378
- "",
4379
- "strict",
4380
- "in case issues found, exit with code 1"
4381
- ]
4382
- ],
4383
- "description": "check typescript types",
4384
- "extendedDescription": "",
4385
- "group": "development",
4386
- "private": false,
4387
- "arguments": [
4388
- {
4389
- "name": "component-pattern",
4390
- "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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern."
4391
- }
4392
- ]
4393
- },
4394
- {
4395
- "name": "write-tsconfig",
4396
- "alias": "",
4397
- "options": [
4398
- [
4399
- "c",
4400
- "clean",
4401
- "delete tsconfig files from the workspace. highly recommended to run it with \"--dry-run\" first"
4402
- ],
4403
- [
4404
- "s",
4405
- "silent",
4406
- "do not prompt for confirmation"
4407
- ],
4408
- [
4409
- "",
4410
- "no-dedupe",
4411
- "write tsconfig.json inside each one of the component's dir, avoid deduping"
4412
- ],
4413
- [
4414
- "",
4415
- "dry-run",
4416
- "show the paths that tsconfig will be written per env"
4417
- ],
4418
- [
4419
- "",
4420
- "dry-run-with-tsconfig",
4421
- "use with --json flag. show the tsconfig.json content and the paths it will be written per env"
4422
- ],
4423
- [
4424
- "j",
4425
- "json",
4426
- "json format"
4427
- ]
4428
- ],
4429
- "description": "DEPRECATED. use bit ws-config write instead",
4430
- "extendedDescription": "",
4431
- "group": "development",
4432
- "private": true
4433
- },
4434
- {
4435
- "name": "aspect <sub-command>",
4436
- "alias": "",
4437
- "options": [],
4438
- "description": "manage aspects",
4439
- "extendedDescription": "",
4440
- "group": "development",
4441
- "private": false,
4442
- "commands": [
4443
- {
4444
- "name": "list [pattern]",
4445
- "alias": "",
4446
- "options": [
4447
- [
4448
- "d",
4449
- "debug",
4450
- "show the origins where the aspects were taken from"
4451
- ]
4452
- ],
4453
- "description": "list all aspects configured on component(s)",
4454
- "extendedDescription": "",
4455
- "group": "development",
4456
- "private": false,
4457
- "arguments": [
4458
- {
4459
- "name": "pattern",
4460
- "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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern."
4461
- }
4462
- ]
4463
- },
4464
- {
4465
- "name": "get <component-name>",
4466
- "alias": "",
4467
- "options": [
4468
- [
4469
- "d",
4470
- "debug",
4471
- "show the origins where the aspects were taken from"
4472
- ],
4473
- [
4474
- "j",
4475
- "json",
4476
- "format as json"
4477
- ]
4478
- ],
4479
- "description": "list the aspects set on a component, as well as their configs and data",
4480
- "extendedDescription": "",
4481
- "group": "development",
4482
- "private": false,
4483
- "arguments": [
4484
- {
4485
- "name": "component-name",
4486
- "description": "the component name or component id to fetch aspects for"
4487
- }
4488
- ]
4489
- },
4490
- {
4491
- "name": "set <pattern> <aspect-id> [config]",
4492
- "alias": "",
4493
- "options": [
4494
- [
4495
- "m",
4496
- "merge",
4497
- "merge with an existing config if exits. (by default, it replaces overlapping existing configs)"
4498
- ]
4499
- ],
4500
- "description": "set components with an aspect to extend their development tools, metadata and (possibly) artifacts",
4501
- "extendedDescription": "",
4502
- "group": "development",
4503
- "private": false,
4504
- "arguments": [
4505
- {
4506
- "name": "pattern",
4507
- "description": "the components to extend. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern."
4508
- },
4509
- {
4510
- "name": "aspect-id",
4511
- "description": "the aspect's component id"
4512
- },
4513
- {
4514
- "name": "config",
4515
- "description": "the aspect config. enter the config as a stringified JSON (e.g. '{\"foo\":\"bar\"}' ). when no config is provided, an aspect is set with an empty config ({})."
4516
- }
4517
- ]
4518
- },
4519
- {
4520
- "name": "unset <pattern> <aspect-id>",
4521
- "alias": "",
4522
- "options": [],
4523
- "description": "unset an aspect from component(s).",
4524
- "extendedDescription": "",
4525
- "group": "development",
4526
- "private": false,
4527
- "arguments": [
4528
- {
4529
- "name": "pattern",
4530
- "description": "the components to target. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern."
4531
- },
4532
- {
4533
- "name": "aspect-id",
4534
- "description": "the aspect's component id"
4535
- }
4536
- ]
4537
- },
4538
- {
4539
- "name": "update <aspect-id> [pattern]",
4540
- "alias": "",
4541
- "options": [],
4542
- "description": "update a version of an aspect for all or specified components",
4543
- "extendedDescription": "",
4544
- "group": "development",
4545
- "private": false,
4546
- "arguments": [
4547
- {
4548
- "name": "aspect-id",
4549
- "description": "the aspect's component id. optionally, add a version (id@version), otherwise will use the latest version from the remote"
4550
- },
4551
- {
4552
- "name": "pattern",
4553
- "description": "the components to update (defaults to all components). 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern."
4554
- }
4555
- ],
4556
- "examples": [
4557
- {
4558
- "cmd": "bit aspect update scope.org/aspect '**/ui/**'",
4559
- "description": "update all components with the \"ui\" namespace that use scope.org/aspect, to use its latest version"
4560
- },
4561
- {
4562
- "cmd": "bit aspect update scope.org/aspect@2.0.0",
4563
- "description": "update version of scope.org/aspect to version 2.0.0 for all components configured with that aspect."
4564
- }
4565
- ]
4566
- }
4567
- ]
4568
- },
4569
4367
  {
4570
4368
  "name": "clear-cache",
4571
4369
  "alias": "cc",
@@ -4730,6 +4528,87 @@
4730
4528
  }
4731
4529
  ]
4732
4530
  },
4531
+ {
4532
+ "name": "schema <pattern>",
4533
+ "alias": "",
4534
+ "options": [
4535
+ [
4536
+ "j",
4537
+ "json",
4538
+ "return the component schema in json format"
4539
+ ]
4540
+ ],
4541
+ "description": "shows the API schema of the specified component/s.",
4542
+ "extendedDescription": "you can use a `<pattern>` for multiple component ids, such as `bit schema \"org.scope/utils/**\"`.\nuse comma to separate patterns and '!' to exclude. e.g. 'ui/**, !ui/button'\nalways wrap the pattern with single quotes to avoid collision with shell commands.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.\n",
4543
+ "group": "development",
4544
+ "private": false
4545
+ },
4546
+ {
4547
+ "name": "check-types [component-pattern]",
4548
+ "alias": "",
4549
+ "options": [
4550
+ [
4551
+ "a",
4552
+ "all",
4553
+ "check-types for all components, not only modified and new"
4554
+ ],
4555
+ [
4556
+ "",
4557
+ "strict",
4558
+ "in case issues found, exit with code 1"
4559
+ ]
4560
+ ],
4561
+ "description": "check typescript types",
4562
+ "extendedDescription": "",
4563
+ "group": "development",
4564
+ "private": false,
4565
+ "arguments": [
4566
+ {
4567
+ "name": "component-pattern",
4568
+ "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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern."
4569
+ }
4570
+ ]
4571
+ },
4572
+ {
4573
+ "name": "write-tsconfig",
4574
+ "alias": "",
4575
+ "options": [
4576
+ [
4577
+ "c",
4578
+ "clean",
4579
+ "delete tsconfig files from the workspace. highly recommended to run it with \"--dry-run\" first"
4580
+ ],
4581
+ [
4582
+ "s",
4583
+ "silent",
4584
+ "do not prompt for confirmation"
4585
+ ],
4586
+ [
4587
+ "",
4588
+ "no-dedupe",
4589
+ "write tsconfig.json inside each one of the component's dir, avoid deduping"
4590
+ ],
4591
+ [
4592
+ "",
4593
+ "dry-run",
4594
+ "show the paths that tsconfig will be written per env"
4595
+ ],
4596
+ [
4597
+ "",
4598
+ "dry-run-with-tsconfig",
4599
+ "use with --json flag. show the tsconfig.json content and the paths it will be written per env"
4600
+ ],
4601
+ [
4602
+ "j",
4603
+ "json",
4604
+ "json format"
4605
+ ]
4606
+ ],
4607
+ "description": "DEPRECATED. use bit ws-config write instead",
4608
+ "extendedDescription": "",
4609
+ "group": "development",
4610
+ "private": true
4611
+ },
4733
4612
  {
4734
4613
  "name": "update-dependencies <data>",
4735
4614
  "alias": "",
@@ -4820,6 +4699,141 @@
4820
4699
  "group": "development",
4821
4700
  "private": true
4822
4701
  },
4702
+ {
4703
+ "name": "aspect <sub-command>",
4704
+ "alias": "",
4705
+ "options": [],
4706
+ "description": "manage aspects",
4707
+ "extendedDescription": "",
4708
+ "group": "development",
4709
+ "private": false,
4710
+ "commands": [
4711
+ {
4712
+ "name": "list [pattern]",
4713
+ "alias": "",
4714
+ "options": [
4715
+ [
4716
+ "d",
4717
+ "debug",
4718
+ "show the origins where the aspects were taken from"
4719
+ ]
4720
+ ],
4721
+ "description": "list all aspects configured on component(s)",
4722
+ "extendedDescription": "",
4723
+ "group": "development",
4724
+ "private": false,
4725
+ "arguments": [
4726
+ {
4727
+ "name": "pattern",
4728
+ "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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern."
4729
+ }
4730
+ ]
4731
+ },
4732
+ {
4733
+ "name": "get <component-name>",
4734
+ "alias": "",
4735
+ "options": [
4736
+ [
4737
+ "d",
4738
+ "debug",
4739
+ "show the origins where the aspects were taken from"
4740
+ ],
4741
+ [
4742
+ "j",
4743
+ "json",
4744
+ "format as json"
4745
+ ]
4746
+ ],
4747
+ "description": "list the aspects set on a component, as well as their configs and data",
4748
+ "extendedDescription": "",
4749
+ "group": "development",
4750
+ "private": false,
4751
+ "arguments": [
4752
+ {
4753
+ "name": "component-name",
4754
+ "description": "the component name or component id to fetch aspects for"
4755
+ }
4756
+ ]
4757
+ },
4758
+ {
4759
+ "name": "set <pattern> <aspect-id> [config]",
4760
+ "alias": "",
4761
+ "options": [
4762
+ [
4763
+ "m",
4764
+ "merge",
4765
+ "merge with an existing config if exits. (by default, it replaces overlapping existing configs)"
4766
+ ]
4767
+ ],
4768
+ "description": "set components with an aspect to extend their development tools, metadata and (possibly) artifacts",
4769
+ "extendedDescription": "",
4770
+ "group": "development",
4771
+ "private": false,
4772
+ "arguments": [
4773
+ {
4774
+ "name": "pattern",
4775
+ "description": "the components to extend. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern."
4776
+ },
4777
+ {
4778
+ "name": "aspect-id",
4779
+ "description": "the aspect's component id"
4780
+ },
4781
+ {
4782
+ "name": "config",
4783
+ "description": "the aspect config. enter the config as a stringified JSON (e.g. '{\"foo\":\"bar\"}' ). when no config is provided, an aspect is set with an empty config ({})."
4784
+ }
4785
+ ]
4786
+ },
4787
+ {
4788
+ "name": "unset <pattern> <aspect-id>",
4789
+ "alias": "",
4790
+ "options": [],
4791
+ "description": "unset an aspect from component(s).",
4792
+ "extendedDescription": "",
4793
+ "group": "development",
4794
+ "private": false,
4795
+ "arguments": [
4796
+ {
4797
+ "name": "pattern",
4798
+ "description": "the components to target. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern."
4799
+ },
4800
+ {
4801
+ "name": "aspect-id",
4802
+ "description": "the aspect's component id"
4803
+ }
4804
+ ]
4805
+ },
4806
+ {
4807
+ "name": "update <aspect-id> [pattern]",
4808
+ "alias": "",
4809
+ "options": [],
4810
+ "description": "update a version of an aspect for all or specified components",
4811
+ "extendedDescription": "",
4812
+ "group": "development",
4813
+ "private": false,
4814
+ "arguments": [
4815
+ {
4816
+ "name": "aspect-id",
4817
+ "description": "the aspect's component id. optionally, add a version (id@version), otherwise will use the latest version from the remote"
4818
+ },
4819
+ {
4820
+ "name": "pattern",
4821
+ "description": "the components to update (defaults to all components). 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern."
4822
+ }
4823
+ ],
4824
+ "examples": [
4825
+ {
4826
+ "cmd": "bit aspect update scope.org/aspect '**/ui/**'",
4827
+ "description": "update all components with the \"ui\" namespace that use scope.org/aspect, to use its latest version"
4828
+ },
4829
+ {
4830
+ "cmd": "bit aspect update scope.org/aspect@2.0.0",
4831
+ "description": "update version of scope.org/aspect to version 2.0.0 for all components configured with that aspect."
4832
+ }
4833
+ ]
4834
+ }
4835
+ ]
4836
+ },
4823
4837
  {
4824
4838
  "name": "format [component...]",
4825
4839
  "alias": "",
@@ -7458,7 +7458,22 @@ function MDXContent(_ref) {
7458
7458
  }), (0, _react2.mdx)("td", {
7459
7459
  parentName: "tr",
7460
7460
  "align": null
7461
- }, "local path to the workspace containing the template. Helpful during a development of a workspace-template")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "pattern"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
7461
+ }, "local path to the workspace containing the template. Helpful during a development of a workspace-template")), (0, _react2.mdx)("tr", {
7462
+ parentName: "tbody"
7463
+ }, (0, _react2.mdx)("td", {
7464
+ parentName: "tr",
7465
+ "align": null
7466
+ }, (0, _react2.mdx)("inlineCode", {
7467
+ parentName: "td"
7468
+ }, "--current-dir")), (0, _react2.mdx)("td", {
7469
+ parentName: "tr",
7470
+ "align": "center"
7471
+ }, (0, _react2.mdx)("inlineCode", {
7472
+ parentName: "td"
7473
+ }, "-c")), (0, _react2.mdx)("td", {
7474
+ parentName: "tr",
7475
+ "align": null
7476
+ }, "create the new workspace in current directory (default is to create a new directory, inside the current dir)")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "pattern"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
7462
7477
  parentName: "p"
7463
7478
  }, "Description"), ": list the component ids matching the given pattern", (0, _react2.mdx)("br", {
7464
7479
  parentName: "p"