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

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 +111 -133
  2. package/cli-reference.mdx +34 -41
  3. package/dist/cli-reference.json +111 -133
  4. package/dist/cli-reference.mdx.js +90 -160
  5. package/dist/cli-reference.mdx.js.map +1 -1
  6. package/package-tar/teambit-harmony.content.cli-reference-1.95.39.tgz +0 -0
  7. package/package.json +2 -32
  8. package/{preview-1656386921357.js → preview-1657337177086.js} +3 -3
  9. package/package-tar/teambit-harmony.content.cli-reference-1.95.36.tgz +0 -0
package/cli-reference.json CHANGED
@@ -210,7 +210,7 @@
210
210
  "private": true
211
211
  },
212
212
  {
213
- "name": "dependents <id>",
213
+ "name": "dependents <component-name>",
214
214
  "alias": "",
215
215
  "options": [],
216
216
  "description": "EXPERIMENTAL. show dependents of the given component",
@@ -219,7 +219,7 @@
219
219
  "private": false
220
220
  },
221
221
  {
222
- "name": "dependencies <id>",
222
+ "name": "dependencies <component-name>",
223
223
  "alias": "",
224
224
  "options": [
225
225
  [
@@ -233,7 +233,7 @@
233
233
  "show the immediate dependencies and how their version was determined"
234
234
  ]
235
235
  ],
236
- "description": "EXPERIMENTAL. show dependencies (direct and indirect) of the given component",
236
+ "description": "EXPERIMENTAL. show direct and indirect dependencies of the given component",
237
237
  "extendedDescription": "",
238
238
  "group": "info",
239
239
  "private": false
@@ -324,21 +324,6 @@
324
324
  "private": true,
325
325
  "internal": true
326
326
  },
327
- {
328
- "name": "inject-conf [id]",
329
- "alias": "",
330
- "options": [
331
- [
332
- "f",
333
- "force",
334
- "force injecting even if there are config files changes"
335
- ]
336
- ],
337
- "description": "injecting components configuration",
338
- "extendedDescription": "",
339
- "group": "ungrouped",
340
- "private": true
341
- },
342
327
  {
343
328
  "name": "_scope <path> <args>",
344
329
  "alias": "",
@@ -349,36 +334,6 @@
349
334
  "private": true,
350
335
  "internal": true
351
336
  },
352
- {
353
- "name": "ci-update <id> [scopePath]",
354
- "alias": "",
355
- "options": [
356
- [
357
- "d",
358
- "directory [file]",
359
- "directory to run ci-update"
360
- ],
361
- [
362
- "k",
363
- "keep",
364
- "keep test environment after run (default false)"
365
- ],
366
- [
367
- "c",
368
- "no-cache",
369
- "ignore component cache when creating dist file"
370
- ],
371
- [
372
- "o",
373
- "output [file]",
374
- "save ci results to file system"
375
- ]
376
- ],
377
- "description": "run an update for build and test of a certain bit-component",
378
- "extendedDescription": "",
379
- "group": "ungrouped",
380
- "private": true
381
- },
382
337
  {
383
338
  "name": "cat-scope [scopePath]",
384
339
  "alias": "",
@@ -474,21 +429,11 @@
474
429
  "main <file>",
475
430
  "define entry point for the components"
476
431
  ],
477
- [
478
- "t",
479
- "tests <file>/\"<file>,<file>\"",
480
- "LEGACY ONLY. specify test files to track. use quotation marks to list files or use a glob pattern"
481
- ],
482
432
  [
483
433
  "n",
484
434
  "namespace <namespace>",
485
435
  "organize component in a namespace"
486
436
  ],
487
- [
488
- "e",
489
- "exclude <file>/\"<file>,<file>\"",
490
- "LEGACY ONLY. exclude file from being tracked. use quotation marks to list files or use a glob pattern"
491
- ],
492
437
  [
493
438
  "o",
494
439
  "override <boolean>",
@@ -505,21 +450,6 @@
505
450
  "group": "development",
506
451
  "private": false
507
452
  },
