@teambit/harmony.content.cli-reference 0.0.0-e151f1140f413eac89799c457c5feedc313faa4f → 0.0.0-e322c823e62e42e4b09f7dcfe3c8882d1909e5ce

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 (14) hide show
  1. package/cli-reference.docs.mdx +1 -1
  2. package/cli-reference.json +223 -179
  3. package/cli-reference.mdx +104 -96
  4. package/dist/cli-reference.composition.js +4 -11
  5. package/dist/cli-reference.composition.js.map +1 -1
  6. package/dist/cli-reference.docs.mdx +1 -1
  7. package/dist/cli-reference.json +223 -179
  8. package/dist/cli-reference.mdx.js +1 -1
  9. package/dist/cli-reference.mdx.js.map +1 -1
  10. package/dist/index.js +1 -9
  11. package/dist/index.js.map +1 -1
  12. package/dist/{preview-1781020089154.js → preview-1783451158181.js} +2 -2
  13. package/package.json +7 -15
  14. package/types/asset.d.ts +15 -1
package/cli-reference.mdx CHANGED
@@ -229,24 +229,24 @@ because this process can take a while on large workspaces, various flags are ava
229
229
  | ------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
230
230
  | `component-pattern` | component name, component id, component pattern, or relative directory path. use component pattern to select multiple components. wrap the pattern with quotes. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button". use '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'. use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
231
231
 
232
- | **Option** | **Option alias** | **Description** |
233
- | ---------------------------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
234
- | `--unmodified` | `-u` | include unmodified components (by default, only new and modified components are built) |
235
- | `--dev` | `-d` | run the pipeline in dev mode |
236
- | `--install` | | install core aspects in capsules |
237
- | `--reuse-capsules` | | avoid deleting the capsules root-dir before starting the build |
238
- | `--rewrite` | | use only with --reuse-capsules. rewrite the component files |
239
- | `--reinstall` | | use only with --reuse-capsules. rerun the installation |
240
- | `--tasks <string>` | | build the specified task(s) only. for multiple tasks, separate by a comma and wrap with quotes. specify the task-name (e.g. "TypescriptCompiler") or the task-aspect-id (e.g. teambit.compilation/compiler) |
241
- | `--cache-packages-on-capsule-root` | | set the package-manager cache on the capsule root |
242
- | `--list-tasks <string>` | | list tasks of an env or a component-id for each one of the pipelines: build, tag and snap |
243
- | `--skip-tests` | | skip running component tests during build process |
244
- | `--loose` | | allow build to succeed even if tasks like tests or lint fail |
245
- | `--skip-tasks <string>` | | skip the given tasks. for multiple tasks, separate by a comma and wrap with quotes. specify the task-name (e.g. "TypescriptCompiler") or the task-aspect-id (e.g. teambit.compilation/compiler) |
246
- | `--fail-fast` | | stop pipeline execution on the first failed task (by default a task is skipped only when its dependency failed) |
247
- | `--include-snap` | | include snap pipeline tasks. Warning: this may deploy/publish if you have such tasks |
248
- | `--include-tag` | | include tag pipeline tasks. Warning: this may deploy/publish if you have such tasks |
249
- | `--ignore-issues <issues>` | `-i` | ignore component issues (shown in "bit status" as "issues found"), issues to ignore: [MissingPackagesDependenciesOnFs, MissingManuallyConfiguredPackages, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies, DuplicateComponentAndPackage, MergeConfigHasConflict, NonLoadedEnv, ExternalEnvWithoutVersion, RemovedDependencies, RemovedEnv, DeprecatedDependencies, SelfReference, ImportFromDirectory] to ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify "\*". |
232
+ | **Option** | **Option alias** | **Description** |
233
+ | ---------------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
234
+ | `--unmodified` | `-u` | include unmodified components (by default, only new and modified components are built) |
235
+ | `--dev` | `-d` | run the pipeline in dev mode |
236
+ | `--install` | | install core aspects in capsules |
237
+ | `--reuse-capsules` | | avoid deleting the capsules root-dir before starting the build |
238
+ | `--rewrite` | | use only with --reuse-capsules. rewrite the component files |
239
+ | `--reinstall` | | use only with --reuse-capsules. rerun the installation |
240
+ | `--tasks <string>` | | build the specified task(s) only. for multiple tasks, separate by a comma and wrap with quotes. specify the task-name (e.g. "TypescriptCompiler") or the task-aspect-id (e.g. teambit.compilation/compiler) |
241
+ | `--cache-packages-on-capsule-root` | | set the package-manager cache on the capsule root |
242
+ | `--list-tasks <string>` | | list tasks of an env or a component-id for each one of the pipelines: build, tag and snap |
243
+ | `--skip-tests` | | skip running component tests during build process |
244
+ | `--loose` | | allow build to succeed even if tasks like tests or lint fail |
245
+ | `--skip-tasks <string>` | | skip the given tasks. for multiple tasks, separate by a comma and wrap with quotes. specify the task-name (e.g. "TypescriptCompiler") or the task-aspect-id (e.g. teambit.compilation/compiler) |
246
+ | `--fail-fast` | | stop pipeline execution on the first failed task (by default a task is skipped only when its dependency failed) |
247
+ | `--include-snap` | | include snap pipeline tasks. Warning: this may deploy/publish if you have such tasks |
248
+ | `--include-tag` | | include tag pipeline tasks. Warning: this may deploy/publish if you have such tasks |
249
+ | `--ignore-issues <issues>` | `-i` | ignore component issues (shown in "bit status" as "issues found"), issues to ignore: [MissingPackagesDependenciesOnFs, MissingManuallyConfiguredPackages, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies, DuplicateComponentAndPackage, MergeConfigHasConflict, NonLoadedEnv, ExternalEnvWithoutVersion, RemovedDependencies, RemovedEnv, DeprecatedDependencies, SelfReference, ImportFromDirectory, LoadFailures] to ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify "\*". |
250
250
 
