@teambit/harmony.content.cli-reference 1.95.16 → 1.95.19

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
@@ -25,6 +25,7 @@ Commands that are marked as workspace only must be executed inside a workspace.
25
25
  | `--namespace <namespace>` | `-n` | organize component in a namespace |
26
26
  | `--exclude <file>/"<file>,<file>"` | `-e` | exclude file from being tracked. use quotation marks to list files or use a glob pattern |
27
27
  | `--override <boolean>` | `-o` | override existing component if exists (default = false) |
28
+ | `--scope <string>` | `-s` | sets the component's scope-name. if not entered, the default-scope will be used |
28
29
 
29
30
  ---
30
31
 
@@ -946,7 +947,8 @@ Legacy support [file, ssh]. Harmony supports [file, http].
946
947
  | ---------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------------- |
947
948
  | `--remote` | `-r` | remove a component from a remote scope |
948
949
  | `--track` | `-t` | keep tracking component (default = false) |
949
- | `--delete-files` | `-d` | delete local component files (authored components only. for imported components the files are always deleted) |
950
+ | `--delete-files` | `-d` | DEPRECATED (this is now the default). delete local component files |
951
+ | `--keep-files` | | keep component files (just untrack the component) |
950
952
  | `--force` | `-f` | removes the component from the scope, even if used as a dependency. WARNING: components that depend on this component will corrupt |
951
953
  | `--silent` | `-s` | skip confirmation |
952
954
 
@@ -1009,6 +1011,25 @@ alternatively, exporting to any one of the failed scopes, throws server-is-busy
1009
1011
 
1010
1012
  ---
1011
1013
 
1014
+ ## scope
1015
+
1016
+ **Workspace only**: yes
1017
+ **Description**: EXPERIMENTAL. manage scope-name
1018
+
1019
+ `bit scope <sub-command>`
1020
+
1021
+ ### scope rename
1022
+
1023
+ **Usage**: `scope rename <old-name> <new-name>`
1024
+
1025
+ **Description**: rename a scope for components using the old-name, optionally change the dependencies source-code
1026
+
1027
+ | **Option** | **Option alias** | **Description** |
1028
+ | ------------ | :--------------: | ---------------------------------------------------------------------------------------------- |
1029
+ | `--refactor` | `-r` | change the source code of all components using the original scope-name with the new scope-name |
1030
+
1031
+ ---
1032
+
1012
1033
  ## scope-config
1013
1034
 
1014
1035
  **Workspace only**: yes
@@ -164,7 +164,22 @@ function MDXContent(_ref) {
164
164
  }, "-o")), (0, _react2.mdx)("td", {
165
165
  parentName: "tr",
166
166
  "align": null
167
- }, "override existing component if exists (default = false)")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "app"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
167
+ }, "override existing component if exists (default = false)")), (0, _react2.mdx)("tr", {
168
+ parentName: "tbody"
169
+ }, (0, _react2.mdx)("td", {
170
+ parentName: "tr",
171
+ "align": null
172
+ }, (0, _react2.mdx)("inlineCode", {
173
+ parentName: "td"
174
+ }, "--scope <string>")), (0, _react2.mdx)("td", {
175
+ parentName: "tr",
176
+ "align": "center"
177
+ }, (0, _react2.mdx)("inlineCode", {
178
+ parentName: "td"
179
+ }, "-s")), (0, _react2.mdx)("td", {
180
+ parentName: "tr",
181
+ "align": null
182
+ }, "sets the component's scope-name. if not entered, the default-scope will be used")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "app"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
168
183
  parentName: "p"
169
184
  }, "Workspace only"), ": yes", (0, _react2.mdx)("br", {
170
185
  parentName: "p"
@@ -4280,7 +4295,20 @@ function MDXContent(_ref) {
4280
4295
  }, "-d")), (0, _react2.mdx)("td", {
4281
4296
  parentName: "tr",
4282
4297
  "align": null
4283
- }, "delete local component files (authored components only. for imported components the files are always deleted)")), (0, _react2.mdx)("tr", {
4298
+ }, "DEPRECATED (this is now the default). delete local component files")), (0, _react2.mdx)("tr", {
4299
+ parentName: "tbody"
4300
+ }, (0, _react2.mdx)("td", {
4301
+ parentName: "tr",
4302
+ "align": null
4303
+ }, (0, _react2.mdx)("inlineCode", {
4304
+ parentName: "td"
4305
+ }, "--keep-files")), (0, _react2.mdx)("td", {
4306
+ parentName: "tr",
4307
+ "align": "center"
4308
+ }), (0, _react2.mdx)("td", {
4309
+ parentName: "tr",
4310
+ "align": null
4311
+ }, "keep component files (just untrack the component)")), (0, _react2.mdx)("tr", {
4284
4312
  parentName: "tbody"
4285
4313
  }, (0, _react2.mdx)("td", {
4286
4314
  parentName: "tr",
@@ -4526,7 +4554,57 @@ function MDXContent(_ref) {
4526
4554
  }, "-j")), (0, _react2.mdx)("td", {
4527
4555
  parentName: "tr",
4528
4556
  "align": null
4529
- }, "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", {
4557
+ }, "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", {
4558
+ parentName: "p"
4559
+ }, "Workspace only"), ": yes", (0, _react2.mdx)("br", {
4560
+ parentName: "p"
4561
+ }), "\n", (0, _react2.mdx)("strong", {
4562
+ parentName: "p"
4563
+ }, "Description"), ": EXPERIMENTAL. manage scope-name"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
4564
+ parentName: "p"
4565
+ }, "bit scope <sub-command>")), (0, _react2.mdx)("h3", null, "scope rename"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
4566
+ parentName: "p"
4567
+ }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
4568
+ parentName: "p"
4569
+ }, "scope rename <old-name> <new-name>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
4570
+ parentName: "p"
4571
+ }, "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", {
4572
+ parentName: "table"
4573
+ }, (0, _react2.mdx)("tr", {
4574
+ parentName: "thead"
4575
+ }, (0, _react2.mdx)("th", {
4576
+ parentName: "tr",
4577
+ "align": null
4578
+ }, (0, _react2.mdx)("strong", {
4579
+ parentName: "th"
4580
+ }, "Option")), (0, _react2.mdx)("th", {
4581
+ parentName: "tr",
4582
+ "align": "center"
4583
+ }, (0, _react2.mdx)("strong", {
4584
+ parentName: "th"
4585
+ }, "Option alias")), (0, _react2.mdx)("th", {
4586
+ parentName: "tr",
4587
+ "align": null
4588
+ }, (0, _react2.mdx)("strong", {
4589
+ parentName: "th"
4590
+ }, "Description")))), (0, _react2.mdx)("tbody", {
4591
+ parentName: "table"
4592
+ }, (0, _react2.mdx)("tr", {
4593
+ parentName: "tbody"
4594
+ }, (0, _react2.mdx)("td", {
4595
+ parentName: "tr",
4596
+ "align": null
4597
+ }, (0, _react2.mdx)("inlineCode", {
4598
+ parentName: "td"
4599
+ }, "--refactor")), (0, _react2.mdx)("td", {
4600
+ parentName: "tr",
4601
+ "align": "center"
4602
+ }, (0, _react2.mdx)("inlineCode", {
4603
+ parentName: "td"
4604
+ }, "-r")), (0, _react2.mdx)("td", {
4605
+ parentName: "tr",
4606
+ "align": null
4607
+ }, "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", {
4530
4608
  parentName: "p"
4531
4609
  }, "Workspace only"), ": yes", (0, _react2.mdx)("br", {
4532
4610
  parentName: "p"