@teambit/harmony.content.cli-reference 1.95.30 → 1.95.31

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.json +32 -20
  2. package/cli-reference.mdx +50 -35
  3. package/dist/cli-reference.json +32 -20
  4. package/dist/cli-reference.mdx.js +92 -37
  5. package/dist/cli-reference.mdx.js.map +1 -1
  6. package/package-tar/teambit-harmony.content.cli-reference-1.95.31.tgz +0 -0
  7. package/package.json +2 -2
  8. package/{preview-1655263660719.js → preview-1655436530187.js} +2 -2
  9. package/package-tar/teambit-harmony.content.cli-reference-1.95.30.tgz +0 -0
package/dist/cli-reference.mdx.js CHANGED
@@ -336,13 +336,17 @@ function MDXContent(_ref) {
336
336
  parentName: "p"
337
337
  }, "<pattern>"), " for multiple component ids, such as ", (0, _react2.mdx)("inlineCode", {
338
338
  parentName: "p"
339
- }, "bit aspect list \"org.scope/utils/**\""), ". use comma to separate patterns and \"!\" to exclude. e.g. \"ui/", "*", "*", ", !ui/button\"", (0, _react2.mdx)("br", {
339
+ }, "bit aspect list \"org.scope/utils/**\""), ".", (0, _react2.mdx)("br", {
340
+ parentName: "p"
341
+ }), "\n", "use comma to separate patterns and \"!\" to exclude. e.g. \"ui/", "*", "*", ", !ui/button\"", (0, _react2.mdx)("br", {
340
342
  parentName: "p"
341
343
  }), "\n", "always wrap the pattern with quotes to avoid collision with shell commands.", (0, _react2.mdx)("br", {
342
344
  parentName: "p"
343
- }), "\n", "to validate the pattern before running this command, run ", (0, _react2.mdx)("inlineCode", {
345
+ }), "\n", "use ", (0, _react2.mdx)("inlineCode", {
346
+ parentName: "p"
347
+ }, "bit pattern --help"), " to understand patterns better and ", (0, _react2.mdx)("inlineCode", {
344
348
  parentName: "p"
345
- }, "bit pattern <pattern>"), "."), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
349
+ }, "bit pattern <pattern>"), " to validate the pattern."), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
346
350
  parentName: "table"
347
351
  }, (0, _react2.mdx)("tr", {
348
352
  parentName: "thead"
@@ -451,13 +455,17 @@ function MDXContent(_ref) {
451
455
  parentName: "p"
452
456
  }, "<pattern>"), " for multiple component ids, such as ", (0, _react2.mdx)("inlineCode", {
453
457
  parentName: "p"
454
- }, "bit aspect set \"org.scope/utils/**\""), ". use comma to separate patterns and \"!\" to exclude. e.g. \"ui/", "*", "*", ", !ui/button\"", (0, _react2.mdx)("br", {
458
+ }, "bit aspect set \"org.scope/utils/**\""), ".", (0, _react2.mdx)("br", {
459
+ parentName: "p"
460
+ }), "\n", "use comma to separate patterns and \"!\" to exclude. e.g. \"ui/", "*", "*", ", !ui/button\"", (0, _react2.mdx)("br", {
455
461
  parentName: "p"
456
462
  }), "\n", "always wrap the pattern with quotes to avoid collision with shell commands.", (0, _react2.mdx)("br", {
457
463
  parentName: "p"
458
- }), "\n", "to validate the pattern before running this command, run ", (0, _react2.mdx)("inlineCode", {
464
+ }), "\n", "use ", (0, _react2.mdx)("inlineCode", {
465
+ parentName: "p"
466
+ }, "bit pattern --help"), " to understand patterns better and ", (0, _react2.mdx)("inlineCode", {
459
467
  parentName: "p"
460
- }, "bit pattern <pattern>"), "."), (0, _react2.mdx)("h3", null, "aspect unset"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
468
+ }, "bit pattern <pattern>"), " to validate the pattern."), (0, _react2.mdx)("h3", null, "aspect unset"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
461
469
  parentName: "p"
462
470
  }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
463
471
  parentName: "p"