251
251
  ---
252
252
 
@@ -313,7 +313,6 @@ use --dry-run first to preview what would be removed.
313
313
  | `--older-than <days>` | | age threshold in days for aspect-version/scope capsule pruning (default 30) |
314
314
  | `--keep-workspace-caps` | | skip workspace capsule deletion |
315
315
  | `--no-orphans` | | don't delete capsules whose origin path no longer exists |
316
- | `--size-target <gb>` | | after standard pruning, LRU-evict aspect-versions until total drops below this size (forces --with-sizes) |
317
316
  | `--dry-run` | | preview what would be removed without deleting |
318
317
  | `--with-sizes` | | compute byte sizes for the report (walks the full cache; slow on large caches). default: off — sizes shown as 0 but the prune itself is instant. |
319
318
  | `--json` | `-j` | json format |
@@ -420,16 +419,18 @@ Runs lint, build, and status checks to catch dependency drift or broken builds e
420
419
  **Usage**: `ci pr`
421
420
 
422
421
  **Description**: Exports a feature lane to Bit Cloud when a Pull Request is opened or updated.
423
- Resolves the lane name from --lane or the current Git branch, validates it, and runs install, status, snap, and export. Cleans up by switching back to main. Use in pull-request CI pipelines after tests and before deploy.
424
-
425
- | **Option** | **Option alias** | **Description** |
426
- | --------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------ |
427
- | `--message <message>` | `-m` | If set, set it as the snap message, if not, try and grab from git-commit-message |
428
- | `--lane <lane>` | `-l` | If set, use as the lane name, if not available, grab from git-branch name |
429
- | `--build` | `-b` | Set to true to build the app locally, false (default) will build on Ripple CI |
430
- | `--strict` | `-s` | Set to true to fail on warnings as well as errors, false (default) only fails on errors |
431
- | `--dry-run` | `-d` | Run the full pipeline but skip exporting to remote (build runs only if --build is set) |
432
- | `--keep-lane` | | Reuse the same remote lane across PR commits (preserves lane history and cloud UI edits) instead of recreating it on every run |
422
+ Resolves the lane name from --lane or the current Git branch, validates it, and runs install, status, snap, and export. By default it then restores the workspace by switching back to main; pass --skip-cleanup to skip that restore when the workspace is about to be discarded (e.g. an ephemeral CI container). PR builds run the full pipeline by default; to trade specific tasks for speed on a given PR, add a [skip-tasks: ...] token to the commit message (e.g. [skip-tasks: GeneratePreview,ExtractSchema]), which merges with any --skip-tasks flag. Use in pull-request CI pipelines after tests and before deploy.
423
+
424
+ | **Option** | **Option alias** | **Description** |
425
+ | ---------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
426
+ | `--message <message>` | `-m` | If set, set it as the snap message, if not, try and grab from git-commit-message |
427
+ | `--lane <lane>` | `-l` | If set, use as the lane name, if not available, grab from git-branch name |
428
+ | `--build` | `-b` | Set to true to build the app locally, false (default) will build on Ripple CI |
429
+ | `--strict` | `-s` | Set to true to fail on warnings as well as errors, false (default) only fails on errors |
430
+ | `--dry-run` | `-d` | Run the full pipeline but skip exporting to remote (build runs only if --build is set) |
431
+ | `--keep-lane` | | Reuse the same remote lane across PR commits (preserves lane history and cloud UI edits) instead of recreating it on every run |
432
+ | `--skip-cleanup` | | Skip restoring the workspace (switching back to main) after export. Use when the workspace is discarded right after, e.g. an ephemeral CI container |
433
+ | `--skip-tasks <tasks>` | | Comma-separated list of build/publish task names (or aspect-ids) to skip during snap, e.g. "ExtractSchema,GeneratePreview,GenerateEnvTemplate,PublishComponents". Speeds up PR builds by trading optional artifacts (schema/preview) and publishing for build time; they are produced on the final export to main |
433
434
 
