@teambit/harmony.content.cli-reference 2.0.1083 → 2.0.1084
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/cli-reference.docs.mdx +1 -1
- package/cli-reference.json +24 -3
- package/cli-reference.mdx +67 -67
- package/dist/cli-reference.docs.mdx +1 -1
- package/dist/cli-reference.json +24 -3
- package/dist/cli-reference.mdx.js +1 -1
- package/dist/cli-reference.mdx.js.map +1 -1
- package/dist/{preview-1781544183062.js → preview-1781551713034.js} +2 -2
- package/package.json +2 -2
package/cli-reference.docs.mdx
CHANGED
package/cli-reference.json
CHANGED
|
@@ -1060,6 +1060,27 @@
|
|
|
1060
1060
|
}
|
|
1061
1061
|
]
|
|
1062
1062
|
},
|
|
1063
|
+
{
|
|
1064
|
+
"name": "debug-load <component-id>",
|
|
1065
|
+
"alias": "",
|
|
1066
|
+
"options": [
|
|
1067
|
+
[
|
|
1068
|
+
"j",
|
|
1069
|
+
"json",
|
|
1070
|
+
"return the load trace in json format"
|
|
1071
|
+
]
|
|
1072
|
+
],
|
|
1073
|
+
"description": "EXPERIMENTAL. load a component with tracing enabled and explain how it was loaded",
|
|
1074
|
+
"extendedDescription": "clears the component's caches and loads it fresh, then prints: the load stages with timings and\ncache hits/misses, the sources that contributed each extension (and which one won the merge),\nthe resolved env and which source determined it, and any load issues found.",
|
|
1075
|
+
"group": "info-analysis",
|
|
1076
|
+
"private": true,
|
|
1077
|
+
"arguments": [
|
|
1078
|
+
{
|
|
1079
|
+
"name": "component-id",
|
|
1080
|
+
"description": "the component id to load"
|
|
1081
|
+
}
|
|
1082
|
+
]
|
|
1083
|
+
},
|
|
1063
1084
|
{
|
|
1064
1085
|
"name": "pattern <pattern>",
|
|
1065
1086
|
"alias": "",
|
|
@@ -2078,7 +2099,7 @@
|
|
|
2078
2099
|
[
|
|
2079
2100
|
"i",
|
|
2080
2101
|
"ignore-issues <issues>",
|
|
2081
|
-
"ignore component issues (shown in \"bit status\" as \"issues found\"), issues to ignore:\n[MissingPackagesDependenciesOnFs, MissingManuallyConfiguredPackages, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies, DuplicateComponentAndPackage, MergeConfigHasConflict, NonLoadedEnv, ExternalEnvWithoutVersion, RemovedDependencies, RemovedEnv, DeprecatedDependencies, SelfReference, ImportFromDirectory]\nto ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify \"*\"."
|
|
2102
|
+
"ignore component issues (shown in \"bit status\" as \"issues found\"), issues to ignore:\n[MissingPackagesDependenciesOnFs, MissingManuallyConfiguredPackages, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies, DuplicateComponentAndPackage, MergeConfigHasConflict, NonLoadedEnv, ExternalEnvWithoutVersion, RemovedDependencies, RemovedEnv, DeprecatedDependencies, SelfReference, ImportFromDirectory, LoadFailures]\nto ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify \"*\"."
|
|
2082
2103
|
]
|
|
2083
2104
|
],
|
|
2084
2105
|
"description": "run build pipeline tasks in isolated environments",
|
|
@@ -3504,7 +3525,7 @@
|
|
|
3504
3525
|
[
|
|
3505
3526
|
"i",
|
|
3506
3527
|
"ignore-issues <issues>",
|
|
3507
|
-
"ignore component issues (shown in \"bit status\" as \"issues found\"), issues to ignore:\n[MissingPackagesDependenciesOnFs, MissingManuallyConfiguredPackages, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies, DuplicateComponentAndPackage, MergeConfigHasConflict, NonLoadedEnv, ExternalEnvWithoutVersion, RemovedDependencies, RemovedEnv, DeprecatedDependencies, SelfReference, ImportFromDirectory]\nto ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify \"*\"."
|
|
3528
|
+
"ignore component issues (shown in \"bit status\" as \"issues found\"), issues to ignore:\n[MissingPackagesDependenciesOnFs, MissingManuallyConfiguredPackages, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies, DuplicateComponentAndPackage, MergeConfigHasConflict, NonLoadedEnv, ExternalEnvWithoutVersion, RemovedDependencies, RemovedEnv, DeprecatedDependencies, SelfReference, ImportFromDirectory, LoadFailures]\nto ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify \"*\"."
|
|
3508
3529
|
],
|
|
3509
3530
|
[
|
|
3510
3531
|
"I",
|
|
@@ -3622,7 +3643,7 @@
|
|
|
3622
3643
|
[
|
|
3623
3644
|
"i",
|
|
3624
3645
|
"ignore-issues <issues>",
|
|
3625
|
-
"ignore component issues (shown in \"bit status\" as \"issues found\"), issues to ignore:\n[MissingPackagesDependenciesOnFs, MissingManuallyConfiguredPackages, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies, DuplicateComponentAndPackage, MergeConfigHasConflict, NonLoadedEnv, ExternalEnvWithoutVersion, RemovedDependencies, RemovedEnv, DeprecatedDependencies, SelfReference, ImportFromDirectory]\nto ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify \"*\"."
|
|
3646
|
+
"ignore component issues (shown in \"bit status\" as \"issues found\"), issues to ignore:\n[MissingPackagesDependenciesOnFs, MissingManuallyConfiguredPackages, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies, DuplicateComponentAndPackage, MergeConfigHasConflict, NonLoadedEnv, ExternalEnvWithoutVersion, RemovedDependencies, RemovedEnv, DeprecatedDependencies, SelfReference, ImportFromDirectory, LoadFailures]\nto ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify \"*\"."
|
|
3626
3647
|
],
|
|
3627
3648
|
[
|
|
3628
3649
|
"",
|
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
|
|
|
@@ -2568,24 +2568,24 @@ snapshots maintain component history and enable collaboration without formal rel
|
|
|
2568
2568
|
| ------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
2569
2569
|
| `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). |
|
|
2570
2570
|
|
|
2571
|
-
| **Option** | **Option alias** | **Description**
|
|
2572
|
-
| -------------------------- | :--------------: |
|
|
2573
|
-
| `--message <message>` | `-m` | snap message describing the latest changes - will appear in component history log
|
|
2574
|
-
| `--unmodified` | `-u` | include unmodified components (by default, only new and modified components are snapped)
|
|
2575
|
-
| `--unmerged` | | complete a merge process by snapping the unmerged components
|
|
2576
|
-
| `--build` | `-b` | locally run the build pipeline (i.e. not via rippleCI) and complete the snap
|
|
2577
|
-
| `--editor [editor]` | | open an editor to write a snap message per component. optionally specify the editor-name (defaults to vim).
|
|
2578
|
-
| `--skip-tests` | | skip running component tests during snap process
|
|
2579
|
-
| `--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)
|
|
2580
|
-
| `--skip-auto-snap` | | skip auto snapping dependents
|
|
2581
|
-
| `--disable-snap-pipeline` | | skip the snap pipeline. this will for instance skip packing and publishing component version for install, and app deployment
|
|
2582
|
-
| `--ignore-build-errors` | | proceed to snap pipeline even when build pipeline fails
|
|
2583
|
-
| `--loose` | | allow snap --build to succeed even if tasks like tests or lint fail
|
|
2584
|
-
| `--rebuild-deps-graph` | | do not reuse the saved dependencies graph, instead build it from scratch
|
|
2585
|
-
| `--no-lock-deps` | | do not save the dependencies graph in the snap
|
|
2586
|
-
| `--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 "\*". |
|
|
2587
|
-
| `--fail-fast` | | stop pipeline execution on the first failed task (by default a task is skipped only when its dependency failed)
|
|
2588
|
-
| `--detach-head` | | UNSUPPORTED YET. in case a component is checked out to an older version, snap it without changing the head
|
|
2571
|
+
| **Option** | **Option alias** | **Description** |
|
|
2572
|
+
| -------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2573
|
+
| `--message <message>` | `-m` | snap message describing the latest changes - will appear in component history log |
|
|
2574
|
+
| `--unmodified` | `-u` | include unmodified components (by default, only new and modified components are snapped) |
|
|
2575
|
+
| `--unmerged` | | complete a merge process by snapping the unmerged components |
|
|
2576
|
+
| `--build` | `-b` | locally run the build pipeline (i.e. not via rippleCI) and complete the snap |
|
|
2577
|
+
| `--editor [editor]` | | open an editor to write a snap message per component. optionally specify the editor-name (defaults to vim). |
|
|
2578
|
+
| `--skip-tests` | | skip running component tests during snap process |
|
|
2579
|
+
| `--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) |
|
|
2580
|
+
| `--skip-auto-snap` | | skip auto snapping dependents |
|
|
2581
|
+
| `--disable-snap-pipeline` | | skip the snap pipeline. this will for instance skip packing and publishing component version for install, and app deployment |
|
|
2582
|
+
| `--ignore-build-errors` | | proceed to snap pipeline even when build pipeline fails |
|
|
2583
|
+
| `--loose` | | allow snap --build to succeed even if tasks like tests or lint fail |
|
|
2584
|
+
| `--rebuild-deps-graph` | | do not reuse the saved dependencies graph, instead build it from scratch |
|
|
2585
|
+
| `--no-lock-deps` | | do not save the dependencies graph in the snap |
|
|
2586
|
+
| `--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 "\*". |
|
|
2587
|
+
| `--fail-fast` | | stop pipeline execution on the first failed task (by default a task is skipped only when its dependency failed) |
|
|
2588
|
+
| `--detach-head` | | UNSUPPORTED YET. in case a component is checked out to an older version, snap it without changing the head |
|
|
2589
2589
|
|
|
2590
2590
|
---
|
|
2591
2591
|
|
|
@@ -2728,37 +2728,37 @@ use for official releases. for development versions, use 'bit snap' instead.
|
|
|
2728
2728
|
| ----------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
2729
2729
|
| `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. |
|
|
2730
2730
|
|
|
2731
|
-
| **Option** | **Option alias** | **Description**
|
|
2732
|
-
| ---------------------------- | :--------------: |
|
|
2733
|
-
| `--message <message>` | `-m` | a log message describing latest changes
|
|
2734
|
-
| `--unmodified` | `-u` | include unmodified components (by default, only new and modified components are tagged)
|
|
2735
|
-
| `--editor [editor]` | | open an editor to write a tag message for each component. optionally, specify the editor-name (defaults to vim).
|
|
2736
|
-
| `--versions-file <path>` | | path to a file containing component versions. format: "component-id: version"
|
|
2737
|
-
| `--ver <version>` | `-v` | tag with the given version
|
|
2738
|
-
| `--increment <level>` | `-l` | options are: [major, premajor, minor, preminor, patch, prepatch, prerelease], default to patch
|
|
2739
|
-
| `--prerelease-id <id>` | | prerelease identifier (e.g. "dev" to get "1.0.0-dev.1")
|
|
2740
|
-
| `--patch` | `-p` | syntactic sugar for "--increment patch"
|
|
2741
|
-
| `--minor` | | syntactic sugar for "--increment minor"
|
|
2742
|
-
| `--major` | | syntactic sugar for "--increment major"
|
|
2743
|
-
| `--pre-release [identifier]` | | syntactic sugar for "--increment prerelease" and `--prerelease-id <identifier>`
|
|
2744
|
-
| `--snapped` | | tag only components whose head is a snap (not a tag)
|
|
2745
|
-
| `--unmerged` | | complete a merge process by tagging the unmerged components
|
|
2746
|
-
| `--skip-tests` | | skip running component tests during tag process
|
|
2747
|
-
| `--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)
|
|
2748
|
-
| `--skip-auto-tag` | | skip auto tagging dependents
|
|
2749
|
-
| `--soft` | | do not persist. only keep note of the changes to be made
|
|
2750
|
-
| `--persist [skip-build]` | | persist the changes generated by --soft tag. by default, run the build pipeline, unless "skip-build" is provided
|
|
2751
|
-
| `--disable-tag-pipeline` | | skip the tag pipeline to avoid publishing the components
|
|
2752
|
-
| `--ignore-build-errors` | | proceed to tag pipeline even when build pipeline fails
|
|
2753
|
-
| `--rebuild-deps-graph` | | do not reuse the saved dependencies graph, instead build it from scratch
|
|
2754
|
-
| `--no-lock-deps` | | do not save the dependencies graph in the tag
|
|
2755
|
-
| `--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.
|
|
2756
|
-
| `--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 "\*". |
|
|
2757
|
-
| `--ignore-newest-version` | `-I` | allow tagging even when the component has newer versions e.g. for hotfixes.
|
|
2758
|
-
| `--fail-fast` | | stop pipeline execution on the first failed task (by default a task is skipped only when its dependency failed)
|
|
2759
|
-
| `--build` | `-b` | locally run the build pipeline (i.e. not via rippleCI) and complete the tag
|
|
2760
|
-
| `--loose` | | allow tag --build to succeed even if tasks like tests or lint fail
|
|
2761
|
-
| `--detach-head` | | UNSUPPORTED YET. in case a component is checked out to an older version, tag it without changing the head
|
|
2731
|
+
| **Option** | **Option alias** | **Description** |
|
|
2732
|
+
| ---------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2733
|
+
| `--message <message>` | `-m` | a log message describing latest changes |
|
|
2734
|
+
| `--unmodified` | `-u` | include unmodified components (by default, only new and modified components are tagged) |
|
|
2735
|
+
| `--editor [editor]` | | open an editor to write a tag message for each component. optionally, specify the editor-name (defaults to vim). |
|
|
2736
|
+
| `--versions-file <path>` | | path to a file containing component versions. format: "component-id: version" |
|
|
2737
|
+
| `--ver <version>` | `-v` | tag with the given version |
|
|
2738
|
+
| `--increment <level>` | `-l` | options are: [major, premajor, minor, preminor, patch, prepatch, prerelease], default to patch |
|
|
2739
|
+
| `--prerelease-id <id>` | | prerelease identifier (e.g. "dev" to get "1.0.0-dev.1") |
|
|
2740
|
+
| `--patch` | `-p` | syntactic sugar for "--increment patch" |
|
|
2741
|
+
| `--minor` | | syntactic sugar for "--increment minor" |
|
|
2742
|
+
| `--major` | | syntactic sugar for "--increment major" |
|
|
2743
|
+
| `--pre-release [identifier]` | | syntactic sugar for "--increment prerelease" and `--prerelease-id <identifier>` |
|
|
2744
|
+
| `--snapped` | | tag only components whose head is a snap (not a tag) |
|
|
2745
|
+
| `--unmerged` | | complete a merge process by tagging the unmerged components |
|
|
2746
|
+
| `--skip-tests` | | skip running component tests during tag process |
|
|
2747
|
+
| `--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) |
|
|
2748
|
+
| `--skip-auto-tag` | | skip auto tagging dependents |
|
|
2749
|
+
| `--soft` | | do not persist. only keep note of the changes to be made |
|
|
2750
|
+
| `--persist [skip-build]` | | persist the changes generated by --soft tag. by default, run the build pipeline, unless "skip-build" is provided |
|
|
2751
|
+
| `--disable-tag-pipeline` | | skip the tag pipeline to avoid publishing the components |
|
|
2752
|
+
| `--ignore-build-errors` | | proceed to tag pipeline even when build pipeline fails |
|
|
2753
|
+
| `--rebuild-deps-graph` | | do not reuse the saved dependencies graph, instead build it from scratch |
|
|
2754
|
+
| `--no-lock-deps` | | do not save the dependencies graph in the tag |
|
|
2755
|
+
| `--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. |
|
|
2756
|
+
| `--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 "\*". |
|
|
2757
|
+
| `--ignore-newest-version` | `-I` | allow tagging even when the component has newer versions e.g. for hotfixes. |
|
|
2758
|
+
| `--fail-fast` | | stop pipeline execution on the first failed task (by default a task is skipped only when its dependency failed) |
|
|
2759
|
+
| `--build` | `-b` | locally run the build pipeline (i.e. not via rippleCI) and complete the tag |
|
|
2760
|
+
| `--loose` | | allow tag --build to succeed even if tasks like tests or lint fail |
|
|
2761
|
+
| `--detach-head` | | UNSUPPORTED YET. in case a component is checked out to an older version, tag it without changing the head |
|
|
2762
2762
|
|
|
2763
2763
|
---
|
|
2764
2764
|
|
package/dist/cli-reference.json
CHANGED
|
@@ -1060,6 +1060,27 @@
|
|
|
1060
1060
|
}
|
|
1061
1061
|
]
|
|
1062
1062
|
},
|
|
1063
|
+
{
|
|
1064
|
+
"name": "debug-load <component-id>",
|
|
1065
|
+
"alias": "",
|
|
1066
|
+
"options": [
|
|
1067
|
+
[
|
|
1068
|
+
"j",
|
|
1069
|
+
"json",
|
|
1070
|
+
"return the load trace in json format"
|
|
1071
|
+
]
|
|
1072
|
+
],
|
|
1073
|
+
"description": "EXPERIMENTAL. load a component with tracing enabled and explain how it was loaded",
|
|
1074
|
+
"extendedDescription": "clears the component's caches and loads it fresh, then prints: the load stages with timings and\ncache hits/misses, the sources that contributed each extension (and which one won the merge),\nthe resolved env and which source determined it, and any load issues found.",
|
|
1075
|
+
"group": "info-analysis",
|
|
1076
|
+
"private": true,
|
|
1077
|
+
"arguments": [
|
|
1078
|
+
{
|
|
1079
|
+
"name": "component-id",
|
|
1080
|
+
"description": "the component id to load"
|
|
1081
|
+
}
|
|
1082
|
+
]
|
|
1083
|
+
},
|
|
1063
1084
|
{
|
|
1064
1085
|
"name": "pattern <pattern>",
|
|
1065
1086
|
"alias": "",
|
|
@@ -2078,7 +2099,7 @@
|
|
|
2078
2099
|
[
|
|
2079
2100
|
"i",
|
|
2080
2101
|
"ignore-issues <issues>",
|
|
2081
|
-
"ignore component issues (shown in \"bit status\" as \"issues found\"), issues to ignore:\n[MissingPackagesDependenciesOnFs, MissingManuallyConfiguredPackages, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies, DuplicateComponentAndPackage, MergeConfigHasConflict, NonLoadedEnv, ExternalEnvWithoutVersion, RemovedDependencies, RemovedEnv, DeprecatedDependencies, SelfReference, ImportFromDirectory]\nto ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify \"*\"."
|
|
2102
|
+
"ignore component issues (shown in \"bit status\" as \"issues found\"), issues to ignore:\n[MissingPackagesDependenciesOnFs, MissingManuallyConfiguredPackages, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies, DuplicateComponentAndPackage, MergeConfigHasConflict, NonLoadedEnv, ExternalEnvWithoutVersion, RemovedDependencies, RemovedEnv, DeprecatedDependencies, SelfReference, ImportFromDirectory, LoadFailures]\nto ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify \"*\"."
|
|
2082
2103
|
]
|
|
2083
2104
|
],
|
|
2084
2105
|
"description": "run build pipeline tasks in isolated environments",
|
|
@@ -3504,7 +3525,7 @@
|
|
|
3504
3525
|
[
|
|
3505
3526
|
"i",
|
|
3506
3527
|
"ignore-issues <issues>",
|
|
3507
|
-
"ignore component issues (shown in \"bit status\" as \"issues found\"), issues to ignore:\n[MissingPackagesDependenciesOnFs, MissingManuallyConfiguredPackages, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies, DuplicateComponentAndPackage, MergeConfigHasConflict, NonLoadedEnv, ExternalEnvWithoutVersion, RemovedDependencies, RemovedEnv, DeprecatedDependencies, SelfReference, ImportFromDirectory]\nto ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify \"*\"."
|
|
3528
|
+
"ignore component issues (shown in \"bit status\" as \"issues found\"), issues to ignore:\n[MissingPackagesDependenciesOnFs, MissingManuallyConfiguredPackages, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies, DuplicateComponentAndPackage, MergeConfigHasConflict, NonLoadedEnv, ExternalEnvWithoutVersion, RemovedDependencies, RemovedEnv, DeprecatedDependencies, SelfReference, ImportFromDirectory, LoadFailures]\nto ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify \"*\"."
|
|
3508
3529
|
],
|
|
3509
3530
|
[
|
|
3510
3531
|
"I",
|
|
@@ -3622,7 +3643,7 @@
|
|
|
3622
3643
|
[
|
|
3623
3644
|
"i",
|
|
3624
3645
|
"ignore-issues <issues>",
|
|
3625
|
-
"ignore component issues (shown in \"bit status\" as \"issues found\"), issues to ignore:\n[MissingPackagesDependenciesOnFs, MissingManuallyConfiguredPackages, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies, DuplicateComponentAndPackage, MergeConfigHasConflict, NonLoadedEnv, ExternalEnvWithoutVersion, RemovedDependencies, RemovedEnv, DeprecatedDependencies, SelfReference, ImportFromDirectory]\nto ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify \"*\"."
|
|
3646
|
+
"ignore component issues (shown in \"bit status\" as \"issues found\"), issues to ignore:\n[MissingPackagesDependenciesOnFs, MissingManuallyConfiguredPackages, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies, DuplicateComponentAndPackage, MergeConfigHasConflict, NonLoadedEnv, ExternalEnvWithoutVersion, RemovedDependencies, RemovedEnv, DeprecatedDependencies, SelfReference, ImportFromDirectory, LoadFailures]\nto ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify \"*\"."
|
|
3626
3647
|
],
|
|
3627
3648
|
[
|
|
3628
3649
|
"",
|