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

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 +307 -108
  2. package/cli-reference.mdx +119 -122
  3. package/dist/cli-reference.json +307 -108
  4. package/dist/cli-reference.mdx.js +111 -89
  5. package/dist/cli-reference.mdx.js.map +1 -1
  6. package/package-tar/teambit-harmony.content.cli-reference-1.95.30.tgz +0 -0
  7. package/package.json +2 -2
  8. package/{preview-1654831618244.js → preview-1655263660719.js} +2 -2
  9. package/package-tar/teambit-harmony.content.cli-reference-1.95.27.tgz +0 -0
package/cli-reference.mdx CHANGED
@@ -27,7 +27,7 @@ all flags support glob patterns and {PARENT} {FILE_NAME} annotations
27
27
  ## app
28
28
 
29
29
  **Workspace only**: yes
30
- **Description**: manage applications
30
+ **Description**: Manages apps
31
31
 
32
32
  `bit app <sub-command>`
33
33
 
@@ -35,7 +35,7 @@ all flags support glob patterns and {PARENT} {FILE_NAME} annotations
35
35
 
36
36
  **Usage**: `app list`
37
37
 
38
- **Description**: list all registered applications
38
+ **Description**: list all registered apps
39
39
 
40
40
  | **Option** | **Option alias** | **Description** |
41
41
  | ---------- | :--------------: | ---------------------------------------- |
@@ -289,9 +289,9 @@ The following gets removed by this command:
289
289
  ## compile
290
290
 
291
291
  **Workspace only**: yes
292
- **Description**: compile components in the development workspace
292
+ **Description**: compile components in the workspace
293
293
 
294
- `bit compile [component...]`
294
+ `bit compile [component-names...]`
295
295
 
296
296
  | **Option** | **Option alias** | **Description** |
297
297
  | ------------------- | :--------------: | ------------------------------------------------------------- |
@@ -361,9 +361,9 @@ https://bit.dev/docs/config/bit-config
361
361
  ## create
362
362
 
363
363
  **Workspace only**: yes
364
- **Description**: create a new component from a template
364
+ **Description**: create a new component (source files and config) using a template.
365
365
 
366
- `bit create <templateName> <componentNames...>`
366
+ `bit create <template-name> <component-names...>`
367
367
 
368
368
  | **Option** | **Option alias** | **Description** |
369
369
  | ---------------------- | :--------------: | ----------------------------------------------------------------------------------- |
@@ -485,7 +485,7 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
485
485
 
486
486
  **Alias**: `env`
487
487
  **Workspace only**: yes
488
- **Description**: list all components envs
488
+ **Description**: list all components maintained by the workspace and their corresponding envs
489
489
 
490
490
  `bit envs`
491
491
 
@@ -497,24 +497,21 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
497
497
 
498
498
  ### envs get
499
499
 
500
- **Usage**: `envs get <name>`
500
+ **Usage**: `envs get <component-name>`
501
501
 
502
- **Description**: show component's env details
502
+ **Description**: show information about a component's env
503
503
 
504
504
  ### envs set
505
505
 
506
- **Usage**: `envs set <pattern> <env>`
506
+ **Usage**: `envs set <component-pattern> <env>`
507
507
 
508
- **Description**: set an environment for component(s)
509
- you can use a `<pattern>` for multiple component ids, such as `bit env set "org.scope/utils/**"`. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
510
- always wrap the pattern with quotes to avoid collision with shell commands.
511
- to validate the pattern before running this command, run `bit pattern <pattern>`.
508
+ **Description**: Sets one or more components with a development environment (env)
512
509
 
513
510
  ### envs unset
514
511
 
515
- **Usage**: `envs unset <pattern>`
512
+ **Usage**: `envs unset <component-pattern>`
516
513
 
517
- **Description**: unset an environment from component(s) that was set by "bit env set"
514
+ **Description**: un-sets an env from components that were previously set by "bit env set" or by a component template
518
515
  keep in mind that this doesn't remove envs that are set in the variants.
519
516
  in only removes envs that appear in the .bitmap file, which were previously configured via "bit env set".
520
517
  the purpose of this command is to remove the specific settings and let the the variants in workspace.jsonc to control the env.
@@ -524,7 +521,7 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
524
521
 
525
522
  ### envs replace
526
523
 