434
435
  ### ci merge
435
436
 
@@ -627,21 +628,22 @@ shows both direct and transitive dependents organized by their origin (workspace
627
628
  ## deprecate
628
629
 
629
630
  **Alias**: `d`
630
- **Description**: mark a component as deprecated to discourage its use
631
- marks a component as deprecated locally, then after snap/tag and export it becomes deprecated in the remote scope.
632
- optionally specify a replacement component or deprecate only specific version ranges.
631
+ **Description**: mark components as deprecated to discourage their use
632
+ marks components as deprecated locally, then after snap/tag and export they become deprecated in the remote scope.
633
+ the pattern can match multiple components, so several can be deprecated at once.
634
+ optionally specify a replacement component (single component only) or deprecate only specific version ranges.
633
635
  deprecated components remain available but display warnings when installed or imported.
634
636
 
635
- `bit deprecate <component-name>`
637
+ `bit deprecate <component-pattern>`
636
638
 
637
- | **Arg** | **Description** |
638
- | ---------------- | :----------------------------: |
639
- | `component-name` | component name or component id |
639
+ | **Arg** | **Description** |
640
+ | ------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
641
+ | `component-pattern` | component name, component id, component pattern, or relative directory path. use component pattern to select multiple components. wrap the pattern with quotes. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button". use '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'. use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
640
642
 
641
- | **Option** | **Option alias** | **Description** |
642
- | ------------------- | :--------------: | --------------------------------------------------------------------------------------------------------------------------------- |
643
- | `--new-id <string>` | | if replaced by another component, enter the new component id. alternatively use "bit rename --deprecate" to do this automatically |
644
- | `--range <string>` | | enter a Semver range to deprecate specific versions. see https://www.npmjs.com/package/semver#ranges for the range syntax |
643
+ | **Option** | **Option alias** | **Description** |
644
+ | ------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
645
+ | `--new-id <string>` | | if replaced by another component, enter the new component id. alternatively use "bit rename --deprecate" to do this automatically. only valid when the pattern matches a single component |
646
+ | `--range <string>` | | enter a Semver range to deprecate specific versions. see https://www.npmjs.com/package/semver#ranges for the range syntax |
645
647
 
646
648
  ---
647
649
 
@@ -2569,24 +2571,24 @@ snapshots maintain component history and enable collaboration without formal rel
2569
2571
  | ------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
2570
2572
  | `component-pattern` | component name, component id, component pattern, or relative directory path. use component pattern to select multiple components. wrap the pattern with quotes. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button". use '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'. use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.. By default, only new and modified components are snapped (add --unmodified to snap all components in the workspace). |
2571
2573
 
2572
- | **Option** | **Option alias** | **Description** |
2573
- | -------------------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2574
- | `--message <message>` | `-m` | snap message describing the latest changes - will appear in component history log |
2575
- | `--unmodified` | `-u` | include unmodified components (by default, only new and modified components are snapped) |
2576
- | `--unmerged` | | complete a merge process by snapping the unmerged components |
2577
- | `--build` | `-b` | locally run the build pipeline (i.e. not via rippleCI) and complete the snap |
2578
- | `--editor [editor]` | | open an editor to write a snap message per component. optionally specify the editor-name (defaults to vim). |
2579
- | `--skip-tests` | | skip running component tests during snap process |
2580
- | `--skip-tasks <string>` | | skip the given tasks. for multiple tasks, separate by a comma and wrap with quotes. specify the task-name (e.g. "TypescriptCompiler") or the task-aspect-id (e.g. teambit.compilation/compiler) |
2581
- | `--skip-auto-snap` | | skip auto snapping dependents |
2582
- | `--disable-snap-pipeline` | | skip the snap pipeline. this will for instance skip packing and publishing component version for install, and app deployment |
2583
- | `--ignore-build-errors` | | proceed to snap pipeline even when build pipeline fails |
2584
- | `--loose` | | allow snap --build to succeed even if tasks like tests or lint fail |
2585
- | `--rebuild-deps-graph` | | do not reuse the saved dependencies graph, instead build it from scratch |
2586
- | `--no-lock-deps` | | do not save the dependencies graph in the snap |
2587
- | `--ignore-issues <issues>` | `-i` | ignore component issues (shown in "bit status" as "issues found"), issues to ignore: [MissingPackagesDependenciesOnFs, MissingManuallyConfiguredPackages, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies, DuplicateComponentAndPackage, MergeConfigHasConflict, NonLoadedEnv, ExternalEnvWithoutVersion, RemovedDependencies, RemovedEnv, DeprecatedDependencies, SelfReference, ImportFromDirectory] to ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify "\*". |
2588
- | `--fail-fast` | | stop pipeline execution on the first failed task (by default a task is skipped only when its dependency failed) |
2589
- | `--detach-head` | | UNSUPPORTED YET. in case a component is checked out to an older version, snap it without changing the head |
2574
+ | **Option** | **Option alias** | **Description** |
2575
+ | -------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2576
+ | `--message <message>` | `-m` | snap message describing the latest changes - will appear in component history log |
2577
+ | `--unmodified` | `-u` | include unmodified components (by default, only new and modified components are snapped) |
2578
+ | `--unmerged` | | complete a merge process by snapping the unmerged components |
2579
+ | `--build` | `-b` | locally run the build pipeline (i.e. not via rippleCI) and complete the snap |
2580
+ | `--editor [editor]` | | open an editor to write a snap message per component. optionally specify the editor-name (defaults to vim). |
2581
+ | `--skip-tests` | | skip running component tests during snap process |
2582
+ | `--skip-tasks <string>` | | skip the given tasks. for multiple tasks, separate by a comma and wrap with quotes. specify the task-name (e.g. "TypescriptCompiler") or the task-aspect-id (e.g. teambit.compilation/compiler) |
2583
+ | `--skip-auto-snap` | | skip auto snapping dependents |
2584
+ | `--disable-snap-pipeline` | | skip the snap pipeline. this will for instance skip packing and publishing component version for install, and app deployment |
2585
+ | `--ignore-build-errors` | | proceed to snap pipeline even when build pipeline fails |
2586
+ | `--loose` | | allow snap --build to succeed even if tasks like tests or lint fail |
2587
+ | `--rebuild-deps-graph` | | do not reuse the saved dependencies graph, instead build it from scratch |
2588
+ | `--no-lock-deps` | | do not save the dependencies graph in the snap |
2589
+ | `--ignore-issues <issues>` | `-i` | ignore component issues (shown in "bit status" as "issues found"), issues to ignore: [MissingPackagesDependenciesOnFs, MissingManuallyConfiguredPackages, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies, DuplicateComponentAndPackage, MergeConfigHasConflict, NonLoadedEnv, ExternalEnvWithoutVersion, RemovedDependencies, RemovedEnv, DeprecatedDependencies, SelfReference, ImportFromDirectory, LoadFailures] to ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify "\*". |
2590
+ | `--fail-fast` | | stop pipeline execution on the first failed task (by default a task is skipped only when its dependency failed) |
2591
+ | `--detach-head` | | UNSUPPORTED YET. in case a component is checked out to an older version, snap it without changing the head |
2590
2592
 
2591
2593
  ---
2592
2594
 
@@ -2729,37 +2731,37 @@ use for official releases. for development versions, use 'bit snap' instead.
2729
2731
  | ----------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
2730
2732
  | `component-patterns...` | component name, component id, component pattern, or relative directory path. use component pattern to select multiple components. wrap the pattern with quotes. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button". use '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'. use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.. By default, all new and modified are tagged. |
2731
2733
 
2732
- | **Option** | **Option alias** | **Description** |
2733
- | ---------------------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2734
- | `--message <message>` | `-m` | a log message describing latest changes |
2735
- | `--unmodified` | `-u` | include unmodified components (by default, only new and modified components are tagged) |
2736
- | `--editor [editor]` | | open an editor to write a tag message for each component. optionally, specify the editor-name (defaults to vim). |
2737
- | `--versions-file <path>` | | path to a file containing component versions. format: "component-id: version" |
2738
- | `--ver <version>` | `-v` | tag with the given version |
2739
- | `--increment <level>` | `-l` | options are: [major, premajor, minor, preminor, patch, prepatch, prerelease], default to patch |
2740
- | `--prerelease-id <id>` | | prerelease identifier (e.g. "dev" to get "1.0.0-dev.1") |
2741
- | `--patch` | `-p` | syntactic sugar for "--increment patch" |
2742
- | `--minor` | | syntactic sugar for "--increment minor" |
2743
- | `--major` | | syntactic sugar for "--increment major" |
2744
- | `--pre-release [identifier]` | | syntactic sugar for "--increment prerelease" and `--prerelease-id <identifier>` |
2745
- | `--snapped` | | tag only components whose head is a snap (not a tag) |
2746
- | `--unmerged` | | complete a merge process by tagging the unmerged components |
2747
- | `--skip-tests` | | skip running component tests during tag process |
2748
- | `--skip-tasks <string>` | | skip the given tasks. for multiple tasks, separate by a comma and wrap with quotes. specify the task-name (e.g. "TypescriptCompiler") or the task-aspect-id (e.g. teambit.compilation/compiler) |
2749
- | `--skip-auto-tag` | | skip auto tagging dependents |
2750
- | `--soft` | | do not persist. only keep note of the changes to be made |
2751
- | `--persist [skip-build]` | | persist the changes generated by --soft tag. by default, run the build pipeline, unless "skip-build" is provided |
2752
- | `--disable-tag-pipeline` | | skip the tag pipeline to avoid publishing the components |
2753
- | `--ignore-build-errors` | | proceed to tag pipeline even when build pipeline fails |
2754
- | `--rebuild-deps-graph` | | do not reuse the saved dependencies graph, instead build it from scratch |
2755
- | `--no-lock-deps` | | do not save the dependencies graph in the tag |
2756
- | `--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. |
2757
- | `--ignore-issues <issues>` | `-i` | ignore component issues (shown in "bit status" as "issues found"), issues to ignore: [MissingPackagesDependenciesOnFs, MissingManuallyConfiguredPackages, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies, DuplicateComponentAndPackage, MergeConfigHasConflict, NonLoadedEnv, ExternalEnvWithoutVersion, RemovedDependencies, RemovedEnv, DeprecatedDependencies, SelfReference, ImportFromDirectory] to ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify "\*". |
2758
- | `--ignore-newest-version` | `-I` | allow tagging even when the component has newer versions e.g. for hotfixes. |
2759
- | `--fail-fast` | | stop pipeline execution on the first failed task (by default a task is skipped only when its dependency failed) |
2760
- | `--build` | `-b` | locally run the build pipeline (i.e. not via rippleCI) and complete the tag |
2761
- | `--loose` | | allow tag --build to succeed even if tasks like tests or lint fail |
2762
- | `--detach-head` | | UNSUPPORTED YET. in case a component is checked out to an older version, tag it without changing the head |
2734
+ | **Option** | **Option alias** | **Description** |
2735
+ | ---------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2736
+ | `--message <message>` | `-m` | a log message describing latest changes |
2737
+ | `--unmodified` | `-u` | include unmodified components (by default, only new and modified components are tagged) |
2738
+ | `--editor [editor]` | | open an editor to write a tag message for each component. optionally, specify the editor-name (defaults to vim). |
2739
+ | `--versions-file <path>` | | path to a file containing component versions. format: "component-id: version" |
2740
+ | `--ver <version>` | `-v` | tag with the given version |
2741
+ | `--increment <level>` | `-l` | options are: [major, premajor, minor, preminor, patch, prepatch, prerelease], default to patch |
2742
+ | `--prerelease-id <id>` | | prerelease identifier (e.g. "dev" to get "1.0.0-dev.1") |
2743
+ | `--patch` | `-p` | syntactic sugar for "--increment patch" |
2744
+ | `--minor` | | syntactic sugar for "--increment minor" |
2745
+ | `--major` | | syntactic sugar for "--increment major" |
2746
+ | `--pre-release [identifier]` | | syntactic sugar for "--increment prerelease" and `--prerelease-id <identifier>` |
2747
+ | `--snapped` | | tag only components whose head is a snap (not a tag) |
2748
+ | `--unmerged` | | complete a merge process by tagging the unmerged components |
2749
+ | `--skip-tests` | | skip running component tests during tag process |
2750
+ | `--skip-tasks <string>` | | skip the given tasks. for multiple tasks, separate by a comma and wrap with quotes. specify the task-name (e.g. "TypescriptCompiler") or the task-aspect-id (e.g. teambit.compilation/compiler) |
2751
+ | `--skip-auto-tag` | | skip auto tagging dependents |
2752
+ | `--soft` | | do not persist. only keep note of the changes to be made |
2753
+ | `--persist [skip-build]` | | persist the changes generated by --soft tag. by default, run the build pipeline, unless "skip-build" is provided |
2754
+ | `--disable-tag-pipeline` | | skip the tag pipeline to avoid publishing the components |
2755
+ | `--ignore-build-errors` | | proceed to tag pipeline even when build pipeline fails |
2756
+ | `--rebuild-deps-graph` | | do not reuse the saved dependencies graph, instead build it from scratch |
2757
+ | `--no-lock-deps` | | do not save the dependencies graph in the tag |
2758
+ | `--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. |
2759
+ | `--ignore-issues <issues>` | `-i` | ignore component issues (shown in "bit status" as "issues found"), issues to ignore: [MissingPackagesDependenciesOnFs, MissingManuallyConfiguredPackages, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies, DuplicateComponentAndPackage, MergeConfigHasConflict, NonLoadedEnv, ExternalEnvWithoutVersion, RemovedDependencies, RemovedEnv, DeprecatedDependencies, SelfReference, ImportFromDirectory, LoadFailures] to ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify "\*". |
2760
+ | `--ignore-newest-version` | `-I` | allow tagging even when the component has newer versions e.g. for hotfixes. |
2761
+ | `--fail-fast` | | stop pipeline execution on the first failed task (by default a task is skipped only when its dependency failed) |
2762
+ | `--build` | `-b` | locally run the build pipeline (i.e. not via rippleCI) and complete the tag |
2763
+ | `--loose` | | allow tag --build to succeed even if tasks like tests or lint fail |
2764
+ | `--detach-head` | | UNSUPPORTED YET. in case a component is checked out to an older version, tag it without changing the head |
2763
2765
 
2764
2766
  ---
2765
2767
 
@@ -2784,13 +2786,14 @@ Lists available templates. Inside a workspace it shows component templates for '
2784
2786
  **Description**: run component tests
2785
2787
  executes tests using the testing framework configured by each component's environment (Jest, Mocha, etc.).
2786
2788
  by default only runs tests for new and modified components. use --unmodified to test all components.
2789
+ to run specific test files only, pass their paths instead of a component pattern, e.g. "bit test path/to/comp/my-comp.spec.ts".
2787
2790
  supports watch mode, coverage reporting, and debug mode for development workflows.
2788
2791
 
2789
- `bit test [component-pattern]`
2792
+ `bit test [pattern-or-test-file...]`
2790
2793
 
2791
- | **Arg** | **Description** |
2792
- | ------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
2793
- | `component-pattern` | component name, component id, component pattern, or relative directory path. use component pattern to select multiple components. wrap the pattern with quotes. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button". use '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'. use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
2794
+ | **Arg** | **Description** |
2795
+ | ------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
2796
+ | `pattern-or-test-file...` | one of two modes (multiple values are supported, separated by spaces): 1) component pattern: component name, component id, component pattern, or relative directory path. use component pattern to select multiple components. wrap the pattern with quotes. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button". use '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'. use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. 2) test-file path: a path to a test file, to run only this file, e.g. "bit test path/to/comp/my-comp.spec.ts". note that a directory path selects the component in that directory and runs all its tests, while a test-file path runs only that file |
2794
2797
 
