@teambit/harmony.content.cli-reference 0.0.0-e151f1140f413eac89799c457c5feedc313faa4f → 0.0.0-e42690afb58e508dc8ee4568e43ec181c116101a
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 +113 -48
- package/cli-reference.mdx +158 -147
- package/dist/cli-reference.composition.js +4 -11
- package/dist/cli-reference.composition.js.map +1 -1
- package/dist/cli-reference.docs.mdx +1 -1
- package/dist/cli-reference.json +113 -48
- package/dist/cli-reference.mdx.js +1 -1
- package/dist/cli-reference.mdx.js.map +1 -1
- package/dist/index.js +1 -9
- package/dist/index.js.map +1 -1
- package/dist/{preview-1781020089154.js → preview-1784303730825.js} +2 -2
- package/package.json +7 -15
- package/types/asset.d.ts +15 -1
package/cli-reference.docs.mdx
CHANGED
package/cli-reference.json
CHANGED
|
@@ -219,6 +219,12 @@
|
|
|
219
219
|
"name": "component-name",
|
|
220
220
|
"description": "the 'component name' or 'component id' of the component whose env you'd like to inspect"
|
|
221
221
|
}
|
|
222
|
+
],
|
|
223
|
+
"examples": [
|
|
224
|
+
{
|
|
225
|
+
"cmd": "get ui/button",
|
|
226
|
+
"description": "show config information from the env configured for ui/button"
|
|
227
|
+
}
|
|
222
228
|
]
|
|
223
229
|
},
|
|
224
230
|
{
|
|
@@ -255,7 +261,7 @@
|
|
|
255
261
|
"name": "unset <component-pattern>",
|
|
256
262
|
"options": [],
|
|
257
263
|
"description": "un-sets an env from components that were previously set by \"bit env set\" or by a component template",
|
|
258
|
-
"extendedDescription": "keep in mind that this doesn't remove envs that are set via variants.\
|
|
264
|
+
"extendedDescription": "keep in mind that this doesn't remove envs that are set via variants.\nit only removes envs that appear in the .bitmap file, which were previously configured via \"bit env set\".\nthe purpose of this command is to reset previously assigned envs to either allow variants to configure the env or use the base node env.\nyou can use a `<pattern>` for multiple component ids, such as `bit env unset \"org.scope/utils/**\"`.\nuse comma to separate patterns and '!' to exclude. e.g. 'ui/**, !ui/button'\nuse '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'.\nalways wrap the pattern with single quotes to avoid collision with shell commands.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.\n",
|
|
259
265
|
"group": "component-config",
|
|
260
266
|
"arguments": [
|
|
261
267
|
{
|
|
@@ -532,7 +538,7 @@
|
|
|
532
538
|
[
|
|
533
539
|
"v",
|
|
534
540
|
"verbose",
|
|
535
|
-
"show verbose output for inspection and
|
|
541
|
+
"show verbose output for inspection and print stack trace"
|
|
536
542
|
],
|
|
537
543
|
[
|
|
538
544
|
"n",
|
|
@@ -597,7 +603,7 @@
|
|
|
597
603
|
[
|
|
598
604
|
"",
|
|
599
605
|
"layout <name>",
|
|
600
|
-
"
|
|
606
|
+
"Graphviz layout. default to \"dot\". options are [circo, dot, fdp, neato, osage, patchwork, sfdp, twopi]"
|
|
601
607
|
],
|
|
602
608
|
[
|
|
603
609
|
"",
|
|
@@ -644,7 +650,7 @@
|
|
|
644
650
|
"name": "set <scope-name> [component-pattern]",
|
|
645
651
|
"options": [],
|
|
646
652
|
"description": "Sets the scope for specified component/s. If no component is specified, sets the default scope of the workspace",
|
|
647
|
-
"extendedDescription": "default scopes for components are set in the bitmap file. the default scope for a workspace is set in the workspace.jsonc.\na component is set with a scope (as
|
|
653
|
+
"extendedDescription": "default scopes for components are set in the bitmap file. the default scope for a workspace is set in the workspace.jsonc.\na component is set with a scope (as opposed to default scope) only once it is versioned.\n\nyou can use a `<pattern>` for multiple component ids, such as `bit scope set scope-name \"org.scope/utils/**\"`.\nuse comma to separate patterns and '!' to exclude. e.g. 'ui/**, !ui/button'\nuse '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'.\nalways wrap the pattern with single quotes to avoid collision with shell commands.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.\n",
|
|
648
654
|
"group": "component-config",
|
|
649
655
|
"arguments": [
|
|
650
656
|
{
|
|
@@ -690,7 +696,7 @@
|
|
|
690
696
|
[
|
|
691
697
|
"",
|
|
692
698
|
"deprecate",
|
|
693
|
-
"for exported components, instead of deleting the original components,
|
|
699
|
+
"for exported components, instead of deleting the original components, deprecate them"
|
|
694
700
|
],
|
|
695
701
|
[
|
|
696
702
|
"x",
|
|
@@ -863,12 +869,12 @@
|
|
|
863
869
|
[
|
|
864
870
|
"p",
|
|
865
871
|
"propagate",
|
|
866
|
-
"mark propagate true in the config file, so that component.json configs will be
|
|
872
|
+
"mark propagate true in the config file, so that component.json configs will be merged with workspace configs"
|
|
867
873
|
],
|
|
868
874
|
[
|
|
869
875
|
"o",
|
|
870
876
|
"override",
|
|
871
|
-
"override file if
|
|
877
|
+
"override the file if it exists"
|
|
872
878
|
]
|
|
873
879
|
],
|
|
874
880
|
"description": "create component.json configuration files for components",
|
|
@@ -1005,11 +1011,6 @@
|
|
|
1005
1011
|
"no-orphans",
|
|
1006
1012
|
"don't delete capsules whose origin path no longer exists"
|
|
1007
1013
|
],
|
|
1008
|
-
[
|
|
1009
|
-
"",
|
|
1010
|
-
"size-target <gb>",
|
|
1011
|
-
"after standard pruning, LRU-evict aspect-versions until total drops below this size (forces --with-sizes)"
|
|
1012
|
-
],
|
|
1013
1014
|
[
|
|
1014
1015
|
"",
|
|
1015
1016
|
"dry-run",
|
|
@@ -1065,6 +1066,27 @@
|
|
|
1065
1066
|
}
|
|
1066
1067
|
]
|
|
1067
1068
|
},
|
|
1069
|
+
{
|
|
1070
|
+
"name": "debug-load <component-id>",
|
|
1071
|
+
"alias": "",
|
|
1072
|
+
"options": [
|
|
1073
|
+
[
|
|
1074
|
+
"j",
|
|
1075
|
+
"json",
|
|
1076
|
+
"return the load trace in json format"
|
|
1077
|
+
]
|
|
1078
|
+
],
|
|
1079
|
+
"description": "EXPERIMENTAL. load a component with tracing enabled and explain how it was loaded",
|
|
1080
|
+
"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.",
|
|
1081
|
+
"group": "info-analysis",
|
|
1082
|
+
"private": true,
|
|
1083
|
+
"arguments": [
|
|
1084
|
+
{
|
|
1085
|
+
"name": "component-id",
|
|
1086
|
+
"description": "the component id to load"
|
|
1087
|
+
}
|
|
1088
|
+
]
|
|
1089
|
+
},
|
|
1068
1090
|
{
|
|
1069
1091
|
"name": "pattern <pattern>",
|
|
1070
1092
|
"alias": "",
|
|
@@ -1225,7 +1247,7 @@
|
|
|
1225
1247
|
[
|
|
1226
1248
|
"",
|
|
1227
1249
|
"suppress-browser-launch",
|
|
1228
|
-
"
|
|
1250
|
+
"DEPRECATED. use --no-browser instead"
|
|
1229
1251
|
]
|
|
1230
1252
|
],
|
|
1231
1253
|
"description": "authenticate with Bit Cloud for component publishing and collaboration",
|
|
@@ -1666,13 +1688,13 @@
|
|
|
1666
1688
|
]
|
|
1667
1689
|
},
|
|
1668
1690
|
{
|
|
1669
|
-
"name": "deprecate <component-
|
|
1691
|
+
"name": "deprecate <component-pattern>",
|
|
1670
1692
|
"alias": "d",
|
|
1671
1693
|
"options": [
|
|
1672
1694
|
[
|
|
1673
1695
|
"",
|
|
1674
1696
|
"new-id <string>",
|
|
1675
|
-
"if replaced by another component, enter the new component id. alternatively use \"bit rename --deprecate\" to do this automatically"
|
|
1697
|
+
"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"
|
|
1676
1698
|
],
|
|
1677
1699
|
[
|
|
1678
1700
|
"",
|
|
@@ -1680,29 +1702,47 @@
|
|
|
1680
1702
|
"enter a Semver range to deprecate specific versions. see https://www.npmjs.com/package/semver#ranges for the range syntax"
|
|
1681
1703
|
]
|
|
1682
1704
|
],
|
|
1683
|
-
"description": "mark
|
|
1684
|
-
"extendedDescription": "marks
|
|
1705
|
+
"description": "mark components as deprecated to discourage their use",
|
|
1706
|
+
"extendedDescription": "marks components as deprecated locally, then after snap/tag and export they become deprecated in the remote scope.\nthe pattern can match multiple components, so several can be deprecated at once.\noptionally specify a replacement component (single component only) or deprecate only specific version ranges.\ndeprecated components remain available but display warnings when installed or imported.",
|
|
1685
1707
|
"group": "collaborate",
|
|
1686
1708
|
"private": false,
|
|
1687
1709
|
"remoteOp": true,
|
|
1688
1710
|
"skipWorkspace": true,
|
|
1689
1711
|
"arguments": [
|
|
1690
1712
|
{
|
|
1691
|
-
"name": "component-
|
|
1692
|
-
"description": "component name or component
|
|
1713
|
+
"name": "component-pattern",
|
|
1714
|
+
"description": "component name, component id, component pattern, or relative directory path. use component pattern to select multiple components.\nwrap the pattern with quotes. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\".\nuse '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern."
|
|
1715
|
+
}
|
|
1716
|
+
],
|
|
1717
|
+
"examples": [
|
|
1718
|
+
{
|
|
1719
|
+
"cmd": "deprecate \"ui/**\"",
|
|
1720
|
+
"description": "deprecate all components whose id starts with \"ui/\""
|
|
1693
1721
|
}
|
|
1694
1722
|
]
|
|
1695
1723
|
},
|
|
1696
1724
|
{
|
|
1697
|
-
"name": "undeprecate <
|
|
1725
|
+
"name": "undeprecate <component-pattern>",
|
|
1698
1726
|
"alias": "",
|
|
1699
1727
|
"options": [],
|
|
1700
|
-
"description": "remove the deprecation status from
|
|
1701
|
-
"extendedDescription": "reverses the deprecation of
|
|
1728
|
+
"description": "remove the deprecation status from components",
|
|
1729
|
+
"extendedDescription": "reverses the deprecation of components, removing warnings and allowing normal use again.\nthe pattern can match multiple components, so several can be undeprecated at once.",
|
|
1702
1730
|
"group": "collaborate",
|
|
1703
1731
|
"private": false,
|
|
1704
1732
|
"remoteOp": true,
|
|
1705
|
-
"skipWorkspace": true
|
|
1733
|
+
"skipWorkspace": true,
|
|
1734
|
+
"arguments": [
|
|
1735
|
+
{
|
|
1736
|
+
"name": "component-pattern",
|
|
1737
|
+
"description": "component name, component id, component pattern, or relative directory path. use component pattern to select multiple components.\nwrap the pattern with quotes. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\".\nuse '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern."
|
|
1738
|
+
}
|
|
1739
|
+
],
|
|
1740
|
+
"examples": [
|
|
1741
|
+
{
|
|
1742
|
+
"cmd": "undeprecate '$deprecated'",
|
|
1743
|
+
"description": "undeprecate all currently-deprecated components"
|
|
1744
|
+
}
|
|
1745
|
+
]
|
|
1706
1746
|
},
|
|
1707
1747
|
{
|
|
1708
1748
|
"name": "git <sub-command>",
|
|
@@ -1849,7 +1889,7 @@
|
|
|
1849
1889
|
},
|
|
1850
1890
|
{
|
|
1851
1891
|
"cmd": "bit create mdx docs/create-components --aspect teambit.mdx/mdx-env --scope my-org.my-scope",
|
|
1852
|
-
"description": "creates an mdx component named 'docs/create-components' and sets
|
|
1892
|
+
"description": "creates an mdx component named 'docs/create-components' and sets its scope to 'my-org.my-scope'. \nby default, the scope is the `defaultScope` value, configured in your `workspace.jsonc`."
|
|
1853
1893
|
},
|
|
1854
1894
|
{
|
|
1855
1895
|
"cmd": "bit create react my-org.my-scope/hooks/use-session",
|
|
@@ -1928,7 +1968,7 @@
|
|
|
1928
1968
|
[
|
|
1929
1969
|
"",
|
|
1930
1970
|
"load-from <path-to-template>",
|
|
1931
|
-
"local path to the workspace containing the template. Helpful during
|
|
1971
|
+
"local path to the workspace containing the template. Helpful during the development of a workspace-template"
|
|
1932
1972
|
],
|
|
1933
1973
|
[
|
|
1934
1974
|
"c",
|
|
@@ -2083,7 +2123,7 @@
|
|
|
2083
2123
|
[
|
|
2084
2124
|
"i",
|
|
2085
2125
|
"ignore-issues <issues>",
|
|
2086
|
-
"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 \"*\"."
|
|
2126
|
+
"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 \"*\"."
|
|
2087
2127
|
]
|
|
2088
2128
|
],
|
|
2089
2129
|
"description": "run build pipeline tasks in isolated environments",
|
|
@@ -2354,7 +2394,7 @@
|
|
|
2354
2394
|
[
|
|
2355
2395
|
"",
|
|
2356
2396
|
"skip-unavailable",
|
|
2357
|
-
"when adding missing dependencies, skip those that are not found in the
|
|
2397
|
+
"when adding missing dependencies, skip those that are not found in the registry"
|
|
2358
2398
|
],
|
|
2359
2399
|
[
|
|
2360
2400
|
"",
|
|
@@ -2601,7 +2641,7 @@
|
|
|
2601
2641
|
[
|
|
2602
2642
|
"",
|
|
2603
2643
|
"dependents-dry-run",
|
|
2604
|
-
"DEPRECATED. (this is the default now). same as --dependents, except it prints the found dependents and
|
|
2644
|
+
"DEPRECATED. (this is the default now). same as --dependents, except it prints the found dependents and waits for confirmation before importing them"
|
|
2605
2645
|
],
|
|
2606
2646
|
[
|
|
2607
2647
|
"",
|
|
@@ -2626,7 +2666,7 @@
|
|
|
2626
2666
|
[
|
|
2627
2667
|
"",
|
|
2628
2668
|
"fetch-deps",
|
|
2629
|
-
"fetch dependencies (bit components) objects to the local scope, but
|
|
2669
|
+
"fetch dependencies (bit components) objects to the local scope, but don't add to the workspace. Useful to resolve errors about missing dependency data"
|
|
2630
2670
|
],
|
|
2631
2671
|
[
|
|
2632
2672
|
"",
|
|
@@ -2652,6 +2692,11 @@
|
|
|
2652
2692
|
"",
|
|
2653
2693
|
"owner",
|
|
2654
2694
|
"treat the argument as an owner name and import all components from all scopes of that owner"
|
|
2695
|
+
],
|
|
2696
|
+
[
|
|
2697
|
+
"",
|
|
2698
|
+
"write-to-empty-dir",
|
|
2699
|
+
"when the target directory is not empty, import into an available empty directory (e.g. \"foo\" => \"foo_1\") instead of failing"
|
|
2655
2700
|
]
|
|
2656
2701
|
],
|
|
2657
2702
|
"description": "bring components from remote scopes into your workspace",
|
|
@@ -2777,7 +2822,7 @@
|
|
|
2777
2822
|
[
|
|
2778
2823
|
"f",
|
|
2779
2824
|
"force",
|
|
2780
|
-
"relevant for --hard. allow the deletion even if used as a dependency. WARNING: components that depend on this component will
|
|
2825
|
+
"relevant for --hard. allow the deletion even if used as a dependency. WARNING: components that depend on this component will be corrupted"
|
|
2781
2826
|
],
|
|
2782
2827
|
[
|
|
2783
2828
|
"",
|
|
@@ -3446,6 +3491,11 @@
|
|
|
3446
3491
|
"pre-release [identifier]",
|
|
3447
3492
|
"syntactic sugar for \"--increment prerelease\" and `--prerelease-id <identifier>`"
|
|
3448
3493
|
],
|
|
3494
|
+
[
|
|
3495
|
+
"",
|
|
3496
|
+
"auto-tag-increment <level>",
|
|
3497
|
+
"the increment level to use for auto-tagged dependents. options are: [major, premajor, minor, preminor, patch, prepatch, prerelease].\nby default, dependents are bumped by a patch, unless --increment is one of [prepatch, prerelease, preminor, premajor], which they follow.\nnote that dependents are auto-tagged transitively, so the entire dependents graph is bumped by this level"
|
|
3498
|
+
],
|
|
3449
3499
|
[
|
|
3450
3500
|
"",
|
|
3451
3501
|
"snapped",
|
|
@@ -3509,7 +3559,7 @@
|
|
|
3509
3559
|
[
|
|
3510
3560
|
"i",
|
|
3511
3561
|
"ignore-issues <issues>",
|
|
3512
|
-
"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 \"*\"."
|
|
3562
|
+
"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 \"*\"."
|
|
3513
3563
|
],
|
|
3514
3564
|
[
|
|
3515
3565
|
"I",
|
|
@@ -3545,7 +3595,7 @@
|
|
|
3545
3595
|
"arguments": [
|
|
3546
3596
|
{
|
|
3547
3597
|
"name": "component-patterns...",
|
|
3548
|
-
"description": "component name, component id, component pattern, or relative directory path. use component pattern to select multiple components.\nwrap the pattern with quotes. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\".\nuse '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.. By default, all new and modified are tagged."
|
|
3598
|
+
"description": "component name, component id, component pattern, or relative directory path. use component pattern to select multiple components.\nwrap the pattern with quotes. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\".\nuse '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.. By default, all new and modified components are tagged."
|
|
3549
3599
|
}
|
|
3550
3600
|
],
|
|
3551
3601
|
"examples": [
|
|
@@ -3627,7 +3677,7 @@
|
|
|
3627
3677
|
[
|
|
3628
3678
|
"i",
|
|
3629
3679
|
"ignore-issues <issues>",
|
|
3630
|
-
"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 \"*\"."
|
|
3680
|
+
"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 \"*\"."
|
|
3631
3681
|
],
|
|
3632
3682
|
[
|
|
3633
3683
|
"",
|
|
@@ -3744,7 +3794,7 @@
|
|
|
3744
3794
|
]
|
|
3745
3795
|
},
|
|
3746
3796
|
{
|
|
3747
|
-
"name": "test [
|
|
3797
|
+
"name": "test [pattern-or-test-file...]",
|
|
3748
3798
|
"alias": "at",
|
|
3749
3799
|
"options": [
|
|
3750
3800
|
[
|
|
@@ -3809,13 +3859,13 @@
|
|
|
3809
3859
|
]
|
|
3810
3860
|
],
|
|
3811
3861
|
"description": "run component tests",
|
|
3812
|
-
"extendedDescription": "executes tests using the testing framework configured by each component's environment (Jest, Mocha, etc.).\nby default only runs tests for new and modified components. use --unmodified to test all components.\nsupports watch mode, coverage reporting, and debug mode for development workflows.",
|
|
3862
|
+
"extendedDescription": "executes tests using the testing framework configured by each component's environment (Jest, Mocha, etc.).\nby default only runs tests for new and modified components. use --unmodified to test all components.\nto run specific test files only, pass their paths instead of a component pattern, e.g. \"bit test path/to/comp/my-comp.spec.ts\".\nsupports watch mode, coverage reporting, and debug mode for development workflows.",
|
|
3813
3863
|
"group": "testing",
|
|
3814
3864
|
"private": false,
|
|
3815
3865
|
"arguments": [
|
|
3816
3866
|
{
|
|
3817
|
-
"name": "
|
|
3818
|
-
"description": "component name, component id, component pattern, or relative directory path. use component pattern to select multiple components.\nwrap the pattern with quotes. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\".\nuse '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern."
|
|
3867
|
+
"name": "pattern-or-test-file...",
|
|
3868
|
+
"description": "one of two modes (multiple values are supported, separated by spaces):\n1) component pattern: component name, component id, component pattern, or relative directory path. use component pattern to select multiple components.\nwrap the pattern with quotes. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\".\nuse '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.\n2) 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\".\nnote that a directory path selects the component in that directory and runs all its tests, while a test-file path runs only that file"
|
|
3819
3869
|
}
|
|
3820
3870
|
]
|
|
3821
3871
|
},
|
|
@@ -4127,7 +4177,7 @@
|
|
|
4127
4177
|
[
|
|
4128
4178
|
"n",
|
|
4129
4179
|
"alias <string>",
|
|
4130
|
-
"relevant when the specified lane is a remote lane. create a local alias for the lane (
|
|
4180
|
+
"relevant when the specified lane is a remote lane. create a local alias for the lane (doesn't affect the lane's name on the remote)"
|
|
4131
4181
|
],
|
|
4132
4182
|
[
|
|
4133
4183
|
"",
|
|
@@ -4521,7 +4571,7 @@
|
|
|
4521
4571
|
]
|
|
4522
4572
|
],
|
|
4523
4573
|
"description": "revert to a previous history of the current lane. see also \"bit lane checkout\"",
|
|
4524
|
-
"extendedDescription": "revert is similar to \"lane checkout\", but it keeps the versions and only
|
|
4574
|
+
"extendedDescription": "revert is similar to \"lane checkout\", but it keeps the versions and only changes the files.\nchoose one or the other based on your needs.\nif you want to continue working on this lane and need the changes from the history to be the head, then use \"lane revert\".\nif you want to fork the lane from a certain point in history, use \"lane checkout\" and create a new lane from it.",
|
|
4525
4575
|
"group": "ungrouped",
|
|
4526
4576
|
"private": false,
|
|
4527
4577
|
"arguments": [
|
|
@@ -4623,7 +4673,7 @@
|
|
|
4623
4673
|
[
|
|
4624
4674
|
"",
|
|
4625
4675
|
"skip-fetch",
|
|
4626
|
-
"use the local state of target-lane if
|
|
4676
|
+
"use the local state of target-lane if exists locally, without updating it from the remote"
|
|
4627
4677
|
],
|
|
4628
4678
|
[
|
|
4629
4679
|
"",
|
|
@@ -4652,7 +4702,7 @@
|
|
|
4652
4702
|
]
|
|
4653
4703
|
],
|
|
4654
4704
|
"description": "merge a local or a remote lane to the current lane",
|
|
4655
|
-
"extendedDescription": "by default, the provided lane will be fetched from the remote before merging.\nto merge the lane from the local scope without updating it first, use \"--skip-fetch\" flag.\n\nwhen the current and merge candidate lanes are diverged in history and the files could be merged with no conflicts,\nthese components will be snap-merged to complete the merge. use \"no-auto-snap\" to opt-out, or \"tag\" to tag instead.\n\nwhen the components are not diverged in history, and the current lane is behind the merge candidate, the merge will\nsimply update the components and the heads according to the merge candidate.\nto opt-out, use \"--no-snap\", the components will be written as the merge candidate, and will be left as modified.\n\nin case a component
|
|
4705
|
+
"extendedDescription": "by default, the provided lane will be fetched from the remote before merging.\nto merge the lane from the local scope without updating it first, use \"--skip-fetch\" flag.\n\nwhen the current and merge candidate lanes are diverged in history and the files could be merged with no conflicts,\nthese components will be snap-merged to complete the merge. use \"no-auto-snap\" to opt-out, or \"tag\" to tag instead.\n\nwhen the components are not diverged in history, and the current lane is behind the merge candidate, the merge will\nsimply update the components and the heads according to the merge candidate.\nto opt-out, use \"--no-snap\", the components will be written as the merge candidate, and will be left as modified.\n\nin case a component on both ends doesn't share history (no snap is found in common), the merge will require \"--resolve-unrelated\" flag.\nthis flag keeps the history of one end and saves a reference to the other end. the decision of which end to keep is determined by the following:\n1. if the component exists on main, then the history linked to main will be kept.\nin this case, the strategy of \"--resolve-unrelated\" only determines which source-code to keep. it's not about the history.\n2. if the component doesn't exist on main, then by default, the history of the current lane will be kept.\nunless \"--resolve-unrelated\" is set to \"theirs\", in which case the history of the other lane will be kept.\n2. a. an edge case: if the component is deleted on the current lane, the strategy will always be \"theirs\".\nso then the history (and the source-code) of the other lane will be kept.\n",
|
|
4656
4706
|
"private": true,
|
|
4657
4707
|
"remoteOp": true,
|
|
4658
4708
|
"arguments": [
|
|
@@ -4702,7 +4752,7 @@
|
|
|
4702
4752
|
]
|
|
4703
4753
|
],
|
|
4704
4754
|
"description": "EXPERIMENT. move the current merge state into a new lane. the current lane will be reset",
|
|
4705
|
-
"extendedDescription": "this command is useful when you got a messy merge state that
|
|
4755
|
+
"extendedDescription": "this command is useful when you got a messy merge state that on one hand you don't want\nto lose the changes, but on the other hand, you want to keep your lane without those changes.\nthis command does the following:\n1. create a new lane with the current merge state. including all the filesystem changes. (in practice, it leaves the fs intact)\n2. reset the current lane to the state before the merge. so then once done with the new lane, you can switch to the current lane and it'll be clean.",
|
|
4706
4756
|
"remoteOp": true
|
|
4707
4757
|
}
|
|
4708
4758
|
]
|
|
@@ -4759,7 +4809,7 @@
|
|
|
4759
4809
|
[
|
|
4760
4810
|
"n",
|
|
4761
4811
|
"alias <string>",
|
|
4762
|
-
"relevant when the specified lane is a remote lane. create a local alias for the lane (
|
|
4812
|
+
"relevant when the specified lane is a remote lane. create a local alias for the lane (doesn't affect the lane's name on the remote)"
|
|
4763
4813
|
],
|
|
4764
4814
|
[
|
|
4765
4815
|
"",
|
|
@@ -4959,10 +5009,20 @@
|
|
|
4959
5009
|
"",
|
|
4960
5010
|
"keep-lane",
|
|
4961
5011
|
"Reuse the same remote lane across PR commits (preserves lane history and cloud UI edits) instead of recreating it on every run"
|
|
5012
|
+
],
|
|
5013
|
+
[
|
|
5014
|
+
"",
|
|
5015
|
+
"skip-cleanup",
|
|
5016
|
+
"Skip restoring the workspace (switching back to main) after export. Use when the workspace is discarded right after, e.g. an ephemeral CI container"
|
|
5017
|
+
],
|
|
5018
|
+
[
|
|
5019
|
+
"",
|
|
5020
|
+
"skip-tasks <tasks>",
|
|
5021
|
+
"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"
|
|
4962
5022
|
]
|
|
4963
5023
|
],
|
|
4964
5024
|
"description": "Exports a feature lane to Bit Cloud when a Pull Request is opened or updated.",
|
|
4965
|
-
"extendedDescription": "Resolves the lane name from --lane or the current Git branch, validates it, and runs install, status, snap, and export.
|
|
5025
|
+
"extendedDescription": "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.",
|
|
4966
5026
|
"group": "collaborate",
|
|
4967
5027
|
"private": false
|
|
4968
5028
|
},
|
|
@@ -5015,6 +5075,11 @@
|
|
|
5015
5075
|
"pre-release [identifier]",
|
|
5016
5076
|
"syntactic sugar for \"--increment prerelease\" and `--prerelease-id <identifier>`"
|
|
5017
5077
|
],
|
|
5078
|
+
[
|
|
5079
|
+
"",
|
|
5080
|
+
"auto-tag-increment <level>",
|
|
5081
|
+
"the increment level to use for auto-tagged dependents. options are: [major, premajor, minor, preminor, patch, prepatch, prerelease].\nby default, dependents are bumped by a patch, unless --increment is one of [prepatch, prerelease, preminor, premajor], which they follow.\nnote that dependents are auto-tagged transitively, so the entire dependents graph is bumped by this level"
|
|
5082
|
+
],
|
|
5018
5083
|
[
|
|
5019
5084
|
"",
|
|
5020
5085
|
"increment-by <number>",
|
|
@@ -5269,7 +5334,7 @@
|
|
|
5269
5334
|
[
|
|
5270
5335
|
"",
|
|
5271
5336
|
"reset-lane-new",
|
|
5272
|
-
"same as reset-new, but it only resets components
|
|
5337
|
+
"same as reset-new, but it only resets components belonging to lanes. main components are left intact"
|
|
5273
5338
|
],
|
|
5274
5339
|
[
|
|
5275
5340
|
"",
|
|
@@ -5359,7 +5424,7 @@
|
|
|
5359
5424
|
[
|
|
5360
5425
|
"l",
|
|
5361
5426
|
"layout <name>",
|
|
5362
|
-
"
|
|
5427
|
+
"Graphviz layout. default to \"dot\". options are [circo, dot, fdp, neato, osage, patchwork, sfdp, twopi]"
|
|
5363
5428
|
],
|
|
5364
5429
|
[
|
|
5365
5430
|
"",
|
|
@@ -5780,7 +5845,7 @@
|
|
|
5780
5845
|
[
|
|
5781
5846
|
"",
|
|
5782
5847
|
"deprecate",
|
|
5783
|
-
"instead of deleting the original component,
|
|
5848
|
+
"instead of deleting the original component, deprecate it"
|
|
5784
5849
|
],
|
|
5785
5850
|
[
|
|
5786
5851
|
"p",
|
|
@@ -5992,7 +6057,7 @@
|
|
|
5992
6057
|
[
|
|
5993
6058
|
"m",
|
|
5994
6059
|
"merge",
|
|
5995
|
-
"merge with an existing config if
|
|
6060
|
+
"merge with an existing config if exists. (by default, it replaces overlapping existing configs)"
|
|
5996
6061
|
]
|
|
5997
6062
|
],
|
|
5998
6063
|
"description": "set components with an aspect to extend their development tools, metadata and (possibly) artifacts",
|