508
- {
509
- "name": "untrack [ids...]",
510
- "alias": "u",
511
- "options": [
512
- [
513
- "a",
514
- "all",
515
- "revert add for all tracked components"
516
- ]
517
- ],
518
- "description": "DEPRECATED (use \"bit remove\" instead). untrack a new component(s)\n https://legacy-docs.bit.dev/docs/add-and-isolate-components#untracking-components\n you can use a pattern for multiple ids, such as bit untrack \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
519
- "extendedDescription": "",
520
- "group": "ungrouped",
521
- "private": true
522
- },
523
453
  {
524
454
  "name": "untag [component-name] [component-version]",
525
455
  "alias": "",
@@ -543,18 +473,12 @@
543
473
  "description": "revert tagged or snapped versions for component(s)",
544
474
  "extendedDescription": "https://bit.dev/docs/components/tags#undoing-a-tag\nyou can use a pattern for multiple ids, such as bit untag \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
545
475
  "group": "development",
546
- "private": false
476
+ "private": true
547
477
  },
548
478
  {
549
479
  "name": "move <current-component-dir> <new-component-dir>",
550
480
  "alias": "mv",
551
- "options": [
552
- [
553
- "c",
554
- "component",
555
- "LEGACY ONLY. move component files that are spread over multiple directories to one directory. synopsis: `move <component-id> <directory>`"
556
- ]
557
- ],
481
+ "options": [],
558
482
  "description": "move a component to a different filesystem path",
559
483
  "extendedDescription": "move files or directories of component(s)\n https://bit.dev/docs/workspace/moving-components",
560
484
  "group": "development",
@@ -611,26 +535,6 @@
611
535
  "private": true,
612
536
  "internal": true
613
537
  },
614
- {
615
- "name": "_deprecate <path> <args>",
616
- "alias": "",
617
- "options": [],
618
- "description": "deprecate a component from a scope",
619
- "extendedDescription": "",
620
- "group": "ungrouped",
621
- "private": true,
622
- "internal": true
623
- },
624
- {
625
- "name": "_undeprecate <path> <args>",
626
- "alias": "",
627
- "options": [],
628
- "description": "undeprecate a component from a scope",
629
- "extendedDescription": "",
630
- "group": "ungrouped",
631
- "private": true,
632
- "internal": true
633
- },
634
538
  {
635
539
  "name": "_latest <path> <args>",
636
540
  "alias": "",
@@ -668,7 +572,7 @@
668
572
  [
669
573
  "r",
670
574
  "reset",
671
- "remove local changes"
575
+ "revert changes that were not snapped"
672
576
  ],
673
577
  [
674
578
  "a",
@@ -784,11 +688,6 @@
784
688
  "v",
785
689
  "verbose",
786
690
  "showing logs for the migration process"
787
- ],
788
- [
789
- "h",
790
- "harmony",
791
- "migrate workspace from legacy to Harmony"
792
691
  ]
793
692
  ],
794
693
  "description": "migrate scope to the current version",
@@ -955,22 +854,6 @@
955
854
  "group": "general",
956
855
  "private": false
957
856
  },
958
- {
959
- "name": "use [component-ids...]",
960
- "alias": "",
961
- "options": [],
962
- "description": "set aspects in the workspace/scope config to make them loadable by the workspace/scope",
963
- "extendedDescription": "",
964
- "group": "collaborate",
965
- "private": false,
966
- "remoteOp": true,
967
- "arguments": [
968
- {
969
- "name": "component-ids...",
970
- "description": "the component IDs of the aspects"
971
- }
972
- ]
973
- },
974
857
  {
975
858
  "name": "show <component-name>",
976
859
  "alias": "",
@@ -1048,7 +931,7 @@
1048
931
  "arguments": [
1049
932
  {
1050
933
  "name": "component-pattern",
1051
- "description": "component name, component id, or component pattern. use component pattern to select multiple components. \nuse commas to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
934
+ "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"
1052
935
  },
1053
936
  {
1054
937
  "name": "env",
@@ -1203,7 +1086,7 @@
1203
1086
  [
1204
1087
  "r",
1205
1088
  "refactor",
1206
- "change the source code of all components using the original scope-name with the new scope-name"
1089
+ "update the import statements in all dependent components to the new package name (that contains the new scope name)"
1207
1090
  ]
1208
1091
  ],
1209
1092
  "description": "Renames the scope name for all components with the specified 'current scope name'",
@@ -1484,6 +1367,22 @@
1484
1367
  }
1485
1368
  ]
1486
1369
  },
