@teambit/harmony.content.cli-reference 2.0.109 → 2.0.110

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.
Files changed (9) hide show
  1. package/cli-reference.docs.mdx +1 -1
  2. package/cli-reference.json +250 -230
  3. package/cli-reference.mdx +2 -0
  4. package/dist/cli-reference.docs.mdx +1 -1
  5. package/dist/cli-reference.json +250 -230
  6. package/dist/cli-reference.mdx.js +26 -0
  7. package/dist/cli-reference.mdx.js.map +1 -1
  8. package/dist/{preview-1703214934003.js → preview-1703301327107.js} +2 -2
  9. package/package.json +2 -2
package/dist/cli-reference.json CHANGED
@@ -1333,6 +1333,235 @@
1333
1333
  }
1334
1334
  ]
1335
1335
  },
1336
+ {
1337
+ "name": "deps <sub-command>",
1338
+ "alias": "dependencies",
1339
+ "options": [],
1340
+ "description": "manage dependencies",
1341
+ "extendedDescription": "",
1342
+ "group": "info",
1343
+ "private": false,
1344
+ "commands": [
1345
+ {
1346
+ "name": "get <component-name>",
1347
+ "alias": "",
1348
+ "options": [
1349
+ [
1350
+ "t",
1351
+ "tree",
1352
+ "EXPERIMENTAL. render dependencies as a tree, similar to \"npm ls\""
1353
+ ]
1354
+ ],
1355
+ "description": "show direct and indirect dependencies of the given component",
1356
+ "extendedDescription": "",
1357
+ "group": "info",
1358
+ "private": false,
1359
+ "arguments": [
1360
+ {
1361
+ "name": "component-name",
1362
+ "description": "component name or component id"
1363
+ }
1364
+ ]
1365
+ },
1366
+ {
1367
+ "name": "remove <component-pattern> <package...>",
1368
+ "alias": "",
1369
+ "options": [
1370
+ [
1371
+ "d",
1372
+ "dev",
1373
+ "remove from devDependencies"
1374
+ ],
1375
+ [
1376
+ "p",
1377
+ "peer",
1378
+ "remove from peerDependencies"
1379
+ ]
1380
+ ],
1381
+ "description": "remove a dependency to component(s)",
1382
+ "extendedDescription": "",
1383
+ "group": "info",
1384
+ "private": false,
1385
+ "arguments": [
1386
+ {
1387
+ "name": "component-pattern",
1388
+ "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."
1389
+ },
1390
+ {
1391
+ "name": "package...",
1392
+ "description": "package name with or without a version, e.g. \"lodash@1.0.0\" or just \"lodash\" which will remove all lodash instances of any version"
1393
+ }
1394
+ ]
1395
+ },
1396
+ {
1397
+ "name": "unset <component-pattern> <package...>",
1398
+ "alias": "",
1399
+ "options": [
1400
+ [
1401
+ "d",
1402
+ "dev",
1403
+ "unset from devDependencies"
1404
+ ],
1405
+ [
1406
+ "p",
1407
+ "peer",
1408
+ "unset from peerDependencies"
1409
+ ]
1410
+ ],
1411
+ "description": "unset a dependency to component(s) that was previously set by \"bit deps set\"",
1412
+ "extendedDescription": "",
1413
+ "group": "info",
1414
+ "private": false,
1415
+ "arguments": [
1416
+ {
1417
+ "name": "component-pattern",
1418
+ "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."
1419
+ },
1420
+ {
1421
+ "name": "package...",
1422
+ "description": "package name with or without a version, e.g. \"lodash@1.0.0\" or just \"lodash\" which will remove all lodash instances of any version"
1423
+ }
1424
+ ]
1425
+ },
1426
+ {
1427
+ "name": "debug <component-name>",
1428
+ "alias": "",
1429
+ "options": [],
1430
+ "description": "show the immediate dependencies and how their versions were determined",
1431
+ "extendedDescription": "",
1432
+ "group": "info",
1433
+ "private": false,
1434
+ "arguments": [
1435
+ {
1436
+ "name": "component-name",
1437
+ "description": "component name or component id"
1438
+ }
1439
+ ]
1440
+ },
1441
+ {
1442
+ "name": "set <component-pattern> <package...>",
1443
+ "alias": "",
1444
+ "options": [
1445
+ [
1446
+ "d",
1447
+ "dev",
1448
+ "add to the devDependencies"
1449
+ ],
1450
+ [
1451
+ "o",
1452
+ "optional",
1453
+ "add to the optionalDependencies"
1454
+ ],
1455
+ [
1456
+ "p",
1457
+ "peer",
1458
+ "add to the peerDependencies"
1459
+ ]
1460
+ ],
1461
+ "description": "set a dependency to component(s)",
1462
+ "extendedDescription": "",
1463
+ "group": "info",
1464
+ "private": false,
1465
+ "arguments": [
1466
+ {
1467
+ "name": "component-pattern",
1468
+ "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."
1469
+ },
1470
+ {
1471
+ "name": "package...",
1472
+ "description": "package name with or without a version, e.g. \"lodash@1.0.0\" or just \"lodash\" which will be resolved to the latest"
1473
+ }
1474
+ ]
1475
+ },
1476
+ {
1477
+ "name": "reset <component-pattern>",
1478
+ "alias": "",
1479
+ "options": [],
1480
+ "description": "reset dependencies to the default values (revert any previously \"bit deps set\")",
1481
+ "extendedDescription": "",
1482
+ "group": "info",
1483
+ "private": false,
1484
+ "arguments": [
1485
+ {
1486
+ "name": "component-pattern",
1487
+ "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."
1488
+ }
1489
+ ]
1490
+ },
1491
+ {
1492
+ "name": "eject <component-pattern>",
1493
+ "alias": "",
1494
+ "options": [],
1495
+ "description": "write dependencies that were previously set via \"bit deps set\" into .bitmap",
1496
+ "extendedDescription": "",
1497
+ "group": "info",
1498
+ "private": false,
1499
+ "arguments": [
1500
+ {
1501
+ "name": "component-pattern",
1502
+ "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."
1503
+ }
1504
+ ]
1505
+ },
1506
+ {
1507
+ "name": "blame <component-name> <dependency-name>",
1508
+ "alias": "",
1509
+ "options": [],
1510
+ "description": "EXPERIMENTAL. find out which snap/tag changed a dependency version",
1511
+ "extendedDescription": "",
1512
+ "group": "info",
1513
+ "private": false,
1514
+ "arguments": [
1515
+ {
1516
+ "name": "dependency-name",
1517
+ "description": "package-name. for components, you can use either component-id or package-name"
1518
+ }
1519
+ ]
1520
+ },
1521
+ {
1522
+ "name": "usage <dependency-name>",
1523
+ "alias": "",
1524
+ "options": [
1525
+ [
1526
+ "",
1527
+ "depth <number>",
1528
+ "max display depth of the dependency graph"
1529
+ ]
1530
+ ],
1531
+ "description": "EXPERIMENTAL. find components that use the specified dependency",
1532
+ "extendedDescription": "",
1533
+ "group": "info",
1534
+ "private": false,
1535
+ "arguments": [
1536
+ {
1537
+ "name": "dependency-name",
1538
+ "description": "package-name. for components, you can use either component-id or package-name. if version is specified, it will search for the exact version"
1539
+ }
1540
+ ]
1541
+ }
1542
+ ]
1543
+ },
1544
+ {
1545
+ "name": "why <dependency-name>",
1546
+ "alias": "",
1547
+ "options": [
1548
+ [
1549
+ "",
1550
+ "depth <number>",
1551
+ "max display depth of the dependency graph"
1552
+ ]
1553
+ ],
1554
+ "description": "EXPERIMENTAL. find components that use the specified dependency",
1555
+ "extendedDescription": "",
1556
+ "group": "info",
1557
+ "private": false,
1558
+ "arguments": [
1559
+ {
1560
+ "name": "dependency-name",
1561
+ "description": "package-name. for components, you can use either component-id or package-name. if version is specified, it will search for the exact version"
1562
+ }
1563
+ ]
1564
+ },
1336
1565
  {
1337
1566
  "name": "ws-config <sub-command>",
1338
1567
  "alias": "workspace-config",
@@ -2579,6 +2808,11 @@
2579
2808
  "ignore-build-errors",
2580
2809
  "proceed to tag pipeline even when build pipeline fails"
2581
2810
  ],