2795
2798
  | **Option** | **Option alias** | **Description** |
2796
2799
  | ---------------------- | :--------------: | ----------------------------------------------------------------------------------------------- |
@@ -2811,10 +2814,15 @@ supports watch mode, coverage reporting, and debug mode for development workflow
2811
2814
 
2812
2815
  ## undeprecate
2813
2816
 
2814
- **Description**: remove the deprecation status from a component
2815
- reverses the deprecation of a component, removing warnings and allowing normal use again.
2817
+ **Description**: remove the deprecation status from components
2818
+ reverses the deprecation of components, removing warnings and allowing normal use again.
2819
+ the pattern can match multiple components, so several can be undeprecated at once.
2820
+
2821
+ `bit undeprecate <component-pattern>`
2816
2822
 
2817
- `bit undeprecate <id>`
2823
+ | **Arg** | **Description** |
2824
+ | ------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
2825
+ | `component-pattern` | component name, component id, component pattern, or relative directory path. use component pattern to select multiple components. wrap the pattern with quotes. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button". use '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'. use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
2818
2826
 
2819
2827
  ---
2820
2828
 
package/dist/cli-reference.composition.js CHANGED
@@ -1,13 +1,6 @@
1
- "use strict";
2
- var __importDefault = (this && this.__importDefault) || function (mod) {
3
- return (mod && mod.__esModule) ? mod : { "default": mod };
1
+ import { jsx as _jsx } from "react/jsx-runtime";
2
+ import { CliReference } from './index';
3
+ export const BasicCliReference = () => {
4
+ return _jsx(CliReference, {});
4
5
  };
5
- Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.BasicCliReference = void 0;
7
- const react_1 = __importDefault(require("react"));
8
- const index_1 = require("./index");
9
- const BasicCliReference = () => {
10
- return react_1.default.createElement(index_1.CliReference, null);
11
- };
12
- exports.BasicCliReference = BasicCliReference;
13
6
  //# sourceMappingURL=cli-reference.composition.js.map
package/dist/cli-reference.composition.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"cli-reference.composition.js","sourceRoot":"","sources":["../cli-reference.composition.tsx"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAC1B,mCAAuC;AAEhC,MAAM,iBAAiB,GAAG,GAAG,EAAE;IACpC,OAAO,8BAAC,oBAAY,OAAG,CAAC;AAC1B,CAAC,CAAC;AAFW,QAAA,iBAAiB,qBAE5B"}
1
+ {"version":3,"file":"cli-reference.composition.js","sourceRoot":"","sources":["../cli-reference.composition.tsx"],"names":[],"mappings":";AACA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAEvC,MAAM,CAAC,MAAM,iBAAiB,GAAG,GAAG,EAAE;IACpC,OAAO,KAAC,YAAY,KAAG,CAAC;AAC1B,CAAC,CAAC"}
package/dist/cli-reference.docs.mdx CHANGED
@@ -1,4 +1,4 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.13.205'
2
+ description: 'Bit command synopses. Bit version: 2.0.6'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---