@teambit/harmony.content.cli-reference 1.95.33 → 1.95.36

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.
@@ -222,6 +222,11 @@
222
222
  "name": "dependencies <id>",
223
223
  "alias": "",
224
224
  "options": [
225
+ [
226
+ "t",
227
+ "tree",
228
+ "render dependencies as a tree, similar to \"npm ls\""
229
+ ],
225
230
  [
226
231
  "d",
227
232
  "debug",
@@ -1798,7 +1803,7 @@
1798
1803
  ]
1799
1804
  },
1800
1805
  {
1801
- "name": "artifacts <pattern...>",
1806
+ "name": "artifacts <component-pattern>",
1802
1807
  "alias": "",
1803
1808
  "options": [
1804
1809
  [
@@ -1825,7 +1830,13 @@
1825
1830
  "description": "EXPERIMENTAL. list and download components artifacts",
1826
1831
  "extendedDescription": "artifacts are created on isolated capsules during tag or snap commands.\nexample of artifacts are dists files generated by a compiler, a JUnit.xml file generated by a tester\nand a package.tgz file generated by pkg aspect.\n",
1827
1832
  "group": "development",
1828
- "private": false
1833
+ "private": false,
1834
+ "arguments": [
1835
+ {
1836
+ "name": "component-pattern",
1837
+ "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"
1838
+ }
1839
+ ]
1829
1840
  },
1830
1841
  {
1831
1842
  "name": "pack <componentId> [scopePath]",
@@ -1993,13 +2004,13 @@
1993
2004
  ],
1994
2005
  [
1995
2006
  "",
1996
- "snapped",
1997
- "EXPERIMENTAL. tag components that their head is a snap (not a tag)"
2007
+ "pre-release [identifier]",
2008
+ "syntactic sugar for \"--increment prerelease\" and `--prerelease-id <identifier>`"
1998
2009
  ],
1999
2010
  [
2000
2011
  "",
2001
- "pre-release [identifier]",
2002
- "DEPRECATED. use \"-l prerelease\" (and --prerelease-id) instead"
2012
+ "snapped",
2013
+ "EXPERIMENTAL. tag components that their head is a snap (not a tag)"
2003
2014
  ],
2004
2015
  [
2005
2016
  "",
@@ -3117,7 +3128,7 @@
3117
3128
  "remoteOp": true
3118
3129
  },
3119
3130
  {
3120
- "name": "export [remote] [component-names...]",
3131
+ "name": "export [component-names...]",
3121
3132
  "alias": "e",
3122
3133
  "options": [
3123
3134
  [
@@ -3130,26 +3141,6 @@
3130
3141
  "all",
3131
3142
  "export all components, including non-staged"
3132
3143
  ],
3133
- [
3134
- "d",
3135
- "include-dependencies",
3136
- "LEGACY ONLY. include the component's dependencies as part of the export to the remote scope"
3137
- ],
3138
- [
3139
- "s",
3140
- "set-current-scope",
3141
- "LEGACY ONLY. ensure the component's remote scope is set according to the target location"
3142
- ],
3143
- [
3144
- "r",
3145
- "rewire",
3146
- "LEGACY ONLY. when exporting to a different or new scope, replace import/require statements in the source code to match the new scope"
3147
- ],
3148
- [
3149
- "f",
3150
- "force",
3151
- "force changing a component remote without asking for a confirmation"
3152
- ],
3153
3144
  [
3154
3145
  "",
3155
3146
  "all-versions",
@@ -3182,10 +3173,6 @@
3182
3173
  "private": false,
3183
3174
  "remoteOp": true,
3184
3175
  "arguments": [
3185
- {
3186
- "name": "remote",
3187
- "description": "LEGACY ONLY."
3188
- },
3189
3176
  {
3190
3177
  "name": "component-names...",
3191
3178
  "description": "a list of component names or component IDs (separated by space). By default, all new component versions are exported."
package/cli-reference.mdx CHANGED
@@ -51,7 +51,7 @@ artifacts are created on isolated capsules during tag or snap commands.
51
51
  example of artifacts are dists files generated by a compiler, a JUnit.xml file generated by a tester
52
52
  and a package.tgz file generated by pkg aspect.
53
53
 
54
- `bit artifacts <pattern...>`
54
+ `bit artifacts <component-pattern>`
55
55
 
56
56
  | **Option** | **Option alias** | **Description** |
57
57
  | ---------------------- | :--------------: | -------------------------------------------------------------------------------------------------------- |
@@ -365,6 +365,7 @@ https://bit.dev/docs/config/bit-config
365
365
 
366
366
  | **Option** | **Option alias** | **Description** |
367
367
  | ---------- | :--------------: | -------------------------------------------------------------------- |
368
+ | `--tree` | `-t` | render dependencies as a tree, similar to "npm ls" |
368
369
  | `--debug` | `-d` | show the immediate dependencies and how their version was determined |
369
370
 
370
371
  ---
@@ -518,16 +519,12 @@ bit export => export all staged components to their current scope, if checked ou
518
519
  https://bit.dev/docs/components/exporting-components
519
520
  you can use a pattern for multiple ids, such as bit export remote-scope "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
520
521
 
521
- `bit export [remote] [component-names...]`
522
+ `bit export [component-names...]`
522
523
 
523
524
  | **Option** | **Option alias** | **Description** |
524
525
  | ---------------------------- | :--------------: | --------------------------------------------------------------------------------------------------------------------------------------- |
525
526
  | `--eject` | `-e` | replace the exported components with their corresponding packages (to use these components without further maintaining them) |
526
527
  | `--all` | `-a` | export all components, including non-staged |
527
- | `--include-dependencies` | `-d` | LEGACY ONLY. include the component's dependencies as part of the export to the remote scope |
528
- | `--set-current-scope` | `-s` | LEGACY ONLY. ensure the component's remote scope is set according to the target location |
529
- | `--rewire` | `-r` | LEGACY ONLY. when exporting to a different or new scope, replace import/require statements in the source code to match the new scope |
530
- | `--force` | `-f` | force changing a component remote without asking for a confirmation |
531
528
  | `--all-versions` | | export not only staged versions but all of them |
532
529
  | `--origin-directly` | | EXPERIMENTAL. avoid export to the central hub, instead, export directly to the original scopes. not recommended! |
533
530
  | `--resume <string>` | | in case the previous export failed and suggested to resume with an export-id, enter the id |
@@ -1131,8 +1128,8 @@ https://bit.dev/components/tags
1131
1128
  | `--patch` | `-p` | syntactic sugar for "--increment patch" |
1132
1129
  | `--minor` | | syntactic sugar for "--increment minor" |
1133
1130
  | `--major` | | syntactic sugar for "--increment major" |
1131
+ | `--pre-release [identifier]` | | syntactic sugar for "--increment prerelease" and `--prerelease-id <identifier>` |
1134
1132
  | `--snapped` | | EXPERIMENTAL. tag components that their head is a snap (not a tag) |
1135
- | `--pre-release [identifier]` | | DEPRECATED. use "-l prerelease" (and --prerelease-id) instead |
1136
1133
  | `--skip-tests` | | skip running component tests during tag process |
1137
1134
  | `--skip-auto-tag` | | skip auto tagging dependents |
1138
1135
  | `--soft` | | do not persist. only keep note of the changes to be made |
@@ -222,6 +222,11 @@
222
222
  "name": "dependencies <id>",
223
223
  "alias": "",
224
224
  "options": [
225
+ [
226
+ "t",
227
+ "tree",
228
+ "render dependencies as a tree, similar to \"npm ls\""
229
+ ],
225
230
  [
226
231
  "d",
227
232
  "debug",
@@ -1798,7 +1803,7 @@
1798
1803
  ]
1799
1804
  },
1800
1805
  {
1801
- "name": "artifacts <pattern...>",
1806
+ "name": "artifacts <component-pattern>",
1802
1807
  "alias": "",
1803
1808
  "options": [
1804
1809
  [
@@ -1825,7 +1830,13 @@
1825
1830
  "description": "EXPERIMENTAL. list and download components artifacts",
1826
1831
  "extendedDescription": "artifacts are created on isolated capsules during tag or snap commands.\nexample of artifacts are dists files generated by a compiler, a JUnit.xml file generated by a tester\nand a package.tgz file generated by pkg aspect.\n",
1827
1832
  "group": "development",
1828
- "private": false
1833
+ "private": false,
1834
+ "arguments": [
1835
+ {
1836
+ "name": "component-pattern",
1837
+ "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"
1838
+ }
1839
+ ]
1829
1840
  },
1830
1841
  {
1831
1842
  "name": "pack <componentId> [scopePath]",
@@ -1993,13 +2004,13 @@
1993
2004
  ],
1994
2005
  [
1995
2006
  "",
1996
- "snapped",
1997
- "EXPERIMENTAL. tag components that their head is a snap (not a tag)"
2007
+ "pre-release [identifier]",
2008
+ "syntactic sugar for \"--increment prerelease\" and `--prerelease-id <identifier>`"
1998
2009
  ],
1999
2010
  [
2000
2011
  "",
2001
- "pre-release [identifier]",
2002
- "DEPRECATED. use \"-l prerelease\" (and --prerelease-id) instead"
2012
+ "snapped",
2013
+ "EXPERIMENTAL. tag components that their head is a snap (not a tag)"
2003
2014
  ],
2004
2015
  [
2005
2016
  "",
@@ -3117,7 +3128,7 @@
3117
3128
  "remoteOp": true
3118
3129
  },
3119
3130
  {
3120
- "name": "export [remote] [component-names...]",
3131
+ "name": "export [component-names...]",
3121
3132
  "alias": "e",
3122
3133
  "options": [
3123
3134
  [
@@ -3130,26 +3141,6 @@
3130
3141
  "all",
3131
3142
  "export all components, including non-staged"
3132
3143
  ],
3133
- [
3134
- "d",
3135
- "include-dependencies",
3136
- "LEGACY ONLY. include the component's dependencies as part of the export to the remote scope"
3137
- ],
3138
- [
3139
- "s",
3140
- "set-current-scope",
3141
- "LEGACY ONLY. ensure the component's remote scope is set according to the target location"
3142
- ],
3143
- [
3144
- "r",
3145
- "rewire",
3146
- "LEGACY ONLY. when exporting to a different or new scope, replace import/require statements in the source code to match the new scope"
3147
- ],
3148
- [
3149
- "f",
3150
- "force",
3151
- "force changing a component remote without asking for a confirmation"
3152
- ],
3153
3144
  [
3154
3145
  "",
3155
3146
  "all-versions",
@@ -3182,10 +3173,6 @@
3182
3173
  "private": false,
3183
3174
  "remoteOp": true,
3184
3175
  "arguments": [
3185
- {
3186
- "name": "remote",
3187
- "description": "LEGACY ONLY."
3188
- },
3189
3176
  {
3190
3177
  "name": "component-names...",
3191
3178
  "description": "a list of component names or component IDs (separated by space). By default, all new component versions are exported."
@@ -243,7 +243,7 @@ function MDXContent(_ref) {
243
243
  parentName: "p"
244
244
  }), "\n", "and a package.tgz file generated by pkg aspect."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
245
245
  parentName: "p"
246
- }, "bit artifacts <pattern...>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
246
+ }, "bit artifacts <component-pattern>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
247
247
  parentName: "table"
248
248
  }, (0, _react2.mdx)("tr", {
249
249
  parentName: "thead"
@@ -1562,6 +1562,21 @@ function MDXContent(_ref) {
1562
1562
  "align": null
1563
1563
  }, (0, _react2.mdx)("inlineCode", {
1564
1564
  parentName: "td"
1565
+ }, "--tree")), (0, _react2.mdx)("td", {
1566
+ parentName: "tr",
1567
+ "align": "center"
1568
+ }, (0, _react2.mdx)("inlineCode", {
1569
+ parentName: "td"
1570
+ }, "-t")), (0, _react2.mdx)("td", {
1571
+ parentName: "tr",
1572
+ "align": null
1573
+ }, "render dependencies as a tree, similar to \"npm ls\"")), (0, _react2.mdx)("tr", {
1574
+ parentName: "tbody"
1575
+ }, (0, _react2.mdx)("td", {
1576
+ parentName: "tr",
1577
+ "align": null
1578
+ }, (0, _react2.mdx)("inlineCode", {
1579
+ parentName: "td"
1565
1580
  }, "--debug")), (0, _react2.mdx)("td", {
1566
1581
  parentName: "tr",
1567
1582
  "align": "center"
@@ -2013,7 +2028,7 @@ function MDXContent(_ref) {
2013
2028
  parentName: "p"
2014
2029
  }), "\n", "you can use a pattern for multiple ids, such as bit export remote-scope \"utils/", "*", "\". (wrap the pattern with quotes to avoid collision with shell commands)"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
2015
2030
  parentName: "p"
2016
- }, "bit export [remote] [component-names...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
2031
+ }, "bit export [component-names...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
2017
2032
  parentName: "table"
2018
2033
  }, (0, _react2.mdx)("tr", {
2019
2034
  parentName: "thead"
@@ -2071,66 +2086,6 @@ function MDXContent(_ref) {
2071
2086
  "align": null
2072
2087
  }, (0, _react2.mdx)("inlineCode", {
2073
2088
  parentName: "td"
2074
- }, "--include-dependencies")), (0, _react2.mdx)("td", {
2075
- parentName: "tr",
2076
- "align": "center"
2077
- }, (0, _react2.mdx)("inlineCode", {
2078
- parentName: "td"
2079
- }, "-d")), (0, _react2.mdx)("td", {
2080
- parentName: "tr",
2081
- "align": null
2082
- }, "LEGACY ONLY. include the component's dependencies as part of the export to the remote scope")), (0, _react2.mdx)("tr", {
2083
- parentName: "tbody"
2084
- }, (0, _react2.mdx)("td", {
2085
- parentName: "tr",
2086
- "align": null
2087
- }, (0, _react2.mdx)("inlineCode", {
2088
- parentName: "td"
2089
- }, "--set-current-scope")), (0, _react2.mdx)("td", {
2090
- parentName: "tr",
2091
- "align": "center"
2092
- }, (0, _react2.mdx)("inlineCode", {
2093
- parentName: "td"
2094
- }, "-s")), (0, _react2.mdx)("td", {
2095
- parentName: "tr",
2096
- "align": null
2097
- }, "LEGACY ONLY. ensure the component's remote scope is set according to the target location")), (0, _react2.mdx)("tr", {
2098
- parentName: "tbody"
2099
- }, (0, _react2.mdx)("td", {
2100
- parentName: "tr",
2101
- "align": null
2102
- }, (0, _react2.mdx)("inlineCode", {
2103
- parentName: "td"
2104
- }, "--rewire")), (0, _react2.mdx)("td", {
2105
- parentName: "tr",
2106
- "align": "center"
2107
- }, (0, _react2.mdx)("inlineCode", {
2108
- parentName: "td"
2109
- }, "-r")), (0, _react2.mdx)("td", {
2110
- parentName: "tr",
2111
- "align": null
2112
- }, "LEGACY ONLY. when exporting to a different or new scope, replace import/require statements in the source code to match the new scope")), (0, _react2.mdx)("tr", {
2113
- parentName: "tbody"
2114
- }, (0, _react2.mdx)("td", {
2115
- parentName: "tr",
2116
- "align": null
2117
- }, (0, _react2.mdx)("inlineCode", {
2118
- parentName: "td"
2119
- }, "--force")), (0, _react2.mdx)("td", {
2120
- parentName: "tr",
2121
- "align": "center"
2122
- }, (0, _react2.mdx)("inlineCode", {
2123
- parentName: "td"
2124
- }, "-f")), (0, _react2.mdx)("td", {
2125
- parentName: "tr",
2126
- "align": null
2127
- }, "force changing a component remote without asking for a confirmation")), (0, _react2.mdx)("tr", {
2128
- parentName: "tbody"
2129
- }, (0, _react2.mdx)("td", {
2130
- parentName: "tr",
2131
- "align": null
2132
- }, (0, _react2.mdx)("inlineCode", {
2133
- parentName: "td"
2134
2089
  }, "--all-versions")), (0, _react2.mdx)("td", {
2135
2090
  parentName: "tr",
2136
2091
  "align": "center"
@@ -5080,26 +5035,28 @@ function MDXContent(_ref) {
5080
5035
  "align": null
5081
5036
  }, (0, _react2.mdx)("inlineCode", {
5082
5037
  parentName: "td"
5083
- }, "--snapped")), (0, _react2.mdx)("td", {
5038
+ }, "--pre-release [identifier]")), (0, _react2.mdx)("td", {
5084
5039
  parentName: "tr",
5085
5040
  "align": "center"
5086
5041
  }), (0, _react2.mdx)("td", {
5087
5042
  parentName: "tr",
5088
5043
  "align": null
5089
- }, "EXPERIMENTAL. tag components that their head is a snap (not a tag)")), (0, _react2.mdx)("tr", {
5044
+ }, "syntactic sugar for \"--increment prerelease\" and ", (0, _react2.mdx)("inlineCode", {
5045
+ parentName: "td"
5046
+ }, "--prerelease-id <identifier>"))), (0, _react2.mdx)("tr", {
5090
5047
  parentName: "tbody"
5091
5048
  }, (0, _react2.mdx)("td", {
5092
5049
  parentName: "tr",
5093
5050
  "align": null
5094
5051
  }, (0, _react2.mdx)("inlineCode", {
5095
5052
  parentName: "td"
5096
- }, "--pre-release [identifier]")), (0, _react2.mdx)("td", {
5053
+ }, "--snapped")), (0, _react2.mdx)("td", {
5097
5054
  parentName: "tr",
5098
5055
  "align": "center"
5099
5056
  }), (0, _react2.mdx)("td", {
5100
5057
  parentName: "tr",
5101
5058
  "align": null
5102
- }, "DEPRECATED. use \"-l prerelease\" (and --prerelease-id) instead")), (0, _react2.mdx)("tr", {
5059
+ }, "EXPERIMENTAL. tag components that their head is a snap (not a tag)")), (0, _react2.mdx)("tr", {
5103
5060
  parentName: "tbody"
5104
5061
  }, (0, _react2.mdx)("td", {
5105
5062
  parentName: "tr",