@teambit/harmony.content.cli-reference 1.95.99 → 1.95.100

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. package/cli-reference.mdx +39 -43
  2. package/dist/cli-reference.mdx.js +90 -35
  3. package/dist/cli-reference.mdx.js.map +1 -1
  4. package/dist/{preview-1670210914694.js → preview-1670383551627.js} +2 -2
  5. package/package-tar/teambit-harmony.content.cli-reference-1.95.100.tgz +0 -0
  6. package/package.json +2 -2
  7. package/package-tar/teambit-harmony.content.cli-reference-1.95.99.tgz +0 -0
package/cli-reference.mdx CHANGED
@@ -131,18 +131,17 @@ and a package.tgz file generated by pkg aspect.
131
131
 
132
132
  `bit build [component-pattern]`
133
133
 
134
- | **Option** | **Option alias** | **Description** |
135
- | ----------------------------------------------------------------------------------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------- |
136
- | `--all` | `-a` | DEPRECATED. use --unmodified |
137
- | `--unmodified` | `-u` | include unmodified components (by default, only new and modified components are built) |
138
- | `--dev` | `-d` | run the pipeline in dev mode |
139
- | `--install` | | install core aspects in capsules |
140
- | `--reuse-capsules` | | avoid deleting the capsules root-dir before starting the build |
141
- | `--tasks <string>` | | build the specified task(s) only. for multiple tasks, separate by a comma and wrap with quotes. |
142
- | specify the task-name (e.g. "TypescriptCompiler") or the task-aspect-id (e.g. teambit.compilation/compiler) |
143
- | `--cache-packages-on-capsule-root` | | set the package-manager cache on the capsule root |
144
- | `--list-tasks <string>` | | list tasks of an env or a component-id for each one of the pipelines: build, tag and snap |
145
- | `--skip-tests` | | skip running component tests during tag process |
134
+ | **Option** | **Option alias** | **Description** |
135
+ | ---------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
136
+ | `--all` | `-a` | DEPRECATED. use --unmodified |
137
+ | `--unmodified` | `-u` | include unmodified components (by default, only new and modified components are built) |
138
+ | `--dev` | `-d` | run the pipeline in dev mode |
139
+ | `--install` | | install core aspects in capsules |
140
+ | `--reuse-capsules` | | avoid deleting the capsules root-dir before starting the build |
141
+ | `--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) |
142
+ | `--cache-packages-on-capsule-root` | | set the package-manager cache on the capsule root |
143
+ | `--list-tasks <string>` | | list tasks of an env or a component-id for each one of the pipelines: build, tag and snap |
144
+ | `--skip-tests` | | skip running component tests during tag process |
146
145
 
147
146
  ---
148
147
 
@@ -1158,37 +1157,34 @@ if patterns are entered, you can specify a version per pattern using "@" sign, e
1158
1157
 
1159
1158
  `bit tag [component-patterns...]`
1160
1159
 
1161
- | **Option** | **Option alias** | **Description** |
1162
- | ---------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------ |
1163
- | `--message <message>` | `-m` | a log message describing latest changes |
1164
- | `--unmodified` | `-u` | include unmodified components (by default, only new and modified components are tagged) |
1165
- | `--editor [editor]` | | EXPERIMENTAL. open an editor to write a tag message for each component. optionally, specify the editor-name (defaults to vim). |
1166
- | `--ver <version>` | `-v` | tag with the given version |
1167
- | `--increment <level>` | `-l` | options are: [major, premajor, minor, preminor, patch, prepatch, prerelease], default to patch |
1168
- | `--prerelease-id <id>` | | prerelease identifier (e.g. "dev" to get "1.0.0-dev.1") |
1169
- | `--patch` | `-p` | syntactic sugar for "--increment patch" |
1170
- | `--minor` | | syntactic sugar for "--increment minor" |
1171
- | `--major` | | syntactic sugar for "--increment major" |
1172
- | `--pre-release [identifier]` | | syntactic sugar for "--increment prerelease" and `--prerelease-id <identifier>` |
1173
- | `--snapped` | | EXPERIMENTAL. tag components that their head is a snap (not a tag) |
1174
- | `--unmerged` | | EXPERIMENTAL. complete a merge process by tagging the unmerged components |
1175
- | `--skip-tests` | | skip running component tests during tag process |
1176
- | `--skip-auto-tag` | | skip auto tagging dependents |
1177
- | `--soft` | | do not persist. only keep note of the changes to be made |
1178
- | `--persist` | | persist the changes generated by --soft tag |
1179
- | `--disable-tag-pipeline` | | skip the tag pipeline to avoid publishing the components |
1180
- | `--force-deploy` | | run the tag pipeline although the build failed |
1181
- | `--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. |
1182
- | `--ignore-issues [issues]` | `-i` | ignore component issues (shown in "bit status" as "issues found"), issues to ignore: |
1183
-
1184
- [MissingPackagesDependenciesOnFs, MissingManuallyConfiguredPackages, MissingComponents, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, CustomModuleResolutionUsed, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies, DuplicateComponentAndPackage]
1185
- to ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify "\*".|
1186
- |`--ignore-newest-version`|`-I`|ignore existing of newer versions (default = false)|
1187
- |`--build`|`-b`|EXPERIMENTAL. not needed for now. run the pipeline build and complete the tag|
1188
- |`--all [version]`|`-a`|DEPRECATED (not needed anymore, it is the default now). tag all new and modified components|
1189
- |`--scope [version]`|`-s`|DEPRECATED (use "--unmodified" instead). tag all components of the current scope|
1190
- |`--force`|`-f`|DEPRECATED (use "--skip-tests" or "--unmodified" instead). force-tag even if tests are failing and even when component has not changed|
1191
- |`--disable-deploy-pipeline`| |DEPRECATED. use --disable-tag-pipeline instead|
1160
+ | **Option** | **Option alias** | **Description** |
1161
+ | ---------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1162
+ | `--message <message>` | `-m` | a log message describing latest changes |
1163
+ | `--unmodified` | `-u` | include unmodified components (by default, only new and modified components are tagged) |
1164
+ | `--editor [editor]` | | EXPERIMENTAL. open an editor to write a tag message for each component. optionally, specify the editor-name (defaults to vim). |
1165
+ | `--ver <version>` | `-v` | tag with the given version |
1166
+ | `--increment <level>` | `-l` | options are: [major, premajor, minor, preminor, patch, prepatch, prerelease], default to patch |
1167
+ | `--prerelease-id <id>` | | prerelease identifier (e.g. "dev" to get "1.0.0-dev.1") |
1168
+ | `--patch` | `-p` | syntactic sugar for "--increment patch" |
1169
+ | `--minor` | | syntactic sugar for "--increment minor" |
1170
+ | `--major` | | syntactic sugar for "--increment major" |
1171
+ | `--pre-release [identifier]` | | syntactic sugar for "--increment prerelease" and `--prerelease-id <identifier>` |
1172
+ | `--snapped` | | EXPERIMENTAL. tag components that their head is a snap (not a tag) |
1173
+ | `--unmerged` | | EXPERIMENTAL. complete a merge process by tagging the unmerged components |
1174
+ | `--skip-tests` | | skip running component tests during tag process |
1175
+ | `--skip-auto-tag` | | skip auto tagging dependents |
1176
+ | `--soft` | | do not persist. only keep note of the changes to be made |
1177
+ | `--persist` | | persist the changes generated by --soft tag |
1178
+ | `--disable-tag-pipeline` | | skip the tag pipeline to avoid publishing the components |
1179
+ | `--force-deploy` | | run the tag pipeline although the build failed |
1180
+ | `--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. |
1181
+ | `--ignore-issues [issues]` | `-i` | ignore component issues (shown in "bit status" as "issues found"), issues to ignore: [MissingPackagesDependenciesOnFs, MissingManuallyConfiguredPackages, MissingComponents, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, CustomModuleResolutionUsed, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies, DuplicateComponentAndPackage] to ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify "\*". |
1182
+ | `--ignore-newest-version` | `-I` | ignore existing of newer versions (default = false) |
1183
+ | `--build` | `-b` | EXPERIMENTAL. not needed for now. run the pipeline build and complete the tag |
1184
+ | `--all [version]` | `-a` | DEPRECATED (not needed anymore, it is the default now). tag all new and modified components |
1185
+ | `--scope [version]` | `-s` | DEPRECATED (use "--unmodified" instead). tag all components of the current scope |
1186
+ | `--force` | `-f` | DEPRECATED (use "--skip-tests" or "--unmodified" instead). force-tag even if tests are failing and even when component has not changed |
1187
+ | `--disable-deploy-pipeline` | | DEPRECATED. use --disable-tag-pipeline instead |
1192
1188
 
1193
1189
  ---
1194
1190
 
package/dist/cli-reference.mdx.js CHANGED
@@ -628,18 +628,7 @@ function MDXContent(_ref) {
628
628
  }), (0, _react2.mdx)("td", {
629
629
  parentName: "tr",
630
630
  "align": null
631
- }, "build the specified task(s) only. for multiple tasks, separate by a comma and wrap with quotes.")), (0, _react2.mdx)("tr", {
632
- parentName: "tbody"
633
- }, (0, _react2.mdx)("td", {
634
- parentName: "tr",
635
- "align": null
636
- }, "specify the task-name (e.g. \"TypescriptCompiler\") or the task-aspect-id (e.g. teambit.compilation/compiler)"), (0, _react2.mdx)("td", {
637
- parentName: "tr",
638
- "align": "center"
639
- }), (0, _react2.mdx)("td", {
640
- parentName: "tr",
641
- "align": null
642
- })), (0, _react2.mdx)("tr", {
631
+ }, "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)")), (0, _react2.mdx)("tr", {
643
632
  parentName: "tbody"
644
633
  }, (0, _react2.mdx)("td", {
645
634
  parentName: "tr",
@@ -5459,29 +5448,95 @@ function MDXContent(_ref) {
5459
5448
  }, "-i")), (0, _react2.mdx)("td", {
5460
5449
  parentName: "tr",
5461
5450
  "align": null
5462
- }, "ignore component issues (shown in \"bit status\" as \"issues found\"), issues to ignore:")))), (0, _react2.mdx)("p", null, "[MissingPackagesDependenciesOnFs, MissingManuallyConfiguredPackages, MissingComponents, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, CustomModuleResolutionUsed, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies, DuplicateComponentAndPackage]", "\nto ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify \"", "*", "\".|\n|", (0, _react2.mdx)("inlineCode", {
5463
- parentName: "p"
5464
- }, "--ignore-newest-version"), "|", (0, _react2.mdx)("inlineCode", {
5465
- parentName: "p"
5466
- }, "-I"), "|ignore existing of newer versions (default = false)|\n|", (0, _react2.mdx)("inlineCode", {
5467
- parentName: "p"
5468
- }, "--build"), "|", (0, _react2.mdx)("inlineCode", {
5469
- parentName: "p"
5470
- }, "-b"), "|EXPERIMENTAL. not needed for now. run the pipeline build and complete the tag|\n|", (0, _react2.mdx)("inlineCode", {
5471
- parentName: "p"
5472
- }, "--all [version]"), "|", (0, _react2.mdx)("inlineCode", {
5473
- parentName: "p"
5474
- }, "-a"), "|DEPRECATED (not needed anymore, it is the default now). tag all new and modified components|\n|", (0, _react2.mdx)("inlineCode", {
5475
- parentName: "p"
5476
- }, "--scope [version]"), "|", (0, _react2.mdx)("inlineCode", {
5477
- parentName: "p"
5478
- }, "-s"), "|DEPRECATED (use \"--unmodified\" instead). tag all components of the current scope|\n|", (0, _react2.mdx)("inlineCode", {
5479
- parentName: "p"
5480
- }, "--force"), "|", (0, _react2.mdx)("inlineCode", {
5481
- parentName: "p"
5482
- }, "-f"), "|DEPRECATED (use \"--skip-tests\" or \"--unmodified\" instead). force-tag even if tests are failing and even when component has not changed|\n|", (0, _react2.mdx)("inlineCode", {
5483
- parentName: "p"
5484
- }, "--disable-deploy-pipeline"), "| |DEPRECATED. use --disable-tag-pipeline instead|"), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "templates"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
5451
+ }, "ignore component issues (shown in \"bit status\" as \"issues found\"), issues to ignore: ", "[MissingPackagesDependenciesOnFs, MissingManuallyConfiguredPackages, MissingComponents, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, CustomModuleResolutionUsed, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies, DuplicateComponentAndPackage]", " to ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify \"", "*", "\".")), (0, _react2.mdx)("tr", {
5452
+ parentName: "tbody"
5453
+ }, (0, _react2.mdx)("td", {
5454
+ parentName: "tr",
5455
+ "align": null
5456
+ }, (0, _react2.mdx)("inlineCode", {
5457
+ parentName: "td"
5458
+ }, "--ignore-newest-version")), (0, _react2.mdx)("td", {
5459
+ parentName: "tr",
5460
+ "align": "center"
5461
+ }, (0, _react2.mdx)("inlineCode", {
5462
+ parentName: "td"
5463
+ }, "-I")), (0, _react2.mdx)("td", {
5464
+ parentName: "tr",
5465
+ "align": null
5466
+ }, "ignore existing of newer versions (default = false)")), (0, _react2.mdx)("tr", {
5467
+ parentName: "tbody"
5468
+ }, (0, _react2.mdx)("td", {
5469
+ parentName: "tr",
5470
+ "align": null
5471
+ }, (0, _react2.mdx)("inlineCode", {
5472
+ parentName: "td"
5473
+ }, "--build")), (0, _react2.mdx)("td", {
5474
+ parentName: "tr",
5475
+ "align": "center"
5476
+ }, (0, _react2.mdx)("inlineCode", {
5477
+ parentName: "td"
5478
+ }, "-b")), (0, _react2.mdx)("td", {
5479
+ parentName: "tr",
5480
+ "align": null
5481
+ }, "EXPERIMENTAL. not needed for now. run the pipeline build and complete the tag")), (0, _react2.mdx)("tr", {
5482
+ parentName: "tbody"
5483
+ }, (0, _react2.mdx)("td", {
5484
+ parentName: "tr",
5485
+ "align": null
5486
+ }, (0, _react2.mdx)("inlineCode", {
5487
+ parentName: "td"
5488
+ }, "--all [version]")), (0, _react2.mdx)("td", {
5489
+ parentName: "tr",
5490
+ "align": "center"
5491
+ }, (0, _react2.mdx)("inlineCode", {
5492
+ parentName: "td"
5493
+ }, "-a")), (0, _react2.mdx)("td", {
5494
+ parentName: "tr",
5495
+ "align": null
5496
+ }, "DEPRECATED (not needed anymore, it is the default now). tag all new and modified components")), (0, _react2.mdx)("tr", {
5497
+ parentName: "tbody"
5498
+ }, (0, _react2.mdx)("td", {
5499
+ parentName: "tr",
5500
+ "align": null
5501
+ }, (0, _react2.mdx)("inlineCode", {
5502
+ parentName: "td"
5503
+ }, "--scope [version]")), (0, _react2.mdx)("td", {
5504
+ parentName: "tr",
5505
+ "align": "center"
5506
+ }, (0, _react2.mdx)("inlineCode", {
5507
+ parentName: "td"
5508
+ }, "-s")), (0, _react2.mdx)("td", {
5509
+ parentName: "tr",
5510
+ "align": null
5511
+ }, "DEPRECATED (use \"--unmodified\" instead). tag all components of the current scope")), (0, _react2.mdx)("tr", {
5512
+ parentName: "tbody"
5513
+ }, (0, _react2.mdx)("td", {
5514
+ parentName: "tr",
5515
+ "align": null
5516
+ }, (0, _react2.mdx)("inlineCode", {
5517
+ parentName: "td"
5518
+ }, "--force")), (0, _react2.mdx)("td", {
5519
+ parentName: "tr",
5520
+ "align": "center"
5521
+ }, (0, _react2.mdx)("inlineCode", {
5522
+ parentName: "td"
5523
+ }, "-f")), (0, _react2.mdx)("td", {
5524
+ parentName: "tr",
5525
+ "align": null
5526
+ }, "DEPRECATED (use \"--skip-tests\" or \"--unmodified\" instead). force-tag even if tests are failing and even when component has not changed")), (0, _react2.mdx)("tr", {
5527
+ parentName: "tbody"
5528
+ }, (0, _react2.mdx)("td", {
5529
+ parentName: "tr",
5530
+ "align": null
5531
+ }, (0, _react2.mdx)("inlineCode", {
5532
+ parentName: "td"
5533
+ }, "--disable-deploy-pipeline")), (0, _react2.mdx)("td", {
5534
+ parentName: "tr",
5535
+ "align": "center"
5536
+ }), (0, _react2.mdx)("td", {
5537
+ parentName: "tr",
5538
+ "align": null
5539
+ }, "DEPRECATED. use --disable-tag-pipeline instead")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "templates"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
5485
5540
  parentName: "p"
5486
5541
  }, "Workspace only"), ": yes", (0, _react2.mdx)("br", {
5487
5542
  parentName: "p"