@@ -469,13 +477,17 @@ function MDXContent(_ref) {
469
477
  parentName: "p"
470
478
  }, "<pattern>"), " for multiple component ids, such as ", (0, _react2.mdx)("inlineCode", {
471
479
  parentName: "p"
472
- }, "bit aspect unset \"org.scope/utils/**\""), ". use comma to separate patterns and \"!\" to exclude. e.g. \"ui/", "*", "*", ", !ui/button\"", (0, _react2.mdx)("br", {
480
+ }, "bit aspect unset \"org.scope/utils/**\""), ".", (0, _react2.mdx)("br", {
481
+ parentName: "p"
482
+ }), "\n", "use comma to separate patterns and \"!\" to exclude. e.g. \"ui/", "*", "*", ", !ui/button\"", (0, _react2.mdx)("br", {
473
483
  parentName: "p"
474
484
  }), "\n", "always wrap the pattern with quotes to avoid collision with shell commands.", (0, _react2.mdx)("br", {
475
485
  parentName: "p"
476
- }), "\n", "to validate the pattern before running this command, run ", (0, _react2.mdx)("inlineCode", {
486
+ }), "\n", "use ", (0, _react2.mdx)("inlineCode", {
487
+ parentName: "p"
488
+ }, "bit pattern --help"), " to understand patterns better and ", (0, _react2.mdx)("inlineCode", {
477
489
  parentName: "p"
478
- }, "bit pattern <pattern>"), "."), (0, _react2.mdx)("h3", null, "aspect update"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
490
+ }, "bit pattern <pattern>"), " to validate the pattern."), (0, _react2.mdx)("h3", null, "aspect update"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
479
491
  parentName: "p"
480
492
  }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
481
493
  parentName: "p"
@@ -489,13 +501,17 @@ function MDXContent(_ref) {
489
501
  parentName: "p"
490
502
  }, "<pattern>"), " for multiple component ids, such as ", (0, _react2.mdx)("inlineCode", {
491
503
  parentName: "p"
492
- }, "bit aspect update <aspect-id> \"org.scope/utils/**\""), ". use comma to separate patterns and \"!\" to exclude. e.g. \"ui/", "*", "*", ", !ui/button\"", (0, _react2.mdx)("br", {
504
+ }, "bit aspect update <aspect-id> \"org.scope/utils/**\""), ".", (0, _react2.mdx)("br", {
505
+ parentName: "p"
506
+ }), "\n", "use comma to separate patterns and \"!\" to exclude. e.g. \"ui/", "*", "*", ", !ui/button\"", (0, _react2.mdx)("br", {
493
507
  parentName: "p"
494
508
  }), "\n", "always wrap the pattern with quotes to avoid collision with shell commands.", (0, _react2.mdx)("br", {
495
509
  parentName: "p"
496
- }), "\n", "to validate the pattern before running this command, run ", (0, _react2.mdx)("inlineCode", {
510
+ }), "\n", "use ", (0, _react2.mdx)("inlineCode", {
497
511
  parentName: "p"
498
- }, "bit pattern <pattern>"), "."), (0, _react2.mdx)("p", null, "examples:", (0, _react2.mdx)("br", {
512
+ }, "bit pattern --help"), " to understand patterns better and ", (0, _react2.mdx)("inlineCode", {
513
+ parentName: "p"
514
+ }, "bit pattern <pattern>"), " to validate the pattern."), (0, _react2.mdx)("p", null, "examples:", (0, _react2.mdx)("br", {
499
515
  parentName: "p"
500
516
  }), "\n", "\"bit aspect update scope.org/aspect '", (0, _react2.mdx)("strong", {
501
517
  parentName: "p"
@@ -512,7 +528,7 @@ function MDXContent(_ref) {
512
528
  parentName: "p"
513
529
  }, "Description"), ": run set of tasks for build"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
514
530
  parentName: "p"
515
- }, "bit build [pattern]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
531
+ }, "bit build [component-pattern]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
516
532
  parentName: "table"
517
533
  }, (0, _react2.mdx)("tr", {
518
534
  parentName: "thead"
@@ -909,7 +925,7 @@ function MDXContent(_ref) {
909
925
  parentName: "p"
910
926
  }, "Description"), ": check typescript types"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
911
927
  parentName: "p"
912
- }, "bit check-types [pattern]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
928
+ }, "bit check-types [component-pattern]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
913
929
  parentName: "table"
