@teambit/harmony.content.cli-reference 1.95.49 → 1.95.52

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.
@@ -223,26 +223,6 @@
223
223
  "group": "info",
224
224
  "private": false
225
225
  },
226
- {
227
- "name": "dependencies <component-name>",
228
- "alias": "",
229
- "options": [
230
- [
231
- "t",
232
- "tree",
233
- "render dependencies as a tree, similar to \"npm ls\""
234
- ],
235
- [
236
- "d",
237
- "debug",
238
- "show the immediate dependencies and how their version was determined"
239
- ]
240
- ],
241
- "description": "EXPERIMENTAL. show direct and indirect dependencies of the given component",
242
- "extendedDescription": "",
243
- "group": "info",
244
- "private": false
245
- },
246
226
  {
247
227
  "name": "_log <path> <args>",
248
228
  "alias": "",
@@ -1425,6 +1405,83 @@
1425
1405
  }
1426
1406
  ]
1427
1407
  },
1408
+ {
1409
+ "name": "dependencies <sub-command>",
1410
+ "alias": "deps",
1411
+ "options": [],
1412
+ "description": "manage dependencies",
1413
+ "extendedDescription": "",
1414
+ "group": "info",
1415
+ "private": false,
1416
+ "commands": [
1417
+ {
1418
+ "name": "get <component-name>",
1419
+ "alias": "",
1420
+ "options": [
1421
+ [
1422
+ "t",
1423
+ "tree",
1424
+ "EXPERIMENTAL. render dependencies as a tree, similar to \"npm ls\""
1425
+ ]
1426
+ ],
1427
+ "description": "show direct and indirect dependencies of the given component",
1428
+ "extendedDescription": "",
1429
+ "group": "info",
1430
+ "private": false,
1431
+ "arguments": [
1432
+ {
1433
+ "name": "component-name",
1434
+ "description": "component name or component id"
1435
+ }
1436
+ ]
1437
+ },
1438
+ {
1439
+ "name": "debug <component-name>",
1440
+ "alias": "",
1441
+ "options": [],
1442
+ "description": "show the immediate dependencies and how their versions were determined",
1443
+ "extendedDescription": "",
1444
+ "group": "info",
1445
+ "private": false,
1446
+ "arguments": [
1447
+ {
1448
+ "name": "component-name",
1449
+ "description": "component name or component id"
1450
+ }
1451
+ ]
1452
+ },
1453
+ {
1454
+ "name": "set <component-pattern> <package...>",
1455
+ "alias": "",
1456
+ "options": [
1457
+ [
1458
+ "d",
1459
+ "dev",
1460
+ "add to the devDependencies"
1461
+ ],
1462
+ [
1463
+ "p",
1464
+ "peer",
1465
+ "add to the peerDependencies"
1466
+ ]
1467
+ ],
1468
+ "description": "set a dependency to component(s)",
1469
+ "extendedDescription": "",
1470
+ "group": "info",
1471
+ "private": false,
1472
+ "arguments": [
1473
+ {
1474
+ "name": "component-pattern",
1475
+ "description": "component name, component id, or component pattern. use component pattern to select multiple components.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
1476
+ },
1477
+ {
1478
+ "name": "package",
1479
+ "description": "package name with version, e.g. \"lodash@1.0.0\""
1480
+ }
1481
+ ]
1482
+ }
1483
+ ]
1484
+ },
1428
1485
  {
1429
1486
  "name": "list [remote-scope]",
1430
1487
  "alias": "ls",
@@ -1800,7 +1857,7 @@
1800
1857
  "private": false
1801
1858
  },