527
- **Usage**: `envs replace <old-env> <new-env>`
524
+ **Usage**: `envs replace <current-env> <new-env>`
528
525
 
529
526
  **Description**: replace an existing env with another env for all components using the old env
530
527
 
@@ -534,19 +531,19 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
534
531
 
535
532
  **Alias**: `e`
536
533
  **Workspace only**: yes
537
- **Description**: Export components to a remote scope
534
+ **Description**: export components from the workspace to remote scopes
538
535
  bit export => export all staged components to their current scope, if checked out to a lane, export the lane as well
539
536
  `bit export [id...]` => export the given ids to their current scope
540
537
 
541
538
  https://bit.dev/docs/components/exporting-components
542
539
  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)
543
540
 
544
- `bit export [remote] [id...]`
541
+ `bit export [remote] [component-names...]`
545
542
 
546
543
  | **Option** | **Option alias** | **Description** |
547
544
  | ---------------------------- | :--------------: | --------------------------------------------------------------------------------------------------------------------------------------- |
548
- | `--eject` | `-e` | replaces the exported components from the local scope with the corresponding packages |
549
- | `--all` | `-a` | export all components include non-staged |
545
+ | `--eject` | `-e` | replace the exported components with their corresponding packages (to use these components without further maintaining them) |
546
+ | `--all` | `-a` | export all components, including non-staged |
550
547
  | `--include-dependencies` | `-d` | LEGACY ONLY. include the component's dependencies as part of the export to the remote scope |
551
548
  | `--set-current-scope` | `-s` | LEGACY ONLY. ensure the component's remote scope is set according to the target location |