914
930
  }, (0, _react2.mdx)("tr", {
915
931
  parentName: "thead"
@@ -1848,13 +1864,17 @@ function MDXContent(_ref) {
1848
1864
  parentName: "p"
1849
1865
  }, "<pattern>"), " for multiple component ids, such as ", (0, _react2.mdx)("inlineCode", {
1850
1866
  parentName: "p"
1851
- }, "bit eject \"org.scope/utils/**\""), ". use comma to separate patterns and \"!\" to exclude. e.g. \"ui/", "*", "*", ", !ui/button\"", (0, _react2.mdx)("br", {
1867
+ }, "bit eject \"org.scope/utils/**\""), ".", (0, _react2.mdx)("br", {
1868
+ parentName: "p"
1869
+ }), "\n", "use comma to separate patterns and \"!\" to exclude. e.g. \"ui/", "*", "*", ", !ui/button\"", (0, _react2.mdx)("br", {
1852
1870
  parentName: "p"
1853
1871
  }), "\n", "always wrap the pattern with quotes to avoid collision with shell commands.", (0, _react2.mdx)("br", {
1854
1872
  parentName: "p"
1855
- }), "\n", "to validate the pattern before running this command, run ", (0, _react2.mdx)("inlineCode", {
1873
+ }), "\n", "use ", (0, _react2.mdx)("inlineCode", {
1856
1874
  parentName: "p"
1857
- }, "bit pattern <pattern>"), "."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
1875
+ }, "bit pattern --help"), " to understand patterns better and ", (0, _react2.mdx)("inlineCode", {
1876
+ parentName: "p"
1877
+ }, "bit pattern <pattern>"), " to validate the pattern."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
1858
1878
  parentName: "p"
1859
1879
  }, "bit eject <pattern>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
1860
1880
  parentName: "table"
@@ -1934,13 +1954,17 @@ function MDXContent(_ref) {
1934
1954
  parentName: "p"
1935
1955
  }, "<pattern>"), " for multiple component ids, such as ", (0, _react2.mdx)("inlineCode", {
1936
1956
  parentName: "p"
1937
- }, "bit eject-conf \"org.scope/utils/**\""), ". use comma to separate patterns and \"!\" to exclude. e.g. \"ui/", "*", "*", ", !ui/button\"", (0, _react2.mdx)("br", {
1957
+ }, "bit eject-conf \"org.scope/utils/**\""), ".", (0, _react2.mdx)("br", {
1958
+ parentName: "p"
1959
+ }), "\n", "use comma to separate patterns and \"!\" to exclude. e.g. \"ui/", "*", "*", ", !ui/button\"", (0, _react2.mdx)("br", {
1938
1960
  parentName: "p"
1939
1961
  }), "\n", "always wrap the pattern with quotes to avoid collision with shell commands.", (0, _react2.mdx)("br", {
1940
1962
  parentName: "p"
1941
- }), "\n", "to validate the pattern before running this command, run ", (0, _react2.mdx)("inlineCode", {
1963
+ }), "\n", "use ", (0, _react2.mdx)("inlineCode", {
1942
1964
  parentName: "p"
1943
- }, "bit pattern <pattern>"), "."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
1965
+ }, "bit pattern --help"), " to understand patterns better and ", (0, _react2.mdx)("inlineCode", {
1966
+ parentName: "p"
1967
+ }, "bit pattern <pattern>"), " to validate the pattern."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
1944
1968
  parentName: "p"
1945
1969
  }, "bit eject-conf <pattern>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
1946
1970
  parentName: "table"
@@ -2043,13 +2067,17 @@ function MDXContent(_ref) {
2043
2067
  parentName: "p"
2044
2068
  }, "<pattern>"), " for multiple component ids, such as ", (0, _react2.mdx)("inlineCode", {
2045
2069
  parentName: "p"
2046
- }, "bit env unset \"org.scope/utils/**\""), ". use comma to separate patterns and \"!\" to exclude. e.g. \"ui/", "*", "*", ", !ui/button\"", (0, _react2.mdx)("br", {
2070
+ }, "bit env unset \"org.scope/utils/**\""), ".", (0, _react2.mdx)("br", {
2071
+ parentName: "p"
2072
+ }), "\n", "use comma to separate patterns and \"!\" to exclude. e.g. \"ui/", "*", "*", ", !ui/button\"", (0, _react2.mdx)("br", {
2047
2073
  parentName: "p"
2048
2074
  }), "\n", "always wrap the pattern with quotes to avoid collision with shell commands.", (0, _react2.mdx)("br", {
2049
2075
  parentName: "p"
2050
- }), "\n", "to validate the pattern before running this command, run ", (0, _react2.mdx)("inlineCode", {
2076
+ }), "\n", "use ", (0, _react2.mdx)("inlineCode", {
2077
+ parentName: "p"
2078
+ }, "bit pattern --help"), " to understand patterns better and ", (0, _react2.mdx)("inlineCode", {
2051
2079
  parentName: "p"
2052
- }, "bit pattern <pattern>"), "."), (0, _react2.mdx)("h3", null, "envs replace"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2080
+ }, "bit pattern <pattern>"), " to validate the pattern."), (0, _react2.mdx)("h3", null, "envs replace"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2053
2081
  parentName: "p"
2054
2082
  }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