1802
1859
  {
1803
- "name": "publish <componentId>",
1860
+ "name": "publish <component-pattern>",
1804
1861
  "alias": "",
1805
1862
  "options": [
1806
1863
  [
@@ -1822,7 +1879,13 @@
1822
1879
  "description": "publish components to npm (npm publish)",
1823
1880
  "extendedDescription": "",
1824
1881
  "group": "collaborate",
1825
- "private": true
1882
+ "private": true,
1883
+ "arguments": [
1884
+ {
1885
+ "name": "component-pattern",
1886
+ "description": "component name, component id, or component pattern. use component pattern to select multiple components.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
1887
+ }
1888
+ ]
1826
1889
  },
1827
1890
  {
1828
1891
  "name": "refactor <sub-command>",
@@ -2518,7 +2581,13 @@
2518
2581
  {
2519
2582
  "name": "set <pattern> <aspect-id> [config]",
2520
2583
  "alias": "",
2521
- "options": [],
2584
+ "options": [
2585
+ [
2586
+ "m",
2587
+ "merge",
2588
+ "merge with an existing config if exits. (by default, it replaces the config)"
2589
+ ]
2590
+ ],
2522
2591
  "description": "set components with an aspect to extend their development tools, metadata and (possibly) artifacts",
2523
2592
  "extendedDescription": "",
2524
2593
  "group": "development",
package/cli-reference.mdx CHANGED
@@ -107,6 +107,10 @@ and a package.tgz file generated by pkg aspect.
107
107
 
108
108
  **Description**: set components with an aspect to extend their development tools, metadata and (possibly) artifacts
109
109
 
110
+ | **Option** | **Option alias** | **Description** |
111
+ | ---------- | :--------------: | ---------------------------------------------------------------------------- |
112
+ | `--merge` | `-m` | merge with an existing config if exits. (by default, it replaces the config) |
113
+
110
114
  ### aspect unset
111
115
 
112
116
  **Usage**: `aspect unset <pattern> <aspect-id>`
@@ -369,15 +373,38 @@ https://bit.dev/docs/config/bit-config
369
373
 
370
374
  ## dependencies
371
375
 
376
+ **Alias**: `deps`
372
377
  **Workspace only**: yes
373
- **Description**: EXPERIMENTAL. show direct and indirect dependencies of the given component
378
+ **Description**: manage dependencies
379
+
380
+ `bit dependencies <sub-command>`
381
+
382
+ ### dependencies get
383
+
384
+ **Usage**: `dependencies get <component-name>`
385
+
386
+ **Description**: show direct and indirect dependencies of the given component
387
+
388
+ | **Option** | **Option alias** | **Description** |
389
+ | ---------- | :--------------: | ---------------------------------------------------------------- |
390
+ | `--tree` | `-t` | EXPERIMENTAL. render dependencies as a tree, similar to "npm ls" |
391
+
392
+ ### dependencies debug
393
+
394
+ **Usage**: `dependencies debug <component-name>`
395
+
396
+ **Description**: show the immediate dependencies and how their versions were determined
397
+
398
+ ### dependencies set
399
+
400
+ **Usage**: `dependencies set <component-pattern> <package...>`
374
401
 
375
- `bit dependencies <component-name>`
402
+ **Description**: set a dependency to component(s)
376
403
 
377
- | **Option** | **Option alias** | **Description** |
378
- | ---------- | :--------------: | -------------------------------------------------------------------- |
379
- | `--tree` | `-t` | render dependencies as a tree, similar to "npm ls" |
380
- | `--debug` | `-d` | show the immediate dependencies and how their version was determined |
404
+ | **Option** | **Option alias** | **Description** |
405
+ | ---------- | :--------------: | --------------------------- |
406
+ | `--dev` | `-d` | add to the devDependencies |
407
+ | `--peer` | `-p` | add to the peerDependencies |
381
408
 
382
409
  ---
383
410
 
@@ -223,26 +223,6 @@
223
223
  "group": "info",
224
224
  "private": false
225
225
  },
226
- {
227
- "name": "dependencies <component-name>",
228
- "alias": "",
229
- "options": [
230
- [
231
- "t",
232
- "tree",
233
- "render dependencies as a tree, similar to \"npm ls\""
234
- ],
235
- [
236
- "d",
237
- "debug",
238
- "show the immediate dependencies and how their version was determined"
239
- ]
240
- ],
241
- "description": "EXPERIMENTAL. show direct and indirect dependencies of the given component",
242
- "extendedDescription": "",
243
- "group": "info",
244
- "private": false
245
- },
246
226
  {
247
227
  "name": "_log <path> <args>",
248
228
  "alias": "",
@@ -1425,6 +1405,83 @@
1425
1405
  }
1426
1406
  ]
1427
1407
  },
1408
+ {
1409
+ "name": "dependencies <sub-command>",
1410
+ "alias": "deps",
1411
+ "options": [],
1412
+ "description": "manage dependencies",
1413
+ "extendedDescription": "",
1414
+ "group": "info",
1415
+ "private": false,
1416
+ "commands": [
1417
+ {
1418
+ "name": "get <component-name>",
1419
+ "alias": "",
1420
+ "options": [
1421
+ [
1422
+ "t",
1423
+ "tree",
1424
+ "EXPERIMENTAL. render dependencies as a tree, similar to \"npm ls\""
1425
+ ]
1426
+ ],
1427
+ "description": "show direct and indirect dependencies of the given component",
1428
+ "extendedDescription": "",
1429
+ "group": "info",
1430
+ "private": false,
1431
+ "arguments": [
1432
+ {
1433
+ "name": "component-name",
1434
+ "description": "component name or component id"
1435
+ }
1436
+ ]
1437
+ },
1438
+ {
1439
+ "name": "debug <component-name>",
1440
+ "alias": "",
1441
+ "options": [],
1442
+ "description": "show the immediate dependencies and how their versions were determined",
1443
+ "extendedDescription": "",
1444
+ "group": "info",
1445
+ "private": false,
1446
+ "arguments": [
1447
+ {
1448
+ "name": "component-name",
1449
+ "description": "component name or component id"
1450
+ }
1451
+ ]
1452
+ },
1453
+ {
1454
+ "name": "set <component-pattern> <package...>",
1455
+ "alias": "",
1456
+ "options": [
1457
+ [
1458
+ "d",
1459
+ "dev",
1460
+ "add to the devDependencies"
1461
+ ],
1462
+ [
1463
+ "p",
1464
+ "peer",
1465
+ "add to the peerDependencies"
1466
+ ]
1467
+ ],
1468
+ "description": "set a dependency to component(s)",
1469
+ "extendedDescription": "",
1470
+ "group": "info",
1471
+ "private": false,
1472
+ "arguments": [
1473
+ {
1474
+ "name": "component-pattern",
1475
+ "description": "component name, component id, or component pattern. use component pattern to select multiple components.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
1476
+ },
1477
+ {
1478
+ "name": "package",
1479
+ "description": "package name with version, e.g. \"lodash@1.0.0\""
1480
+ }
1481
+ ]
1482
+ }
1483
+ ]
1484
+ },
1428
1485
  {
1429
1486
  "name": "list [remote-scope]",
1430
1487
  "alias": "ls",
@@ -1800,7 +1857,7 @@
1800
1857
  "private": false
1801
1858
  },
1802
1859
  {
1803
- "name": "publish <componentId>",
1860
+ "name": "publish <component-pattern>",
1804
1861
  "alias": "",
1805
1862
  "options": [
1806
1863
  [
@@ -1822,7 +1879,13 @@
1822
1879
  "description": "publish components to npm (npm publish)",
1823
1880
  "extendedDescription": "",
1824
1881
  "group": "collaborate",
1825
- "private": true
1882
+ "private": true,
1883
+ "arguments": [
1884
+ {
1885
+ "name": "component-pattern",
1886
+ "description": "component name, component id, or component pattern. use component pattern to select multiple components.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
1887
+ }
1888
+ ]
1826
1889
  },
1827
1890
  {
1828
1891
  "name": "refactor <sub-command>",
@@ -2518,7 +2581,13 @@
2518
2581
  {
2519
2582
  "name": "set <pattern> <aspect-id> [config]",
2520
2583
  "alias": "",
2521
- "options": [],
2584
+ "options": [
2585
+ [
2586
+ "m",
2587
+ "merge",
2588
+ "merge with an existing config if exits. (by default, it replaces the config)"
2589
+ ]
2590
+ ],
2522
2591
  "description": "set components with an aspect to extend their development tools, metadata and (possibly) artifacts",
2523
2592
  "extendedDescription": "",
2524
2593
  "group": "development",
@@ -482,7 +482,43 @@ function MDXContent(_ref) {
482
482
  parentName: "p"
483
483
  }, "aspect set <pattern> <aspect-id> [config]")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
484
484
  parentName: "p"
485
- }, "Description"), ": set components with an aspect to extend their development tools, metadata and (possibly) artifacts"), (0, _react2.mdx)("h3", null, "aspect unset"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
485
+ }, "Description"), ": set components with an aspect to extend their development tools, metadata and (possibly) artifacts"), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
486
+ parentName: "table"
487
+ }, (0, _react2.mdx)("tr", {
488
+ parentName: "thead"
489
+ }, (0, _react2.mdx)("th", {
490
+ parentName: "tr",
491
+ "align": null
492
+ }, (0, _react2.mdx)("strong", {
493
+ parentName: "th"
494
+ }, "Option")), (0, _react2.mdx)("th", {
495
+ parentName: "tr",
496
+ "align": "center"
497
+ }, (0, _react2.mdx)("strong", {
498
+ parentName: "th"
499
+ }, "Option alias")), (0, _react2.mdx)("th", {
500
+ parentName: "tr",
501
+ "align": null
502
+ }, (0, _react2.mdx)("strong", {
503
+ parentName: "th"
504
+ }, "Description")))), (0, _react2.mdx)("tbody", {
505
+ parentName: "table"
506
+ }, (0, _react2.mdx)("tr", {
507
+ parentName: "tbody"
508
+ }, (0, _react2.mdx)("td", {
509
+ parentName: "tr",
510
+ "align": null
511
+ }, (0, _react2.mdx)("inlineCode", {
512
+ parentName: "td"
513
+ }, "--merge")), (0, _react2.mdx)("td", {
514
+ parentName: "tr",
515
+ "align": "center"
516
+ }, (0, _react2.mdx)("inlineCode", {
517
+ parentName: "td"
518
+ }, "-m")), (0, _react2.mdx)("td", {
519
+ parentName: "tr",
520
+ "align": null
521
+ }, "merge with an existing config if exits. (by default, it replaces the config)")))), (0, _react2.mdx)("h3", null, "aspect unset"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
486
522
  parentName: "p"
487
523
  }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