1370
+ {
1371
+ "name": "use <component-id>",
1372
+ "alias": "",
1373
+ "options": [],
1374
+ "description": "set aspects in the workspace/scope config to make them loadable by the workspace/scope",
1375
+ "extendedDescription": "",
1376
+ "group": "collaborate",
1377
+ "private": false,
1378
+ "remoteOp": true,
1379
+ "arguments": [
1380
+ {
1381
+ "name": "component-id",
1382
+ "description": "the component ID of the aspect"
1383
+ }
1384
+ ]
1385
+ },
1487
1386
  {
1488
1387
  "name": "pattern <pattern>",
1489
1388
  "alias": "",
@@ -1497,7 +1396,29 @@
1497
1396
  "description": "list the component ids matching the given pattern",
1498
1397
  "extendedDescription": "this command helps validating a pattern before using it in other commands.\na pattern can be a simple component-id or component-name. e.g. \"ui/button\".\na pattern can be used with wildcards for multiple component ids, e.g. \"org.scope/utils/**\".\nto enter multiple patterns, separate them by a comma, e.g. \"ui/*, lib/*\"\nto exclude, use \"!\". e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nthe matching algorithm is done by multimatch (@see https://github.com/sindresorhus/multimatch)\n",
1499
1398
  "group": "development",
1500
- "private": false
1399
+ "private": false,
1400
+ "examples": [
1401
+ {
1402
+ "cmd": "bit pattern \"**\"",
1403
+ "description": "matches all components"
1404
+ },
1405
+ {
1406
+ "cmd": "bit pattern \"*/ui/*\"",
1407
+ "description": "matches components with any scope-name and the \"ui\" namespace. e.g. \"ui/button\" but not \"ui/elements/button\""
1408
+ },
1409
+ {
1410
+ "cmd": "bit pattern \"*/ui/**\"",
1411
+ "description": "matches components that their namespace starts with \"ui/\" e.g. \"ui/button\", \"ui/elements/button\""
1412
+ },
1413
+ {
1414
+ "cmd": "bit pattern \"bar, foo\"",
1415
+ "description": "matches two components: bar and foo"
1416
+ },
1417
+ {
1418
+ "cmd": "bit pattern \"my-scope.org/**\"",
1419
+ "description": "matches all components of the scope \"my-scope.org\""
1420
+ }
1421
+ ]
1501
1422
  },
1502
1423
  {
1503
1424
  "name": "list [remote-scope]",
@@ -1598,7 +1519,7 @@
1598
1519
  [
1599
1520
  "",
1600
1521
  "dependents",
1601
- "EXPERIMENTAL. import component dependents to allow auto-tag updating them upon tag"
1522
+ "EXPERIMENTAL. import the components' dependents. this enables changes to propagate from (modified) components to their dependents"
1602
1523
  ],
1603
1524
  [
1604
1525
  "",
@@ -2050,7 +1971,7 @@
2050
1971
  [
2051
1972
  "i",
2052
1973
  "ignore-issues [issues]",
2053
- "ignore component issues (shown in \"bit status\" as \"issues found\"), issues to ignore:\n[MissingPackagesDependenciesOnFs, MissingComponents, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingLinks, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, MissingCustomModuleResolutionLinks, ImportNonMainFiles, CustomModuleResolutionUsed, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies]\nto ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify \"*\"."
1974
+ "ignore component issues (shown in \"bit status\" as \"issues found\"), issues to ignore:\n[MissingPackagesDependenciesOnFs, MissingComponents, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, CustomModuleResolutionUsed, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies]\nto ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify \"*\"."
2054
1975
  ],
2055
1976
  [
2056
1977
  "I",
@@ -2143,7 +2064,7 @@
2143
2064
  [
2144
2065
  "i",
2145
2066
  "ignore-issues [issues]",
2146
- "ignore component issues (shown in \"bit status\" as \"issues found\"), issues to ignore:\n[MissingPackagesDependenciesOnFs, MissingComponents, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingLinks, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, MissingCustomModuleResolutionLinks, ImportNonMainFiles, CustomModuleResolutionUsed, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies]\nto ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify \"*\"."
2067
+ "ignore component issues (shown in \"bit status\" as \"issues found\"), issues to ignore:\n[MissingPackagesDependenciesOnFs, MissingComponents, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, CustomModuleResolutionUsed, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies]\nto ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify \"*\"."
2147
2068
  ],
2148
2069
  [
2149
2070
  "a",
@@ -2167,6 +2088,41 @@
2167
2088
  }
2168
2089
  ]
2169
2090
  },
2091
+ {
2092
+ "name": "reset [component-pattern] [component-version]",
2093
+ "alias": "",
2094
+ "options": [
2095
+ [
2096
+ "a",
2097
+ "all",
2098
+ "revert tag/snap for all tagged/snapped components"
2099
+ ],
2100
+ [
2101
+ "",
2102
+ "soft",
2103
+ "revert only soft-tags (components tagged with --soft flag)"
2104
+ ],
2105
+ [
2106
+ "f",
2107
+ "force",
2108
+ "revert the tag even if used as a dependency. WARNING: components that depend on this tag will corrupt"
2109
+ ]
2110
+ ],
2111
+ "description": "revert tagged or snapped versions for component(s)",
2112
+ "extendedDescription": "https://bit.dev/docs/components/tags#undoing-a-tag",
2113
+ "group": "development",
2114
+ "private": false,
2115
+ "arguments": [
2116
+ {
2117
+ "name": "component-pattern",
2118
+ "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"
2119
+ },
2120
+ {
2121
+ "name": "component-version",
2122
+ "description": "the version to untag (semver for tags. hash for snaps)"
2123
+ }
2124
+ ]
2125
+ },
2170
2126
  {
2171
2127
  "name": "merge [values...]",
2172
2128
  "alias": "",
@@ -2616,7 +2572,7 @@
2616
2572
  ]
2617
2573
  },