552
549
  | `--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 |
@@ -562,17 +559,15 @@ you can use a pattern for multiple ids, such as bit export remote-scope "utils/\
562
559
  ## fork
563
560
 
564
561
  **Workspace only**: no
565
- **Description**: EXPERIMENTAL. create a new component out of an existing one
566
- note that [target-name] is the name only without the scope.
567
- to set the default-scope, please use --scope flag
562
+ **Description**: EXPERIMENTAL. create a new component out of an existing one (copies source files and config)
568
563
 
569
- `bit fork <source-id> [target-name]`
564
+ `bit fork <source-component-id> [target-component-name]`
570
565
 
571
- | **Option** | **Option alias** | **Description** |
572
- | ------------------ | :--------------: | ----------------------------------------------------------------------------------------------- |
573
- | `--scope <string>` | `-s` | default scope for the newly created component |
574
- | `--path <string>` | `-p` | relative path in the workspace. by default the path is `<scope>/<namespace>/<name>` |
575
- | `--refactor` | `-r` | change the source code of all components using the original component with the new package-name |
566
+ | **Option** | **Option alias** | **Description** |
567
+ | ------------------ | :--------------: | --------------------------------------------------------------------------------------------------------- |
568
+ | `--scope <string>` | `-s` | default scope for the new component |
569
+ | `--path <string>` | `-p` | relative path in the workspace for the new component. by default the path is `<scope>/<namespace>/<name>` |
570
+ | `--refactor` | `-r` | update the import/require statements in all dependent components (in the same workspace) |
576
571
 
577
572
  ---
578
573
 
@@ -633,28 +628,28 @@ to set the default-scope, please use --scope flag
633
628
  ## import
634
629
 
635
630
  **Workspace only**: yes
636
- **Description**: import components into your workspace
631
+ **Description**: import components from remote scopes to the local workspace
637
632
  https://bit.dev/docs/components/importing-components
638
633
  you can use a pattern for multiple ids, such as bit import "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
639
634
 
640
- `bit import [ids...]`
635
+ `bit import [component-ids...]`
641
636
 
642
- | **Option** | **Option alias** | **Description** |
643
- | -------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------- |
644
- | `--path <path>` | `-p` | import components into a specific directory |
645
- | `--objects` | `-o` | import components objects only, don't write the components to the file system. This is a default behavior for import with no id |
646
- | `--display-dependencies` | `-d` | display the imported dependencies |
647
- | `--override` | `-O` | override local changes |
648
- | `--verbose` | `-v` | showing verbose output for inspection |
649
- | `--json` | `-j` | return the output as JSON |
650
- | `--conf` | | write the configuration file (component.json) of the component (harmony components only) |
651
- | `--skip-npm-install` | | DEPRECATED. use "--skip-dependency-installation" instead |
652
- | `--skip-dependency-installation` | | do not install packages of the imported components |
653
- | `--merge [strategy]` | `-m` | merge local changes with the imported version. strategy should be "theirs", "ours" or "manual" |
654
- | `--dependencies` | | EXPERIMENTAL. import all dependencies and write them to the workspace |
655
- | `--dependents` | | EXPERIMENTAL. import component dependents to allow auto-tag updating them upon tag |
656
- | `--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) |
657
- | `--all-history` | | relevant for fetching all components objects. avoid optimizations, fetch all history versions, always |
637
+ | **Option** | **Option alias** | **Description** |
638
+ | -------------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
639
+ | `--path <path>` | `-p` | import components into a specific directory (a relative path in the workspace) |
640
+ | `--objects` | `-o` | import components objects to the local scope without checkout (without writing them to the file system). This is a default behavior for import with no id argument |
641
+ | `--display-dependencies` | `-d` | display the imported dependencies |
642
+ | `--override` | `-O` | override local changes |
643
+ | `--verbose` | `-v` | show verbose output for inspection |
644
+ | `--json` | `-j` | return the output as JSON |
645
+ | `--conf` | | write the configuration file (component.json) of the component |
646
+ | `--skip-npm-install` | | DEPRECATED. use "--skip-dependency-installation" instead |
647
+ | `--skip-dependency-installation` | | do not install packages of the imported components |
648
+ | `--merge [strategy]` | `-m` | merge local changes with the imported version. strategy should be "theirs", "ours" or "manual" |
649
+ | `--dependencies` | | EXPERIMENTAL. import all dependencies and write them to the workspace |
650
+ | `--dependents` | | EXPERIMENTAL. import component dependents to allow auto-tag updating them upon tag |
651
+ | `--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) |
652
+ | `--all-history` | | relevant for fetching all components objects. avoid optimizations, fetch all history versions, always |
658
653
 
659
654
  ---
660
655
 
@@ -686,7 +681,8 @@ https://bit.dev/docs/workspace/creating-workspaces#initialize-a-workspace-on-an-
686
681
 
687
682
  **Alias**: `in`
688
683
  **Workspace only**: yes
689
- **Description**: install development workspace dependencies
684
+ **Description**: installs workspace dependencies
685
+ when no package is specified, all workspace dependencies are installed and all workspace components are imported.
690
686
 
691
687
  `bit install [packages...]`
692
688
 
@@ -769,6 +765,7 @@ https://bit.dev/docs/reference/cli-reference#log
769
765
  | ----------- | :--------------: | ----------------------------------------- |
770
766
  | `--remote` | `-r` | show log of a remote component |
771
767
  | `--parents` | | EXPERIMENTAL. show parents and lanes data |
768
+ | `--json` | `-j` | json format |
772
769
 
773
770
  ---
774
771
 
@@ -841,18 +838,18 @@ move files or directories of component(s)
841
838
  ## new
842
839
 
843
840
  **Workspace only**: yes
844
- **Description**: Create a new workspace from a template
841
+ **Description**: create a new workspace from a template
845
842
 
846
- `bit new <templateName> <workspaceName>`
843
+ `bit new <template-name> <workspace-name>`
847
844
 
848
- | **Option** | **Option alias** | **Description** |
849
- | -------------------------- | :--------------: | --------------------------------------------------------------------------------------------------------------- |
850
- | `--aspect <string>` | `-a` | aspect-id of the template. mandatory for non-core aspects. helpful for core aspects in case of a name collision |
851
- | `--default-scope <string>` | `-d` | set defaultScope in the new workspace.jsonc |
852
- | `--standalone` | | DEPRECATED. use --skip-git instead |
853
- | `--skip-git` | `-s` | skip generation of Git repository |
854
- | `--empty` | `-e` | empty workspace with no components (relevant for templates that add components by default) |
855
- | `--load-from <string>` | | path to the workspace containing the template. helpful during a development of a workspace-template |
845
+ | **Option** | **Option alias** | **Description** |
846
+ | -------------------------------- | :--------------: | --------------------------------------------------------------------------------------------------------------- |
847
+ | `--aspect <aspect-id>` | `-a` | aspect-id of the template. mandatory for non-core aspects. helpful for core aspects in case of a name collision |
848
+ | `--default-scope <scope-name>` | `-d` | set defaultScope in the new workspace.jsonc |
849
+ | `--standalone` | | DEPRECATED. use --skip-git instead |
850
+ | `--skip-git` | `-s` | skip generation of Git repository |
851
+ | `--empty` | `-e` | empty workspace with no components (relevant for templates that add components by default) |
852
+ | `--load-from <path-to-template>` | | path to the workspace containing the template. helpful during a development of a workspace-template |
856
853
 
857
854
  ---
858
855
 
@@ -980,9 +977,9 @@ to assign a default-scope to this component, please use "--scope" flag
980
977
 
981
978
  **Alias**: `c`
982
979
  **Workspace only**: yes
983
- **Description**: run an application
980
+ **Description**: run an app (independent of bit's dev server)
984
981
 
985
- `bit run <app>`
982
+ `bit run <app-name>`
986
983
 
987
984
  | **Option** | **Option alias** | **Description** |
988
985
  | -------------- | :--------------: | -------------------------------------------------------------------------- |
@@ -1011,17 +1008,16 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
1011
1008
  ## scope
1012
1009
 
1013
1010
  **Workspace only**: yes
1014
- **Description**: EXPERIMENTAL. manage scope-name
1011
+ **Description**: EXPERIMENTAL. manage the scope-name for components
1015
1012
 
1016
1013
  `bit scope <sub-command>`
1017
1014
 
1018
1015
  ### scope set
1019
1016
 
1020
- **Usage**: `scope set <scope-name> [pattern]`
1017
+ **Usage**: `scope set <scope-name> [component-pattern]`
1021
1018
 
1022
- **Description**: set the default-scope
1023
- set a new scope in the workspace.jsonc.
1024
- if "pattern" is provided, the default-scope will be set to the new components matching the criteria.
1019
+ **Description**: Sets components with a default-scope. If no component is specified, sets the workspace with a default scope
1020
+ default scopes for components are set in the bitmap file. the default scope for a workspace is set in the workspace.jsonc. a component is set with a scope (as oppose to default scope) only once it is versioned.'
1025
1021
 
1026
1022
  you can use a `<pattern>` for multiple component ids, such as `bit scope set scope-name "org.scope/utils/**"`. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
1027
1023
  always wrap the pattern with quotes to avoid collision with shell commands.
@@ -1029,9 +1025,9 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
1029
1025
 
1030
1026
  ### scope rename
1031
1027
 
1032
- **Usage**: `scope rename <old-name> <new-name>`
1028
+ **Usage**: `scope rename <current-scope-name> <new-scope-name>`
1033
1029
 
1034
- **Description**: rename a scope for components using the old-name, optionally change the dependencies source-code
1030
+ **Description**: Renames the scope name for all components with the specified 'current scope name'
1035
1031
 
1036
1032
  | **Option** | **Option alias** | **Description** |
1037
1033
  | ------------ | :--------------: | ---------------------------------------------------------------------------------------------- |
@@ -1081,16 +1077,16 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
1081
1077
  ## show
1082
1078
 
1083
1079
  **Workspace only**: yes
1084
- **Description**: show a component
1080
+ **Description**: display the component's essential information
1085
1081
 
1086
- `bit show <id>`
1082
+ `bit show <component-name>`
1087
1083
 
1088
- | **Option** | **Option alias** | **Description** |
1089
- | ----------- | :--------------: | -------------------------------------------------------------------------------------------------------- |
1090
- | `--json` | `-j` | return the component data in json format |
1091
- | `--legacy` | `-l` | use the legacy bit show. |
1092
- | `--remote` | `-r` | show a remote component |
1093
- | `--compare` | `-c` | compare current file system component to latest tagged component [default=latest]. only works in legacy. |
1084
+ | **Option** | **Option alias** | **Description** |
1085
+ | ----------- | :--------------: | ------------------------------------------------------------------------------------------------------------ |
1086
+ | `--json` | `-j` | return the component data in a json format |
1087
+ | `--legacy` | `-l` | use the legacy bit show. |
1088
+ | `--remote` | `-r` | show a remote component |
1089
+ | `--compare` | `-c` | compare current file system component to the latest tagged component [default=latest]. only works in legacy. |
1094
1090
 
1095
1091
  ---
1096
1092
 
@@ -1098,18 +1094,18 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
1098
1094
 
1099
1095
  **Alias**: `c`
1100
1096
  **Workspace only**: yes
1101
- **Description**: Start a dev environment for a workspace or a specific component
1097
+ **Description**: run the ui/development server
1102
1098
 
1103
1099
  `bit start [type] [pattern]`
1104
1100
 
1105
- | **Option** | **Option alias** | **Description** |
1106
- | -------------------- | :--------------: | ------------------------------------------------------------ |
1107
- | `--dev` | `-d` | start UI server in dev mode. |
1108
- | `--port [number]` | `-p` | port of the UI server. |
1109
- | `--rebuild` | `-r` | rebuild the UI |
1110
- | `--verbose` | `-v` | showing verbose output for inspection and prints stack trace |
1111
- | `--no-browser` | | do not automatically open browser when ready |
1112
- | `--skip-compilation` | | skip the auto-compilation before starting the web-server |
1101
+ | **Option** | **Option alias** | **Description** |
1102
+ | ---------------------- | :--------------: | --------------------------------------------------------- |
1103
+ | `--dev` | `-d` | start UI server in dev mode. |
1104
+ | `--port [port-number]` | `-p` | port of the UI server. |
1105
+ | `--rebuild` | `-r` | rebuild the UI |
1106
+ | `--verbose` | `-v` | show verbose output for inspection and prints stack trace |
1107
+ | `--no-browser` | | do not automatically open browser when ready |
1108
+ | `--skip-compilation` | | skip the auto-compilation before starting the web-server |
1113
1109
 
1114
1110
  ---
1115
1111
 
@@ -1117,8 +1113,7 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
1117
1113
 
1118
1114
  **Alias**: `s`
1119
1115
  **Workspace only**: yes
1120
- **Description**: show the working area component(s) status
1121
- https://bit.dev/docs/workspace/workspace-status
1116
+ **Description**: present the current status of components in the workspace, and notifies when issues are detected
1122
1117
 
1123
1118
  `bit status`
1124
1119
 
@@ -1133,33 +1128,35 @@ https://bit.dev/docs/workspace/workspace-status
1133
1128
 
1134
1129
  **Alias**: `t`
1135
1130
  **Workspace only**: yes
1136
- **Description**: record component changes and lock versions
1131
+ **Description**: create an immutable and exportable component snapshot, tagged with a release version.
1137
1132
  if no ids are provided, it will tag all new and modified components.
1138
1133
  if component ids are entered, you can specify a version per id using "@" sign, e.g. bit tag foo@1.0.0 bar@minor baz@major
1139
1134
  https://bit.dev/components/tags
1140
1135
  you can use a pattern for multiple ids, such as bit tag "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
1141
1136
 
1142
- `bit tag [id...]`
1143
-
1144
- | **Option** | **Option alias** | **Description** |
1145
- | ---------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------- |
1146
- | `--message <message>` | `-m` | log message describing the user changes |
1147
- | `--unmodified` | | include unmodified components (by default, only new and modified components are tagged) |
1148
- | `--editor [editor]` | | EXPERIMENTAL. open an editor to edit the tag messages per component, optionally specify the editor-name, default to vim |
1149
- | `--ver <version>` | `-v` | tag with the given version |
1150
- | `--patch` | `-p` | increment the patch version number |
1151
- | `--minor` | | increment the minor version number |
1152
- | `--major` | | increment the major version number |
1153
- | `--snapped` | | tag components that their head is a snap (not a tag) |
1154
- | `--pre-release [identifier]` | | EXPERIMENTAL. increment a pre-release version (e.g. 1.0.0-dev.1) |
1155
- | `--skip-tests` | | skip running component tests during tag process |
1156
- | `--skip-auto-tag` | | skip auto tagging dependents |
1157
- | `--soft` | | do not persist. only keep note of the changes to be made |
1158
- | `--persist` | | persist the changes generated by --soft tag |
1159
- | `--disable-tag-pipeline` | | skip the tag pipeline to avoid publishing the components |
1160
- | `--force-deploy` | | run the tag pipeline although the build failed |
1161
- | `--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. |
1162
- | `--ignore-issues [issues]` | `-i` | ignore component issues (shown in "bit status" as "issues found"), issues to ignore: |
1137
+ `bit tag [component-names...]`
1138
+
1139
+ | **Option** | **Option alias** | **Description** |
1140
+ | ---------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------ |
1141
+ | `--message <message>` | `-m` | a log message describing latest changes |
1142
+ | `--unmodified` | | include unmodified components (by default, only new and modified components are tagged) |
1143
+ | `--editor [editor]` | | EXPERIMENTAL. open an editor to write a tag message for each component. optionally, specify the editor-name (defaults to vim). |
1144
+ | `--ver <version>` | `-v` | tag with the given version |
1145
+ | `--increment <level>` | `-l` | options are: [major, premajor, minor, preminor, patch, prepatch, prerelease], default to patch |
1146
+ | `--prerelease-id <id>` | | prerelease identifier (e.g. "dev" to get "1.0.0-dev.1") |
1147
+ | `--patch` | `-p` | syntactic sugar for "--increment patch" |
1148
+ | `--minor` | | syntactic sugar for "--increment minor" |
1149
+ | `--major` | | syntactic sugar for "--increment major" |
1150
+ | `--snapped` | | EXPERIMENTAL. tag components that their head is a snap (not a tag) |
1151
+ | `--pre-release [identifier]` | | DEPRECATED. use "-l prerelease" (and --prerelease-id) instead |
1152
+ | `--skip-tests` | | skip running component tests during tag process |
1153
+ | `--skip-auto-tag` | | skip auto tagging dependents |
1154
+ | `--soft` | | do not persist. only keep note of the changes to be made |
1155
+ | `--persist` | | persist the changes generated by --soft tag |
1156
+ | `--disable-tag-pipeline` | | skip the tag pipeline to avoid publishing the components |
1157
+ | `--force-deploy` | | run the tag pipeline although the build failed |
1158
+ | `--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. |
1159
+ | `--ignore-issues [issues]` | `-i` | ignore component issues (shown in "bit status" as "issues found"), issues to ignore: |
1163
1160
 
1164
1161
  [MissingPackagesDependenciesOnFs, MissingComponents, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingLinks, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, MissingCustomModuleResolutionLinks, ImportNonMainFiles, CustomModuleResolutionUsed, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies]
1165
1162
  to ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify "\*".|
@@ -1190,19 +1187,19 @@ list components templates when inside bit-workspace (for bit-create), otherwise,
1190
1187
 
1191
1188
  **Alias**: `at`
1192
1189
  **Workspace only**: yes
1193
- **Description**: test set of components in your workspace
1190
+ **Description**: test components in the workspace
1194
1191
 
1195
- `bit test [pattern]`
1192
+ `bit test [component-pattern]`
1196
1193
 
1197
- | **Option** | **Option alias** | **Description** |
1198
- | -------------------- | :--------------: | -------------------------------------------------------------------- |
1199
- | `--watch` | `-w` | start the tester in watch mode. |
1200
- | `--debug` | `-d` | start the tester in debug mode. |
1201
- | `--all` | `-a` | test all components, not only new and modified |
1202
- | `--junit <filepath>` | | write tests results as JUnit XML format into the specified file path |
1203
- | `--coverage` | | show code coverage data |
1204
- | `--env <id>` | `-e` | test only the given env |
1205
- | `--scope <scope>` | `-s` | name of the scope to test |
1194
+ | **Option** | **Option alias** | **Description** |
1195
+ | ---------------------- | :--------------: | -------------------------------------------------------------------- |
1196
+ | `--watch` | `-w` | start the tester in watch mode. |
1197
+ | `--debug` | `-d` | start the tester in debug mode. |
1198
+ | `--all` | `-a` | test all components, not only new and modified |
1199
+ | `--junit <filepath>` | | write tests results as JUnit XML format into the specified file path |
1200
+ | `--coverage` | | show code coverage data |
1201
+ | `--env <id>` | `-e` | test only the given env |
1202
+ | `--scope <scope-name>` | `-s` | name of the scope to test |
1206
1203
 
1207
1204
  ---
1208
1205
 
@@ -1269,9 +1266,9 @@ you can use a pattern for multiple ids, such as bit untag "utils/\*". (wrap the
1269
1266
  ## use
1270
1267
 
1271
1268
  **Workspace only**: yes
1272
- **Description**: set up aspects in the workspace/scope config
1269
+ **Description**: set aspects in the workspace/scope config to make them loadable by the workspace/scope
1273
1270
 
1274
- `bit use [ids...]`
1271
+ `bit use [component-ids...]`
1275
1272
 
1276
1273
  ---
1277
1274