488
524
  parentName: "p"
@@ -1581,13 +1617,25 @@ function MDXContent(_ref) {
1581
1617
  "align": null
1582
1618
  }, "set the component's environment. (overrides the env from variants and the template)")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "dependencies"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
1583
1619
  parentName: "p"
1620
+ }, "Alias"), ": ", (0, _react2.mdx)("inlineCode", {
1621
+ parentName: "p"
1622
+ }, "deps"), (0, _react2.mdx)("br", {
1623
+ parentName: "p"
1624
+ }), "\n", (0, _react2.mdx)("strong", {
1625
+ parentName: "p"
1584
1626
  }, "Workspace only"), ": yes", (0, _react2.mdx)("br", {
1585
1627
  parentName: "p"
1586
1628
  }), "\n", (0, _react2.mdx)("strong", {
1587
1629
  parentName: "p"
1588
- }, "Description"), ": EXPERIMENTAL. show direct and indirect dependencies of the given component"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
1630
+ }, "Description"), ": manage dependencies"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
1589
1631
  parentName: "p"
1590
- }, "bit dependencies <component-name>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
1632
+ }, "bit dependencies <sub-command>")), (0, _react2.mdx)("h3", null, "dependencies get"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
1633
+ parentName: "p"
1634
+ }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
1635
+ parentName: "p"
1636
+ }, "dependencies get <component-name>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
1637
+ parentName: "p"
1638
+ }, "Description"), ": show direct and indirect dependencies of the given component"), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
1591
1639
  parentName: "table"