2618
2574
  {
2619
- "name": "deprecate <id>",
2575
+ "name": "deprecate <component-name>",
2620
2576
  "alias": "d",
2621
2577
  "options": [
2622
2578
  [
@@ -2630,7 +2586,13 @@
2630
2586
  "group": "collaborate",
2631
2587
  "private": false,
2632
2588
  "remoteOp": true,
2633
- "skipWorkspace": true
2589
+ "skipWorkspace": true,
2590
+ "arguments": [
2591
+ {
2592
+ "name": "component-name",
2593
+ "description": "component name or component id"
2594
+ }
2595
+ ]
2634
2596
  },
2635
2597
  {
2636
2598
  "name": "undeprecate <id>",
@@ -2866,7 +2828,13 @@
2866
2828
  "description": "creates a new lane and switches to it",
2867
2829
  "extendedDescription": "a lane created from main (default-lane) is empty until components are snapped.\na lane created from another lane has all the components of the original lane.",
2868
2830
  "group": "ungrouped",
2869
- "private": true
2831
+ "private": true,
2832
+ "arguments": [
2833
+ {
2834
+ "name": "lane-name",
2835
+ "description": "the name for the new lane"
2836
+ }
2837
+ ]
2870
2838
  },
2871
2839
  {
2872
2840
  "name": "merge <lane>",
@@ -2920,7 +2888,17 @@
2920
2888
  [
2921
2889
  "",
2922
2890
  "squash",
2923
- "squash multiple snaps. keep the last one only"
2891
+ "EXPERIMENTAL. squash multiple snaps. keep the last one only"
2892
+ ],
2893
+ [
2894
+ "",
2895
+ "pattern <component-pattern>",
2896
+ "EXPERIMENTAL. partially merge the lane with the specified component-pattern"
2897
+ ],
2898
+ [
2899
+ "",
2900
+ "include-deps",
2901
+ "EXPERIMENTAL. relevant for \"--pattern\" and \"--existing\". merge also dependencies of the given components"
2924
2902
  ]
2925
2903
  ],
2926
2904
  "description": "merge a local or a remote lane",
package/cli-reference.mdx CHANGED
@@ -12,15 +12,13 @@ all flags support glob patterns and {PARENT} {FILE_NAME} annotations
12
12
 
13
13
  `bit add [path...]`
14
14
 
15
- | **Option** | **Option alias** | **Description** |
16
- | ---------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------- |
17
- | `--id <name>` | `-i` | manually set component id |
18
- | `--main <file>` | `-m` | define entry point for the components |
19
- | `--tests <file>/"<file>,<file>"` | `-t` | LEGACY ONLY. specify test files to track. use quotation marks to list files or use a glob pattern |
20
- | `--namespace <namespace>` | `-n` | organize component in a namespace |
21
- | `--exclude <file>/"<file>,<file>"` | `-e` | LEGACY ONLY. exclude file from being tracked. use quotation marks to list files or use a glob pattern |
22
- | `--override <boolean>` | `-o` | override existing component if exists (default = false) |
23
- | `--scope <string>` | `-s` | sets the component's scope-name. if not entered, the default-scope will be used |
15
+ | **Option** | **Option alias** | **Description** |
16
+ | ------------------------- | :--------------: | ------------------------------------------------------------------------------- |
17
+ | `--id <name>` | `-i` | manually set component id |
18
+ | `--main <file>` | `-m` | define entry point for the components |
19
+ | `--namespace <namespace>` | `-n` | organize component in a namespace |
20
+ | `--override <boolean>` | `-o` | override existing component if exists (default = false) |
21
+ | `--scope <string>` | `-s` | sets the component's scope-name. if not entered, the default-scope will be used |
24
22
 
25
23
  ---
26
24
 
@@ -216,7 +214,7 @@ with no args, only workspace's capsules are deleted
216
214
  | `--ours` | `-o` | in case of a conflict, override the used version with the current modification |
217
215
  | `--theirs` | `-t` | in case of a conflict, override the current modification with the specified version |
218
216
  | `--manual` | `-m` | in case of a conflict, leave the files with a conflict state to resolve them manually later |
219
- | `--reset` | `-r` | remove local changes |
217
+ | `--reset` | `-r` | revert changes that were not snapped |
220
218
  | `--all` | `-a` | all components |
221
219
  | `--verbose` | `-v` | showing verbose output for inspection |
222
220
  | `--skip-npm-install` | | DEPRECATED. use "--skip-dependency-installation" instead |
@@ -359,9 +357,9 @@ https://bit.dev/docs/config/bit-config
359
357
  ## dependencies
360
358
 
361
359
  **Workspace only**: yes
362
- **Description**: EXPERIMENTAL. show dependencies (direct and indirect) of the given component
360
+ **Description**: EXPERIMENTAL. show direct and indirect dependencies of the given component
363
361
 
364
- `bit dependencies <id>`
362
+ `bit dependencies <component-name>`
365
363
 
366
364
  | **Option** | **Option alias** | **Description** |
367
365
  | ---------- | :--------------: | -------------------------------------------------------------------- |
@@ -375,7 +373,7 @@ https://bit.dev/docs/config/bit-config
375
373
  **Workspace only**: yes
376
374
  **Description**: EXPERIMENTAL. show dependents of the given component
377
375
 
378
- `bit dependents <id>`
376
+ `bit dependents <component-name>`
379
377
 
380
378
  ---
381
379
 
@@ -385,7 +383,7 @@ https://bit.dev/docs/config/bit-config
385
383
  **Workspace only**: no
386
384
  **Description**: deprecate a component
387
385
 
388
- `bit deprecate <id>`
386
+ `bit deprecate <component-name>`
389
387
 
390
388
  | **Option** | **Option alias** | **Description** |
391
389
  | ------------------- | :--------------: | ------------------------------------------------------------ |
@@ -624,7 +622,7 @@ you can use a pattern for multiple ids, such as bit import "utils/\*". (wrap the
624
622
  | `--skip-dependency-installation` | | do not install packages of the imported components |
625
623
  | `--merge [strategy]` | `-m` | merge local changes with the imported version. strategy should be "theirs", "ours" or "manual" |
626
624
  | `--dependencies` | | EXPERIMENTAL. import all dependencies and write them to the workspace |
627
- | `--dependents` | | EXPERIMENTAL. import component dependents to allow auto-tag updating them upon tag |
625
+ | `--dependents` | | EXPERIMENTAL. import the components' dependents. this enables changes to propagate from (modified) components to their dependents |
628
626
  | `--save-in-lane` | | EXPERIMENTAL. when checked out to a lane and the component is not on the remote-lane, save it in the lane (default to save on main) |
629
627
  | `--all-history` | | relevant for fetching all components objects. avoid optimizations, fetch all history versions, always |
630
628
 
@@ -804,10 +802,6 @@ move files or directories of component(s)
804
802
 
805
803
  `bit move <current-component-dir> <new-component-dir>`
806
804
 
807
- | **Option** | **Option alias** | **Description** |
808
- | ------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------------- |
809
- | `--component` | `-c` | LEGACY ONLY. move component files that are spread over multiple directories to one directory. synopsis: `move <component-id> <directory>` |
810
-
811
805
  ---
812
806
 
813
807
  ## new
@@ -953,6 +947,22 @@ you can use a pattern for multiple ids, such as bit remove "utils/\*". (wrap the
953
947
 
954
948
  ---
955
949
 
950
+ ## reset
951
+
952
+ **Workspace only**: yes
953
+ **Description**: revert tagged or snapped versions for component(s)
954
+ https://bit.dev/docs/components/tags#undoing-a-tag
955
+
956
+ `bit reset [component-pattern] [component-version]`
957
+
958
+ | **Option** | **Option alias** | **Description** |
959
+ | ---------- | :--------------: | ----------------------------------------------------------------------------------------------------- |
960
+ | `--all` | `-a` | revert tag/snap for all tagged/snapped components |
961
+ | `--soft` | | revert only soft-tags (components tagged with --soft flag) |
962
+ | `--force` | `-f` | revert the tag even if used as a dependency. WARNING: components that depend on this tag will corrupt |
963
+
964
+ ---
965
+
956
966
  ## run
957
967
 
958
968
  **Alias**: `c`
@@ -1011,9 +1021,9 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
1011
1021
 
1012
1022
  **Description**: Renames the scope name for all components with the specified 'current scope name'
1013
1023
 
1014
- | **Option** | **Option alias** | **Description** |
1015
- | ------------ | :--------------: | ---------------------------------------------------------------------------------------------- |
1016
- | `--refactor` | `-r` | change the source code of all components using the original scope-name with the new scope-name |
1024
+ | **Option** | **Option alias** | **Description** |
1025
+ | ------------ | :--------------: | ------------------------------------------------------------------------------------------------------------------- |
1026
+ | `--refactor` | `-r` | update the import statements in all dependent components to the new package name (that contains the new scope name) |
1017
1027
 
1018
1028
  ### scope fork
1019
1029
 
@@ -1139,7 +1149,7 @@ https://bit.dev/components/tags
1139
1149
  | `--increment-by <number>` | | (default to 1) increment semver flag (patch/minor/major) by. e.g. incrementing patch by 2: 0.0.1 -> 0.0.3. |
1140
1150
  | `--ignore-issues [issues]` | `-i` | ignore component issues (shown in "bit status" as "issues found"), issues to ignore: |
1141
1151
 
1142
- [MissingPackagesDependenciesOnFs, MissingComponents, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingLinks, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, MissingCustomModuleResolutionLinks, ImportNonMainFiles, CustomModuleResolutionUsed, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies]
1152
+ [MissingPackagesDependenciesOnFs, MissingComponents, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, CustomModuleResolutionUsed, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies]
1143
1153
  to ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify "\*".|
1144
1154
  |`--ignore-newest-version`|`-I`|ignore existing of newer versions (default = false)|
1145
1155
  |`--build`|`-b`|EXPERIMENTAL. not needed for now. run the pipeline build and complete the tag|
@@ -1213,23 +1223,6 @@ list components templates when inside bit-workspace (for bit-create), otherwise,
1213
1223
 
1214
1224
  ---
1215
1225
 
1216
- ## untag
1217
-
1218
- **Workspace only**: yes
1219
- **Description**: revert tagged or snapped versions for component(s)
1220
- https://bit.dev/docs/components/tags#undoing-a-tag
1221
- you can use a pattern for multiple ids, such as bit untag "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
1222
-
1223
- `bit untag [component-name] [component-version]`
1224
-
1225
- | **Option** | **Option alias** | **Description** |
1226
- | ---------- | :--------------: | ----------------------------------------------------------------------------------------------------- |
1227
- | `--all` | `-a` | revert tag for all tagged components |
1228
- | `--soft` | | harmony - revert only soft-tags (components tagged with --soft flag) |
1229
- | `--force` | `-f` | revert the tag even if used as a dependency. WARNING: components that depend on this tag will corrupt |
1230
-
1231
- ---
1232
-
1233
1226
  ## update
1234
1227
 
1235
1228
  **Alias**: `up`
@@ -1249,7 +1242,7 @@ you can use a pattern for multiple ids, such as bit untag "utils/\*". (wrap the
1249
1242
  **Workspace only**: yes
1250
1243
  **Description**: set aspects in the workspace/scope config to make them loadable by the workspace/scope
1251
1244
 
1252
- `bit use [component-ids...]`
1245
+ `bit use <component-id>`
1253
1246
 
1254
1247
  ---
1255
1248