2811
+ [
2812
+ "",
2813
+ "rebuild-deps-graph",
2814
+ "do not reuse the saved dependencies graph, instead build it from scratch"
2815
+ ],
2582
2816
  [
2583
2817
  "",
2584
2818
  "increment-by <number>",
@@ -2697,6 +2931,11 @@
2697
2931
  "ignore-build-errors",
2698
2932
  "proceed to snap pipeline even when build pipeline fails"
2699
2933
  ],
2934
+ [
2935
+ "",
2936
+ "rebuild-deps-graph",
2937
+ "do not reuse the saved dependencies graph, instead build it from scratch"
2938
+ ],
2700
2939
  [
2701
2940
  "i",
2702
2941
  "ignore-issues [issues]",
@@ -2843,6 +3082,11 @@
2843
3082
  "ignore-build-errors",
2844
3083
  "run the tag pipeline although the build pipeline failed"
2845
3084
  ],
3085
+ [
3086
+ "",
3087
+ "rebuild-deps-graph",
3088
+ "do not reuse the saved dependencies graph, instead build it from scratch"
3089
+ ],
2846
3090
  [
2847
3091
  "",
2848
3092
  "increment-by <number>",
@@ -2909,6 +3153,11 @@
2909
3153
  "ignore-build-errors",
2910
3154
  "run the snap pipeline although the build pipeline failed"
2911
3155
  ],
