@teambit/harmony.content.cli-reference 1.95.17 → 1.95.20

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.
package/cli-reference.mdx CHANGED
@@ -553,6 +553,7 @@ you can use a pattern for multiple ids, such as bit export remote-scope "utils/\
553
553
  | `--origin-directly` | | HARMONY ONLY. avoid export to the central hub, instead, export directly to the original scopes. not recommended! |
554
554
  | `--resume <string>` | | in case the previous export failed and suggested to resume with an export-id, enter the id |
555
555
  | `--ignore-missing-artifacts` | | EXPERIMENTAL. don't throw an error when artifact files are missing. not recommended, unless you're sure the artifacts are in the remote |
556
+ | `--json` | `-j` | show output in json format |
556
557
 
557
558
  ---
558
559
 
@@ -947,7 +948,8 @@ Legacy support [file, ssh]. Harmony supports [file, http].
947
948
  | ---------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------------- |
948
949
  | `--remote` | `-r` | remove a component from a remote scope |
949
950
  | `--track` | `-t` | keep tracking component (default = false) |
950
- | `--delete-files` | `-d` | delete local component files (authored components only. for imported components the files are always deleted) |
951
+ | `--delete-files` | `-d` | DEPRECATED (this is now the default). delete local component files |
952
+ | `--keep-files` | | keep component files (just untrack the component) |
951
953
  | `--force` | `-f` | removes the component from the scope, even if used as a dependency. WARNING: components that depend on this component will corrupt |
952
954
  | `--silent` | `-s` | skip confirmation |
953
955
 
@@ -1010,6 +1012,25 @@ alternatively, exporting to any one of the failed scopes, throws server-is-busy
1010
1012
 
1011
1013
  ---
1012
1014
 
1015
+ ## scope
1016
+
1017
+ **Workspace only**: yes
1018
+ **Description**: EXPERIMENTAL. manage scope-name
1019
+
1020
+ `bit scope <sub-command>`
1021
+
1022
+ ### scope rename
1023
+
1024
+ **Usage**: `scope rename <old-name> <new-name>`
1025
+
1026
+ **Description**: rename a scope for components using the old-name, optionally change the dependencies source-code
1027
+
1028
+ | **Option** | **Option alias** | **Description** |
1029
+ | ------------ | :--------------: | ---------------------------------------------------------------------------------------------- |
1030
+ | `--refactor` | `-r` | change the source code of all components using the original scope-name with the new scope-name |
1031
+
1032
+ ---
1033
+
1013
1034
  ## scope-config
1014
1035
 
1015
1036
  **Workspace only**: yes