2055
2083
  parentName: "p"
@@ -4055,7 +4083,28 @@ function MDXContent(_ref) {
4055
4083
  parentName: "p"
4056
4084
  }), "\n", (0, _react2.mdx)("strong", {
4057
4085
  parentName: "p"
4058
- }, "Description"), ": list the component ids matching the given pattern"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
4086
+ }, "Description"), ": list the component ids matching the given pattern", (0, _react2.mdx)("br", {
4087
+ parentName: "p"
4088
+ }), "\n", "this command helps validating a pattern before using it in other commands.", (0, _react2.mdx)("br", {
4089
+ parentName: "p"
4090
+ }), "\n", "a pattern can be a simple component-id or component-name. e.g. \"ui/button\".", (0, _react2.mdx)("br", {
4091
+ parentName: "p"
4092
+ }), "\n", "a pattern can be used with wildcards for multiple component ids, e.g. \"org.scope/utils/", (0, _react2.mdx)("strong", {
4093
+ parentName: "p"
4094
+ }, "\".", (0, _react2.mdx)("br", {
4095
+ parentName: "strong"
4096
+ }), "to enter multiple patterns, separate them by a comma, e.g. \"ui/", (0, _react2.mdx)("em", {
4097
+ parentName: "strong"
4098
+ }, ", lib/"), "\"", (0, _react2.mdx)("br", {
4099
+ parentName: "strong"
4100
+ }), "to exclude, use \"!\". e.g. \"ui/"), ", !ui/button\"", (0, _react2.mdx)("br", {
4101
+ parentName: "p"
4102
+ }), "\n", "always wrap the pattern with quotes to avoid collision with shell commands.", (0, _react2.mdx)("br", {
4103
+ parentName: "p"
4104
+ }), "\n", "the matching algorithm is done by multimatch (@see ", (0, _react2.mdx)("a", {
4105
+ parentName: "p",
4106
+ "href": "https://github.com/sindresorhus/multimatch"
4107
+ }, "https://github.com/sindresorhus/multimatch"), ")"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
4059
4108
  parentName: "p"
4060
4109
  }, "bit pattern <pattern>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
4061
4110
  parentName: "table"
@@ -4552,13 +4601,17 @@ function MDXContent(_ref) {
4552
4601
  parentName: "p"
4553
4602
  }, "<pattern>"), " for multiple component ids, such as ", (0, _react2.mdx)("inlineCode", {
4554
4603
  parentName: "p"
4555
- }, "bit schema \"org.scope/utils/**\""), ". use comma to separate patterns and \"!\" to exclude. e.g. \"ui/", "*", "*", ", !ui/button\"", (0, _react2.mdx)("br", {
4604
+ }, "bit schema \"org.scope/utils/**\""), ".", (0, _react2.mdx)("br", {
4605
+ parentName: "p"
4606
+ }), "\n", "use comma to separate patterns and \"!\" to exclude. e.g. \"ui/", "*", "*", ", !ui/button\"", (0, _react2.mdx)("br", {
4556
4607
  parentName: "p"
4557
4608
  }), "\n", "always wrap the pattern with quotes to avoid collision with shell commands.", (0, _react2.mdx)("br", {
4558
4609
  parentName: "p"
4559
- }), "\n", "to validate the pattern before running this command, run ", (0, _react2.mdx)("inlineCode", {
4610
+ }), "\n", "use ", (0, _react2.mdx)("inlineCode", {
4611
+ parentName: "p"
4612
+ }, "bit pattern --help"), " to understand patterns better and ", (0, _react2.mdx)("inlineCode", {
4560
4613
  parentName: "p"
4561
- }, "bit pattern <pattern>"), "."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
4614
+ }, "bit pattern <pattern>"), " to validate the pattern."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
4562
4615
  parentName: "p"
4563
4616
  }, "bit schema <pattern>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
4564
4617
  parentName: "table"