3156
+ [
3157
+ "",
3158
+ "rebuild-deps-graph",
3159
+ "do not reuse the saved dependencies graph, instead build it from scratch"
3160
+ ],
2912
3161
  [
2913
3162
  "i",
2914
3163
  "ignore-issues [issues]",
@@ -2921,7 +3170,7 @@
2921
3170
  ]
2922
3171
  ],
2923
3172
  "description": "snap components from a bare-scope",
2924
- "extendedDescription": "this command should be running from a new bare scope, it first imports the components it needs and then processes the snap.\nthe input data is a stringified JSON of an array of the following object.\n{\n componentId: string; // ids always have scope, so it's safe to parse them from string\n dependencies?: string[]; // e.g. [teambit/compiler@1.0.0, teambit/tester@1.0.0]\n aspects?: Record<string,any> // e.g. { \"teambit.react/react\": {}, \"teambit.envs/envs\": { \"env\": \"teambit.react/react\" } }\n message?: string; // tag-message.\n files?: Array<{path: string, content: string}>; // replace content of specified source-files. the content is base64 encoded.\n}\nan example of the final data: '[{\"componentId\":\"ci.remote2/comp-b\",\"message\": \"first snap\"}]'\n",
3173
+ "extendedDescription": "this command should be running from a new bare scope, it first imports the components it needs and then processes the snap.\nthe input data is a stringified JSON of an array of the following object.\n{\n componentId: string; // ids always have scope, so it's safe to parse them from string\n dependencies?: string[]; // dependencies to update their versions, e.g. [teambit/compiler@1.0.0, teambit/tester@1.0.0]\n aspects?: Record<string,any> // e.g. { \"teambit.react/react\": {}, \"teambit.envs/envs\": { \"env\": \"teambit.react/react\" } }\n message?: string; // tag-message.\n files?: Array<{path: string, content: string}>; // replace content of specified source-files. the content is base64 encoded.\n isNew?: boolean; // if it's new, it'll be generated from the given files. otherwise, it'll be fetched from the scope and updated.\n mainFile?: string; // relevant when isNew is true. default to \"index.ts\".\n newDependencies?: Array<{ // new dependencies (components and packages) to add.\n id: string; // component-id or package-name. e.g. \"teambit.react/react\" or \"lodash\".\n version?: string; // version of the package. e.g. \"2.0.3\". for packages, it is mandatory.\n isComponent?: boolean; // default true. if false, it's a package dependency\n type?: 'runtime' | 'dev' | 'peer'; // default \"runtime\".\n }>;\n}\nan example of the final data: '[{\"componentId\":\"ci.remote2/comp-b\",\"message\": \"first snap\"}]'\n",
2925
3174
  "group": "ungrouped",
2926
3175
  "private": true
2927
3176
  },
@@ -3912,235 +4161,6 @@
3912
4161
  }
3913
4162
  ]
3914
4163
  },