@@ -2230,7 +2230,22 @@ function MDXContent(_ref) {
2230
2230
  }), (0, _react2.mdx)("td", {
2231
2231
  parentName: "tr",
2232
2232
  "align": null
2233
- }, "EXPERIMENTAL. don't throw an error when artifact files are missing. not recommended, unless you're sure the artifacts are in the remote")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "fork"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2233
+ }, "EXPERIMENTAL. don't throw an error when artifact files are missing. not recommended, unless you're sure the artifacts are in the remote")), (0, _react2.mdx)("tr", {
2234
+ parentName: "tbody"
2235
+ }, (0, _react2.mdx)("td", {
2236
+ parentName: "tr",
2237
+ "align": null
2238
+ }, (0, _react2.mdx)("inlineCode", {
2239
+ parentName: "td"
2240
+ }, "--json")), (0, _react2.mdx)("td", {
2241
+ parentName: "tr",
2242
+ "align": "center"
2243
+ }, (0, _react2.mdx)("inlineCode", {
2244
+ parentName: "td"
2245
+ }, "-j")), (0, _react2.mdx)("td", {
2246
+ parentName: "tr",
2247
+ "align": null
2248
+ }, "show output in json format")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "fork"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2234
2249
  parentName: "p"
2235
2250
  }, "Workspace only"), ": no", (0, _react2.mdx)("br", {
2236
2251
  parentName: "p"
@@ -4295,7 +4310,20 @@ function MDXContent(_ref) {
4295
4310
  }, "-d")), (0, _react2.mdx)("td", {
4296
4311
  parentName: "tr",
4297
4312
  "align": null
4298
- }, "delete local component files (authored components only. for imported components the files are always deleted)")), (0, _react2.mdx)("tr", {
4313
+ }, "DEPRECATED (this is now the default). delete local component files")), (0, _react2.mdx)("tr", {
4314
+ parentName: "tbody"
4315
+ }, (0, _react2.mdx)("td", {
4316
+ parentName: "tr",
4317
+ "align": null
4318
+ }, (0, _react2.mdx)("inlineCode", {
4319
+ parentName: "td"
4320
+ }, "--keep-files")), (0, _react2.mdx)("td", {
4321
+ parentName: "tr",
4322
+ "align": "center"
4323
+ }), (0, _react2.mdx)("td", {
4324
+ parentName: "tr",
4325
+ "align": null
4326
+ }, "keep component files (just untrack the component)")), (0, _react2.mdx)("tr", {
4299
4327
  parentName: "tbody"
4300
4328
  }, (0, _react2.mdx)("td", {
4301
4329
  parentName: "tr",
@@ -4541,7 +4569,57 @@ function MDXContent(_ref) {
4541
4569
  }, "-j")), (0, _react2.mdx)("td", {
4542
4570
  parentName: "tr",
4543
4571
  "align": null
4544
- }, "return the component data in json format")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "scope-config"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
4572
+ }, "return the component data in json format")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "scope"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
4573
+ parentName: "p"
4574
+ }, "Workspace only"), ": yes", (0, _react2.mdx)("br", {
4575
+ parentName: "p"
4576
+ }), "\n", (0, _react2.mdx)("strong", {
4577
+ parentName: "p"
4578
+ }, "Description"), ": EXPERIMENTAL. manage scope-name"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
4579
+ parentName: "p"
4580
+ }, "bit scope <sub-command>")), (0, _react2.mdx)("h3", null, "scope rename"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
4581
+ parentName: "p"
4582
+ }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
4583
+ parentName: "p"
4584
+ }, "scope rename <old-name> <new-name>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
4585
+ parentName: "p"
4586
+ }, "Description"), ": rename a scope for components using the old-name, optionally change the dependencies source-code"), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
4587
+ parentName: "table"
4588
+ }, (0, _react2.mdx)("tr", {
4589
+ parentName: "thead"
4590
+ }, (0, _react2.mdx)("th", {
4591
+ parentName: "tr",
4592
+ "align": null
4593
+ }, (0, _react2.mdx)("strong", {
4594
+ parentName: "th"
4595
+ }, "Option")), (0, _react2.mdx)("th", {
4596
+ parentName: "tr",
4597
+ "align": "center"
4598
+ }, (0, _react2.mdx)("strong", {
4599
+ parentName: "th"
4600
+ }, "Option alias")), (0, _react2.mdx)("th", {
4601
+ parentName: "tr",
4602
+ "align": null
4603
+ }, (0, _react2.mdx)("strong", {
4604
+ parentName: "th"
4605
+ }, "Description")))), (0, _react2.mdx)("tbody", {
4606
+ parentName: "table"
4607
+ }, (0, _react2.mdx)("tr", {
4608
+ parentName: "tbody"
4609
+ }, (0, _react2.mdx)("td", {
4610
+ parentName: "tr",
4611
+ "align": null
4612
+ }, (0, _react2.mdx)("inlineCode", {
4613
+ parentName: "td"
4614
+ }, "--refactor")), (0, _react2.mdx)("td", {
4615
+ parentName: "tr",
4616
+ "align": "center"
4617
+ }, (0, _react2.mdx)("inlineCode", {
4618
+ parentName: "td"
4619
+ }, "-r")), (0, _react2.mdx)("td", {
4620
+ parentName: "tr",
4621
+ "align": null
4622
+ }, "change the source code of all components using the original scope-name with the new scope-name")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "scope-config"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
4545
4623
  parentName: "p"
4546
4624
  }, "Workspace only"), ": yes", (0, _react2.mdx)("br", {
4547
4625
  parentName: "p"