@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.
- package/cli-reference.docs.mdx +1 -1
- package/cli-reference.json +223 -179
- package/cli-reference.mdx +104 -96
- 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 +223 -179
- 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-1783451158181.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
|
@@ -1005,11 +1005,6 @@
|
|
|
1005
1005
|
"no-orphans",
|
|
1006
1006
|
"don't delete capsules whose origin path no longer exists"
|
|
1007
1007
|
],
|
|
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
1008
|
[
|
|
1014
1009
|
"",
|
|
1015
1010
|
"dry-run",
|
|
@@ -1033,6 +1028,162 @@
|
|
|
1033
1028
|
}
|
|
1034
1029
|
]
|
|
1035
1030
|
},
|
|
1031
|
+
{
|
|
1032
|
+
"name": "aspect <sub-command>",
|
|
1033
|
+
"alias": "",
|
|
1034
|
+
"options": [],
|
|
1035
|
+
"description": "manage component aspects and their configurations",
|
|
1036
|
+
"extendedDescription": "aspects provide functionality and tools for components throughout their development lifecycle.\nprimarily useful for inspecting aspect assignments and configurations with \"bit aspect get\".\nrarely used for manual aspect management as most aspects are configured automatically.",
|
|
1037
|
+
"group": "component-config",
|
|
1038
|
+
"private": false,
|
|
1039
|
+
"commands": [
|
|
1040
|
+
{
|
|
1041
|
+
"name": "list [pattern]",
|
|
1042
|
+
"alias": "",
|
|
1043
|
+
"options": [
|
|
1044
|
+
[
|
|
1045
|
+
"d",
|
|
1046
|
+
"debug",
|
|
1047
|
+
"show the origins where the aspects were taken from"
|
|
1048
|
+
]
|
|
1049
|
+
],
|
|
1050
|
+
"description": "list all aspects configured on component(s)",
|
|
1051
|
+
"extendedDescription": "",
|
|
1052
|
+
"group": "info-analysis",
|
|
1053
|
+
"private": false,
|
|
1054
|
+
"arguments": [
|
|
1055
|
+
{
|
|
1056
|
+
"name": "pattern",
|
|
1057
|
+
"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."
|
|
1058
|
+
}
|
|
1059
|
+
]
|
|
1060
|
+
},
|
|
1061
|
+
{
|
|
1062
|
+
"name": "list-core",
|
|
1063
|
+
"alias": "",
|
|
1064
|
+
"options": [
|
|
1065
|
+
[
|
|
1066
|
+
"j",
|
|
1067
|
+
"json",
|
|
1068
|
+
"format as json"
|
|
1069
|
+
]
|
|
1070
|
+
],
|
|
1071
|
+
"description": "list all core aspects",
|
|
1072
|
+
"extendedDescription": "",
|
|
1073
|
+
"group": "info-analysis",
|
|
1074
|
+
"private": false,
|
|
1075
|
+
"arguments": [
|
|
1076
|
+
{
|
|
1077
|
+
"name": "pattern",
|
|
1078
|
+
"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."
|
|
1079
|
+
}
|
|
1080
|
+
]
|
|
1081
|
+
},
|
|
1082
|
+
{
|
|
1083
|
+
"name": "get <component-name>",
|
|
1084
|
+
"alias": "",
|
|
1085
|
+
"options": [
|
|
1086
|
+
[
|
|
1087
|
+
"d",
|
|
1088
|
+
"debug",
|
|
1089
|
+
"show the origins where the aspects were taken from"
|
|
1090
|
+
],
|
|
1091
|
+
[
|
|
1092
|
+
"j",
|
|
1093
|
+
"json",
|
|
1094
|
+
"format as json"
|
|
1095
|
+
]
|
|
1096
|
+
],
|
|
1097
|
+
"description": "list the aspects set on a component, as well as their configs and data",
|
|
1098
|
+
"extendedDescription": "",
|
|
1099
|
+
"group": "info-analysis",
|
|
1100
|
+
"private": false,
|
|
1101
|
+
"arguments": [
|
|
1102
|
+
{
|
|
1103
|
+
"name": "component-name",
|
|
1104
|
+
"description": "the component name or component id to fetch aspects for"
|
|
1105
|
+
}
|
|
1106
|
+
]
|
|
1107
|
+
},
|
|
1108
|
+
{
|
|
1109
|
+
"name": "set <pattern> <aspect-id> [config]",
|
|
1110
|
+
"alias": "",
|
|
1111
|
+
"options": [
|
|
1112
|
+
[
|
|
1113
|
+
"m",
|
|
1114
|
+
"merge",
|
|
1115
|
+
"merge with an existing config if exits. (by default, it replaces overlapping existing configs)"
|
|
1116
|
+
]
|
|
1117
|
+
],
|
|
1118
|
+
"description": "set components with an aspect to extend their development tools, metadata and (possibly) artifacts",
|
|
1119
|
+
"extendedDescription": "",
|
|
1120
|
+
"group": "component-config",
|
|
1121
|
+
"private": false,
|
|
1122
|
+
"arguments": [
|
|
1123
|
+
{
|
|
1124
|
+
"name": "pattern",
|
|
1125
|
+
"description": "the components to extend. 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."
|
|
1126
|
+
},
|
|
1127
|
+
{
|
|
1128
|
+
"name": "aspect-id",
|
|
1129
|
+
"description": "the aspect's component id"
|
|
1130
|
+
},
|
|
1131
|
+
{
|
|
1132
|
+
"name": "config",
|
|
1133
|
+
"description": "the aspect config. enter the config as a stringified JSON (e.g. `{\"foo\":\"bar\"}` ). when no config is provided, an aspect is set with an empty config ({})."
|
|
1134
|
+
}
|
|
1135
|
+
]
|
|
1136
|
+
},
|
|
1137
|
+
{
|
|
1138
|
+
"name": "unset <pattern> <aspect-id>",
|
|
1139
|
+
"alias": "",
|
|
1140
|
+
"options": [],
|
|
1141
|
+
"description": "unset an aspect from component(s).",
|
|
1142
|
+
"extendedDescription": "",
|
|
1143
|
+
"group": "component-config",
|
|
1144
|
+
"private": false,
|
|
1145
|
+
"arguments": [
|
|
1146
|
+
{
|
|
1147
|
+
"name": "pattern",
|
|
1148
|
+
"description": "the components to target. 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."
|
|
1149
|
+
},
|
|
1150
|
+
{
|
|
1151
|
+
"name": "aspect-id",
|
|
1152
|
+
"description": "the aspect's component id"
|
|
1153
|
+
}
|
|
1154
|
+
]
|
|
1155
|
+
},
|
|
1156
|
+
{
|
|
1157
|
+
"name": "update <aspect-id> [pattern]",
|
|
1158
|
+
"alias": "",
|
|
1159
|
+
"options": [],
|
|
1160
|
+
"description": "update a version of an aspect for all or specified components",
|
|
1161
|
+
"extendedDescription": "",
|
|
1162
|
+
"group": "component-config",
|
|
1163
|
+
"private": false,
|
|
1164
|
+
"arguments": [
|
|
1165
|
+
{
|
|
1166
|
+
"name": "aspect-id",
|
|
1167
|
+
"description": "the aspect's component id. optionally, add a version (id@version), otherwise will use the latest version from the remote"
|
|
1168
|
+
},
|
|
1169
|
+
{
|
|
1170
|
+
"name": "pattern",
|
|
1171
|
+
"description": "the components to update (defaults to all components). 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."
|
|
1172
|
+
}
|
|
1173
|
+
],
|
|
1174
|
+
"examples": [
|
|
1175
|
+
{
|
|
1176
|
+
"cmd": "bit aspect update scope.org/aspect '**/ui/**'",
|
|
1177
|
+
"description": "update all components with the \"ui\" namespace that use scope.org/aspect, to use its latest version"
|
|
1178
|
+
},
|
|
1179
|
+
{
|
|
1180
|
+
"cmd": "bit aspect update scope.org/aspect@2.0.0",
|
|
1181
|
+
"description": "update version of scope.org/aspect to version 2.0.0 for all components configured with that aspect."
|
|
1182
|
+
}
|
|
1183
|
+
]
|
|
1184
|
+
}
|
|
1185
|
+
]
|
|
1186
|
+
},
|
|
1036
1187
|
{
|
|
1037
1188
|
"name": "use <component-id>",
|
|
1038
1189
|
"alias": "",
|
|
@@ -1065,6 +1216,27 @@
|
|
|
1065
1216
|
}
|
|
1066
1217
|
]
|
|
1067
1218
|
},
|
|
1219
|
+
{
|
|
1220
|
+
"name": "debug-load <component-id>",
|
|
1221
|
+
"alias": "",
|
|
1222
|
+
"options": [
|
|
1223
|
+
[
|
|
1224
|
+
"j",
|
|
1225
|
+
"json",
|
|
1226
|
+
"return the load trace in json format"
|
|
1227
|
+
]
|
|
1228
|
+
],
|
|
1229
|
+
"description": "EXPERIMENTAL. load a component with tracing enabled and explain how it was loaded",
|
|
1230
|
+
"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.",
|
|
1231
|
+
"group": "info-analysis",
|
|
1232
|
+
"private": true,
|
|
1233
|
+
"arguments": [
|
|
1234
|
+
{
|
|
1235
|
+
"name": "component-id",
|
|
1236
|
+
"description": "the component id to load"
|
|
1237
|
+
}
|
|
1238
|
+
]
|
|
1239
|
+
},
|
|
1068
1240
|
{
|
|
1069
1241
|
"name": "pattern <pattern>",
|
|
1070
1242
|
"alias": "",
|
|
@@ -1666,13 +1838,13 @@
|
|
|
1666
1838
|
]
|
|
1667
1839
|
},
|
|
1668
1840
|
{
|
|
1669
|
-
"name": "deprecate <component-
|
|
1841
|
+
"name": "deprecate <component-pattern>",
|
|
1670
1842
|
"alias": "d",
|
|
1671
1843
|
"options": [
|
|
1672
1844
|
[
|
|
1673
1845
|
"",
|
|
1674
1846
|
"new-id <string>",
|
|
1675
|
-
"if replaced by another component, enter the new component id. alternatively use \"bit rename --deprecate\" to do this automatically"
|
|
1847
|
+
"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
1848
|
],
|
|
1677
1849
|
[
|
|
1678
1850
|
"",
|
|
@@ -1680,29 +1852,47 @@
|
|
|
1680
1852
|
"enter a Semver range to deprecate specific versions. see https://www.npmjs.com/package/semver#ranges for the range syntax"
|
|
1681
1853
|
]
|
|
1682
1854
|
],
|
|
1683
|
-
"description": "mark
|
|
1684
|
-
"extendedDescription": "marks
|
|
1855
|
+
"description": "mark components as deprecated to discourage their use",
|
|
1856
|
+
"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
1857
|
"group": "collaborate",
|
|
1686
1858
|
"private": false,
|
|
1687
1859
|
"remoteOp": true,
|
|
1688
1860
|
"skipWorkspace": true,
|
|
1689
1861
|
"arguments": [
|
|
1690
1862
|
{
|
|
1691
|
-
"name": "component-
|
|
1692
|
-
"description": "component name or component
|
|
1863
|
+
"name": "component-pattern",
|
|
1864
|
+
"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."
|
|
1865
|
+
}
|
|
1866
|
+
],
|
|
1867
|
+
"examples": [
|
|
1868
|
+
{
|
|
1869
|
+
"cmd": "deprecate \"ui/**\"",
|
|
1870
|
+
"description": "deprecate all components whose id starts with \"ui/\""
|
|
1693
1871
|
}
|
|
1694
1872
|
]
|
|
1695
1873
|
},
|
|
1696
1874
|
{
|
|
1697
|
-
"name": "undeprecate <
|
|
1875
|
+
"name": "undeprecate <component-pattern>",
|
|
1698
1876
|
"alias": "",
|
|
1699
1877
|
"options": [],
|
|
1700
|
-
"description": "remove the deprecation status from
|
|
1701
|
-
"extendedDescription": "reverses the deprecation of
|
|
1878
|
+
"description": "remove the deprecation status from components",
|
|
1879
|
+
"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
1880
|
"group": "collaborate",
|
|
1703
1881
|
"private": false,
|
|
1704
1882
|
"remoteOp": true,
|
|
1705
|
-
"skipWorkspace": true
|
|
1883
|
+
"skipWorkspace": true,
|
|
1884
|
+
"arguments": [
|
|
1885
|
+
{
|
|
1886
|
+
"name": "component-pattern",
|
|
1887
|
+
"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."
|
|
1888
|
+
}
|
|
1889
|
+
],
|
|
1890
|
+
"examples": [
|
|
1891
|
+
{
|
|
1892
|
+
"cmd": "undeprecate '$deprecated'",
|
|
1893
|
+
"description": "undeprecate all currently-deprecated components"
|
|
1894
|
+
}
|
|
1895
|
+
]
|
|
1706
1896
|
},
|
|
1707
1897
|
{
|
|
1708
1898
|
"name": "git <sub-command>",
|
|
@@ -2083,7 +2273,7 @@
|
|
|
2083
2273
|
[
|
|
2084
2274
|
"i",
|
|
2085
2275
|
"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 \"*\"."
|
|
2276
|
+
"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
2277
|
]
|
|
2088
2278
|
],
|
|
2089
2279
|
"description": "run build pipeline tasks in isolated environments",
|
|
@@ -3509,7 +3699,7 @@
|
|
|
3509
3699
|
[
|
|
3510
3700
|
"i",
|
|
3511
3701
|
"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 \"*\"."
|
|
3702
|
+
"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
3703
|
],
|
|
3514
3704
|
[
|
|
3515
3705
|
"I",
|
|
@@ -3627,7 +3817,7 @@
|
|
|
3627
3817
|
[
|
|
3628
3818
|
"i",
|
|
3629
3819
|
"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 \"*\"."
|
|
3820
|
+
"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
3821
|
],
|
|
3632
3822
|
[
|
|
3633
3823
|
"",
|
|
@@ -3744,7 +3934,7 @@
|
|
|
3744
3934
|
]
|
|
3745
3935
|
},
|
|
3746
3936
|
{
|
|
3747
|
-
"name": "test [
|
|
3937
|
+
"name": "test [pattern-or-test-file...]",
|
|
3748
3938
|
"alias": "at",
|
|
3749
3939
|
"options": [
|
|
3750
3940
|
[
|
|
@@ -3809,13 +3999,13 @@
|
|
|
3809
3999
|
]
|
|
3810
4000
|
],
|
|
3811
4001
|
"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.",
|
|
4002
|
+
"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
4003
|
"group": "testing",
|
|
3814
4004
|
"private": false,
|
|
3815
4005
|
"arguments": [
|
|
3816
4006
|
{
|
|
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."
|
|
4007
|
+
"name": "pattern-or-test-file...",
|
|
4008
|
+
"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
4009
|
}
|
|
3820
4010
|
]
|
|
3821
4011
|
},
|
|
@@ -4959,10 +5149,20 @@
|
|
|
4959
5149
|
"",
|
|
4960
5150
|
"keep-lane",
|
|
4961
5151
|
"Reuse the same remote lane across PR commits (preserves lane history and cloud UI edits) instead of recreating it on every run"
|
|
5152
|
+
],
|
|
5153
|
+
[
|
|
5154
|
+
"",
|
|
5155
|
+
"skip-cleanup",
|
|
5156
|
+
"Skip restoring the workspace (switching back to main) after export. Use when the workspace is discarded right after, e.g. an ephemeral CI container"
|
|
5157
|
+
],
|
|
5158
|
+
[
|
|
5159
|
+
"",
|
|
5160
|
+
"skip-tasks <tasks>",
|
|
5161
|
+
"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
5162
|
]
|
|
4963
5163
|
],
|
|
4964
5164
|
"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.
|
|
5165
|
+
"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
5166
|
"group": "collaborate",
|
|
4967
5167
|
"private": false
|
|
4968
5168
|
},
|
|
@@ -5908,162 +6108,6 @@
|
|
|
5908
6108
|
}
|
|
5909
6109
|
]
|
|
5910
6110
|
},
|
|
5911
|
-
{
|
|
5912
|
-
"name": "aspect <sub-command>",
|
|
5913
|
-
"alias": "",
|
|
5914
|
-
"options": [],
|
|
5915
|
-
"description": "manage component aspects and their configurations",
|
|
5916
|
-
"extendedDescription": "aspects provide functionality and tools for components throughout their development lifecycle.\nprimarily useful for inspecting aspect assignments and configurations with \"bit aspect get\".\nrarely used for manual aspect management as most aspects are configured automatically.",
|
|
5917
|
-
"group": "component-config",
|
|
5918
|
-
"private": false,
|
|
5919
|
-
"commands": [
|
|
5920
|
-
{
|
|
5921
|
-
"name": "list [pattern]",
|
|
5922
|
-
"alias": "",
|
|
5923
|
-
"options": [
|
|
5924
|
-
[
|
|
5925
|
-
"d",
|
|
5926
|
-
"debug",
|
|
5927
|
-
"show the origins where the aspects were taken from"
|
|
5928
|
-
]
|
|
5929
|
-
],
|
|
5930
|
-
"description": "list all aspects configured on component(s)",
|
|
5931
|
-
"extendedDescription": "",
|
|
5932
|
-
"group": "info-analysis",
|
|
5933
|
-
"private": false,
|
|
5934
|
-
"arguments": [
|
|
5935
|
-
{
|
|
5936
|
-
"name": "pattern",
|
|
5937
|
-
"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."
|
|
5938
|
-
}
|
|
5939
|
-
]
|
|
5940
|
-
},
|
|
5941
|
-
{
|
|
5942
|
-
"name": "list-core",
|
|
5943
|
-
"alias": "",
|
|
5944
|
-
"options": [
|
|
5945
|
-
[
|
|
5946
|
-
"j",
|
|
5947
|
-
"json",
|
|
5948
|
-
"format as json"
|
|
5949
|
-
]
|
|
5950
|
-
],
|
|
5951
|
-
"description": "list all core aspects",
|
|
5952
|
-
"extendedDescription": "",
|
|
5953
|
-
"group": "info-analysis",
|
|
5954
|
-
"private": false,
|
|
5955
|
-
"arguments": [
|
|
5956
|
-
{
|
|
5957
|
-
"name": "pattern",
|
|
5958
|
-
"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."
|
|
5959
|
-
}
|
|
5960
|
-
]
|
|
5961
|
-
},
|
|
5962
|
-
{
|
|
5963
|
-
"name": "get <component-name>",
|
|
5964
|
-
"alias": "",
|
|
5965
|
-
"options": [
|
|
5966
|
-
[
|
|
5967
|
-
"d",
|
|
5968
|
-
"debug",
|
|
5969
|
-
"show the origins where the aspects were taken from"
|
|
5970
|
-
],
|
|
5971
|
-
[
|
|
5972
|
-
"j",
|
|
5973
|
-
"json",
|
|
5974
|
-
"format as json"
|
|
5975
|
-
]
|
|
5976
|
-
],
|
|
5977
|
-
"description": "list the aspects set on a component, as well as their configs and data",
|
|
5978
|
-
"extendedDescription": "",
|
|
5979
|
-
"group": "info-analysis",
|
|
5980
|
-
"private": false,
|
|
5981
|
-
"arguments": [
|
|
5982
|
-
{
|
|
5983
|
-
"name": "component-name",
|
|
5984
|
-
"description": "the component name or component id to fetch aspects for"
|
|
5985
|
-
}
|
|
5986
|
-
]
|
|
5987
|
-
},
|
|
5988
|
-
{
|
|
5989
|
-
"name": "set <pattern> <aspect-id> [config]",
|
|
5990
|
-
"alias": "",
|
|
5991
|
-
"options": [
|
|
5992
|
-
[
|
|
5993
|
-
"m",
|
|
5994
|
-
"merge",
|
|
5995
|
-
"merge with an existing config if exits. (by default, it replaces overlapping existing configs)"
|
|
5996
|
-
]
|
|
5997
|
-
],
|
|
5998
|
-
"description": "set components with an aspect to extend their development tools, metadata and (possibly) artifacts",
|
|
5999
|
-
"extendedDescription": "",
|
|
6000
|
-
"group": "component-config",
|
|
6001
|
-
"private": false,
|
|
6002
|
-
"arguments": [
|
|
6003
|
-
{
|
|
6004
|
-
"name": "pattern",
|
|
6005
|
-
"description": "the components to extend. 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."
|
|
6006
|
-
},
|
|
6007
|
-
{
|
|
6008
|
-
"name": "aspect-id",
|
|
6009
|
-
"description": "the aspect's component id"
|
|
6010
|
-
},
|
|
6011
|
-
{
|
|
6012
|
-
"name": "config",
|
|
6013
|
-
"description": "the aspect config. enter the config as a stringified JSON (e.g. `{\"foo\":\"bar\"}` ). when no config is provided, an aspect is set with an empty config ({})."
|
|
6014
|
-
}
|
|
6015
|
-
]
|
|
6016
|
-
},
|
|
6017
|
-
{
|
|
6018
|
-
"name": "unset <pattern> <aspect-id>",
|
|
6019
|
-
"alias": "",
|
|
6020
|
-
"options": [],
|
|
6021
|
-
"description": "unset an aspect from component(s).",
|
|
6022
|
-
"extendedDescription": "",
|
|
6023
|
-
"group": "component-config",
|
|
6024
|
-
"private": false,
|
|
6025
|
-
"arguments": [
|
|
6026
|
-
{
|
|
6027
|
-
"name": "pattern",
|
|
6028
|
-
"description": "the components to target. 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."
|
|
6029
|
-
},
|
|
6030
|
-
{
|
|
6031
|
-
"name": "aspect-id",
|
|
6032
|
-
"description": "the aspect's component id"
|
|
6033
|
-
}
|
|
6034
|
-
]
|
|
6035
|
-
},
|
|
6036
|
-
{
|
|
6037
|
-
"name": "update <aspect-id> [pattern]",
|
|
6038
|
-
"alias": "",
|
|
6039
|
-
"options": [],
|
|
6040
|
-
"description": "update a version of an aspect for all or specified components",
|
|
6041
|
-
"extendedDescription": "",
|
|
6042
|
-
"group": "component-config",
|
|
6043
|
-
"private": false,
|
|
6044
|
-
"arguments": [
|
|
6045
|
-
{
|
|
6046
|
-
"name": "aspect-id",
|
|
6047
|
-
"description": "the aspect's component id. optionally, add a version (id@version), otherwise will use the latest version from the remote"
|
|
6048
|
-
},
|
|
6049
|
-
{
|
|
6050
|
-
"name": "pattern",
|
|
6051
|
-
"description": "the components to update (defaults to all components). 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."
|
|
6052
|
-
}
|
|
6053
|
-
],
|
|
6054
|
-
"examples": [
|
|
6055
|
-
{
|
|
6056
|
-
"cmd": "bit aspect update scope.org/aspect '**/ui/**'",
|
|
6057
|
-
"description": "update all components with the \"ui\" namespace that use scope.org/aspect, to use its latest version"
|
|
6058
|
-
},
|
|
6059
|
-
{
|
|
6060
|
-
"cmd": "bit aspect update scope.org/aspect@2.0.0",
|
|
6061
|
-
"description": "update version of scope.org/aspect to version 2.0.0 for all components configured with that aspect."
|
|
6062
|
-
}
|
|
6063
|
-
]
|
|
6064
|
-
}
|
|
6065
|
-
]
|
|
6066
|
-
},
|
|
6067
6111
|
{
|
|
6068
6112
|
"name": "internalize [component-pattern]",
|
|
6069
6113
|
"alias": "",
|