@@ -4616,13 +4669,17 @@ function MDXContent(_ref) {
4616
4669
  parentName: "p"
4617
4670
  }, "<pattern>"), " for multiple component ids, such as ", (0, _react2.mdx)("inlineCode", {
4618
4671
  parentName: "p"
4619
- }, "bit scope set scope-name \"org.scope/utils/**\""), ". use comma to separate patterns and \"!\" to exclude. e.g. \"ui/", "*", "*", ", !ui/button\"", (0, _react2.mdx)("br", {
4672
+ }, "bit scope set scope-name \"org.scope/utils/**\""), ".", (0, _react2.mdx)("br", {
4673
+ parentName: "p"
4674
+ }), "\n", "use comma to separate patterns and \"!\" to exclude. e.g. \"ui/", "*", "*", ", !ui/button\"", (0, _react2.mdx)("br", {
4620
4675
  parentName: "p"
4621
4676
  }), "\n", "always wrap the pattern with quotes to avoid collision with shell commands.", (0, _react2.mdx)("br", {
4622
4677
  parentName: "p"
4623
- }), "\n", "to validate the pattern before running this command, run ", (0, _react2.mdx)("inlineCode", {
4678
+ }), "\n", "use ", (0, _react2.mdx)("inlineCode", {
4679
+ parentName: "p"
4680
+ }, "bit pattern --help"), " to understand patterns better and ", (0, _react2.mdx)("inlineCode", {
4624
4681
  parentName: "p"
4625
- }, "bit pattern <pattern>"), "."), (0, _react2.mdx)("h3", null, "scope rename"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
4682
+ }, "bit pattern <pattern>"), " to validate the pattern."), (0, _react2.mdx)("h3", null, "scope rename"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
4626
4683
  parentName: "p"
4627
4684
  }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
4628
4685
  parentName: "p"
@@ -4989,9 +5046,9 @@ function MDXContent(_ref) {
4989
5046
  parentName: "p"
4990
5047
  }, "Description"), ": create an immutable and exportable component snapshot, tagged with a release version.", (0, _react2.mdx)("br", {
4991
5048
  parentName: "p"
4992
- }), "\n", "if no ids are provided, it will tag all new and modified components.", (0, _react2.mdx)("br", {
5049
+ }), "\n", "if no patterns are provided, it will tag all new and modified components.", (0, _react2.mdx)("br", {
4993
5050
  parentName: "p"
4994
- }), "\n", "if component ids are entered, you can specify a version per id using \"@\" sign, e.g. bit tag ", (0, _react2.mdx)("a", {
5051
+ }), "\n", "if patterns are entered, you can specify a version per pattern using \"@\" sign, e.g. bit tag ", (0, _react2.mdx)("a", {
4995
5052
  parentName: "p",
4996
5053
  "href": "mailto:foo@1.0.0"
4997
5054
  }, "foo@1.0.0"), " bar@minor baz@major", (0, _react2.mdx)("br", {
@@ -4999,11 +5056,9 @@ function MDXContent(_ref) {
4999
5056
  }), "\n", (0, _react2.mdx)("a", {
5000
5057
  parentName: "p",
5001
5058
  "href": "https://bit.dev/components/tags"
5002
- }, "https://bit.dev/components/tags"), (0, _react2.mdx)("br", {
5003
- parentName: "p"
5004
- }), "\n", "you can use a pattern for multiple ids, such as bit tag \"utils/", "*", "\". (wrap the pattern with quotes to avoid collision with shell commands)"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
5059
+ }, "https://bit.dev/components/tags")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
5005
5060
  parentName: "p"
5006
- }, "bit tag [component-names...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
5061
+ }, "bit tag [patterns...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
5007
5062
  parentName: "table"
5008
5063
  }, (0, _react2.mdx)("tr", {
5009
5064
  parentName: "thead"
@@ -5485,7 +5540,7 @@ function MDXContent(_ref) {
5485
5540
  }, "-s")), (0, _react2.mdx)("td", {
5486
5541
  parentName: "tr",
5487
5542
  "align": null
5488
- }, "name of the scope to test")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "ui-build"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
5543
+ }, "DEPRECATED. (use the pattern instead, e.g. \"scopeName/", "*", "*", "\"). name of the scope to test")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "ui-build"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
5489
5544
  parentName: "p"
5490
5545
  }, "Alias"), ": ", (0, _react2.mdx)("inlineCode", {
5491
5546
  parentName: "p"