3915
- {
3916
- "name": "deps <sub-command>",
3917
- "alias": "dependencies",
3918
- "options": [],
3919
- "description": "manage dependencies",
3920
- "extendedDescription": "",
3921
- "group": "info",
3922
- "private": false,
3923
- "commands": [
3924
- {
3925
- "name": "get <component-name>",
3926
- "alias": "",
3927
- "options": [
3928
- [
3929
- "t",
3930
- "tree",
3931
- "EXPERIMENTAL. render dependencies as a tree, similar to \"npm ls\""
3932
- ]
3933
- ],
3934
- "description": "show direct and indirect dependencies of the given component",
3935
- "extendedDescription": "",
3936
- "group": "info",
3937
- "private": false,
3938
- "arguments": [
3939
- {
3940
- "name": "component-name",
3941
- "description": "component name or component id"
3942
- }
3943
- ]
3944
- },
3945
- {
3946
- "name": "remove <component-pattern> <package...>",
3947
- "alias": "",
3948
- "options": [
3949
- [
3950
- "d",
3951
- "dev",
3952
- "remove from devDependencies"
3953
- ],
3954
- [
3955
- "p",
3956
- "peer",
3957
- "remove from peerDependencies"
3958
- ]
3959
- ],
3960
- "description": "remove a dependency to component(s)",
3961
- "extendedDescription": "",
3962
- "group": "info",
3963
- "private": false,
3964
- "arguments": [
3965
- {
3966
- "name": "component-pattern",
3967
- "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."
3968
- },
3969
- {
3970
- "name": "package...",
3971
- "description": "package name with or without a version, e.g. \"lodash@1.0.0\" or just \"lodash\" which will remove all lodash instances of any version"
3972
- }
3973
- ]
3974
- },
3975
- {
3976
- "name": "unset <component-pattern> <package...>",
3977
- "alias": "",
3978
- "options": [
3979
- [
3980
- "d",
3981
- "dev",
3982
- "unset from devDependencies"
3983
- ],
3984
- [
3985
- "p",
3986
- "peer",
3987
- "unset from peerDependencies"
3988
- ]
3989
- ],
3990
- "description": "unset a dependency to component(s) that was previously set by \"bit deps set\"",
3991
- "extendedDescription": "",
3992
- "group": "info",
3993
- "private": false,
3994
- "arguments": [
3995
- {
3996
- "name": "component-pattern",
3997
- "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."
3998
- },
3999
- {
4000
- "name": "package...",
4001
- "description": "package name with or without a version, e.g. \"lodash@1.0.0\" or just \"lodash\" which will remove all lodash instances of any version"
4002
- }
4003
- ]
4004
- },
4005
- {
4006
- "name": "debug <component-name>",
4007
- "alias": "",
4008
- "options": [],
4009
- "description": "show the immediate dependencies and how their versions were determined",
4010
- "extendedDescription": "",
4011
- "group": "info",
4012
- "private": false,
4013
- "arguments": [
4014
- {
4015
- "name": "component-name",
4016
- "description": "component name or component id"
4017
- }
4018
- ]
4019
- },
4020
- {
4021
- "name": "set <component-pattern> <package...>",
4022
- "alias": "",
4023
- "options": [
4024
- [
4025
- "d",
4026
- "dev",
4027
- "add to the devDependencies"
4028
- ],
4029
- [
4030
- "o",
4031
- "optional",
4032
- "add to the optionalDependencies"
4033
- ],
4034
- [
4035
- "p",
4036
- "peer",
4037
- "add to the peerDependencies"
4038
- ]
4039
- ],
4040
- "description": "set a dependency to component(s)",
4041
- "extendedDescription": "",
4042
- "group": "info",
4043
- "private": false,
4044
- "arguments": [
4045
- {
4046
- "name": "component-pattern",
4047
- "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."
4048
- },
4049
- {
4050
- "name": "package...",
4051
- "description": "package name with or without a version, e.g. \"lodash@1.0.0\" or just \"lodash\" which will be resolved to the latest"
4052
- }
4053
- ]
4054
- },
4055
- {
4056
- "name": "reset <component-pattern>",
4057
- "alias": "",
4058
- "options": [],
4059
- "description": "reset dependencies to the default values (revert any previously \"bit deps set\")",
4060
- "extendedDescription": "",
4061
- "group": "info",
4062
- "private": false,
4063
- "arguments": [
4064
- {
4065
- "name": "component-pattern",
4066
- "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."
4067
- }
4068
- ]
4069
- },
4070
- {
4071
- "name": "eject <component-pattern>",
4072
- "alias": "",
4073
- "options": [],
4074
- "description": "write dependencies that were previously set via \"bit deps set\" into .bitmap",
4075
- "extendedDescription": "",
4076
- "group": "info",
4077
- "private": false,
4078
- "arguments": [
4079
- {
4080
- "name": "component-pattern",
4081
- "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."
4082
- }
4083
- ]
4084
- },
4085
- {
4086
- "name": "blame <component-name> <dependency-name>",
4087
- "alias": "",
4088
- "options": [],
4089
- "description": "EXPERIMENTAL. find out which snap/tag changed a dependency version",
4090
- "extendedDescription": "",
4091
- "group": "info",
4092
- "private": false,
4093
- "arguments": [
4094
- {
4095
- "name": "dependency-name",
4096
- "description": "package-name. for components, you can use either component-id or package-name"
4097
- }
4098
- ]
4099
- },
4100
- {
4101
- "name": "usage <dependency-name>",
4102
- "alias": "",
4103
- "options": [
4104
- [
4105
- "",
4106
- "depth <number>",
4107
- "max display depth of the dependency graph"
4108
- ]
4109
- ],
4110
- "description": "EXPERIMENTAL. find components that use the specified dependency",
4111
- "extendedDescription": "",
4112
- "group": "info",
4113
- "private": false,
4114
- "arguments": [
4115
- {
4116
- "name": "dependency-name",
4117
- "description": "package-name. for components, you can use either component-id or package-name. if version is specified, it will search for the exact version"
4118
- }
4119
- ]
4120
- }
4121
- ]
4122
- },
4123
- {
4124
- "name": "why <dependency-name>",
4125
- "alias": "",
4126
- "options": [
4127
- [
4128
- "",
4129
- "depth <number>",
4130
- "max display depth of the dependency graph"
4131
- ]
4132
- ],
4133
- "description": "EXPERIMENTAL. find components that use the specified dependency",
4134
- "extendedDescription": "",
4135
- "group": "info",
4136
- "private": false,
4137
- "arguments": [
4138
- {
4139
- "name": "dependency-name",
4140
- "description": "package-name. for components, you can use either component-id or package-name. if version is specified, it will search for the exact version"
4141
- }
4142
- ]
4143
- },
4144
4164
  {
4145
4165
  "name": "list [remote-scope]",
4146
4166
  "alias": "ls",
package/dist/cli-reference.mdx.js CHANGED
@@ -9131,6 +9131,19 @@ function MDXContent(_ref) {
9131
9131
  "align": null
9132
9132
  }, (0, _react2.mdx)("inlineCode", {
9133
9133
  parentName: "td"
9134
+ }, "--rebuild-deps-graph")), (0, _react2.mdx)("td", {
9135
+ parentName: "tr",
9136
+ "align": "center"
9137
+ }), (0, _react2.mdx)("td", {
9138
+ parentName: "tr",
9139
+ "align": null
9140
+ }, "do not reuse the saved dependencies graph, instead build it from scratch")), (0, _react2.mdx)("tr", {
9141
+ parentName: "tbody"
9142
+ }, (0, _react2.mdx)("td", {
9143
+ parentName: "tr",
9144
+ "align": null
9145
+ }, (0, _react2.mdx)("inlineCode", {
9146
+ parentName: "td"
9134
9147
  }, "--ignore-issues [issues]")), (0, _react2.mdx)("td", {
9135
9148
  parentName: "tr",
9136
9149
  "align": "center"
@@ -9805,6 +9818,19 @@ function MDXContent(_ref) {
9805
9818
  "align": null
9806
9819
  }, (0, _react2.mdx)("inlineCode", {
9807
9820
  parentName: "td"
9821
+ }, "--rebuild-deps-graph")), (0, _react2.mdx)("td", {
9822
+ parentName: "tr",
9823
+ "align": "center"
9824
+ }), (0, _react2.mdx)("td", {
9825
+ parentName: "tr",
9826
+ "align": null
9827
+ }, "do not reuse the saved dependencies graph, instead build it from scratch")), (0, _react2.mdx)("tr", {
9828
+ parentName: "tbody"
9829
+ }, (0, _react2.mdx)("td", {
9830
+ parentName: "tr",
9831
+ "align": null
9832
+ }, (0, _react2.mdx)("inlineCode", {
9833
+ parentName: "td"
9808
9834
  }, "--increment-by <number>")), (0, _react2.mdx)("td", {
9809
9835
  parentName: "tr",
9810
9836
  "align": "center"