1592
1640
  }, (0, _react2.mdx)("tr", {
1593
1641
  parentName: "thead"
@@ -1623,14 +1671,47 @@ function MDXContent(_ref) {
1623
1671
  }, "-t")), (0, _react2.mdx)("td", {
1624
1672
  parentName: "tr",
1625
1673
  "align": null
1626
- }, "render dependencies as a tree, similar to \"npm ls\"")), (0, _react2.mdx)("tr", {
1674
+ }, "EXPERIMENTAL. render dependencies as a tree, similar to \"npm ls\"")))), (0, _react2.mdx)("h3", null, "dependencies debug"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
1675
+ parentName: "p"
1676
+ }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
1677
+ parentName: "p"
1678
+ }, "dependencies debug <component-name>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
1679
+ parentName: "p"
1680
+ }, "Description"), ": show the immediate dependencies and how their versions were determined"), (0, _react2.mdx)("h3", null, "dependencies set"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
1681
+ parentName: "p"
1682
+ }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
1683
+ parentName: "p"
1684
+ }, "dependencies set <component-pattern> <package...>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
1685
+ parentName: "p"
1686
+ }, "Description"), ": set a dependency to component(s)"), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
1687
+ parentName: "table"
1688
+ }, (0, _react2.mdx)("tr", {
1689
+ parentName: "thead"
1690
+ }, (0, _react2.mdx)("th", {
1691
+ parentName: "tr",
1692
+ "align": null
1693
+ }, (0, _react2.mdx)("strong", {
1694
+ parentName: "th"
1695
+ }, "Option")), (0, _react2.mdx)("th", {
1696
+ parentName: "tr",
1697
+ "align": "center"
1698
+ }, (0, _react2.mdx)("strong", {
1699
+ parentName: "th"
1700
+ }, "Option alias")), (0, _react2.mdx)("th", {
1701
+ parentName: "tr",
1702
+ "align": null
1703
+ }, (0, _react2.mdx)("strong", {
1704
+ parentName: "th"
1705
+ }, "Description")))), (0, _react2.mdx)("tbody", {
1706
+ parentName: "table"
1707
+ }, (0, _react2.mdx)("tr", {
1627
1708
  parentName: "tbody"
1628
1709
  }, (0, _react2.mdx)("td", {
1629
1710
  parentName: "tr",
1630
1711
  "align": null
1631
1712
  }, (0, _react2.mdx)("inlineCode", {
1632
1713
  parentName: "td"
1633
- }, "--debug")), (0, _react2.mdx)("td", {
1714
+ }, "--dev")), (0, _react2.mdx)("td", {
1634
1715
  parentName: "tr",
1635
1716
  "align": "center"
1636
1717
  }, (0, _react2.mdx)("inlineCode", {
@@ -1638,7 +1719,22 @@ function MDXContent(_ref) {
1638
1719
  }, "-d")), (0, _react2.mdx)("td", {
1639
1720
  parentName: "tr",
1640
1721
  "align": null
1641
- }, "show the immediate dependencies and how their version was determined")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "dependents"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
1722
+ }, "add to the devDependencies")), (0, _react2.mdx)("tr", {
1723
+ parentName: "tbody"
1724
+ }, (0, _react2.mdx)("td", {
1725
+ parentName: "tr",
1726
+ "align": null
1727
+ }, (0, _react2.mdx)("inlineCode", {
1728
+ parentName: "td"
1729
+ }, "--peer")), (0, _react2.mdx)("td", {
1730
+ parentName: "tr",
1731
+ "align": "center"
1732
+ }, (0, _react2.mdx)("inlineCode", {
1733
+ parentName: "td"
1734
+ }, "-p")), (0, _react2.mdx)("td", {
1735
+ parentName: "tr",
1736
+ "align": null
1737
+ }, "add to the peerDependencies")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "dependents"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
1642
1738
  parentName: "p"
1643
1739
  }, "Workspace only"), ": yes", (0, _react2.mdx)("br", {
1644
1740
  parentName: "p"