@teambit/harmony.content.cli-reference 2.0.597 → 2.0.599

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.
@@ -1,4 +1,4 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.9.110'
2
+ description: 'Bit command synopses. Bit version: 1.9.112'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
@@ -878,47 +878,6 @@
878
878
  "group": "ungrouped",
879
879
  "private": true
880
880
  },
881
- {
882
- "name": "_scope-gc",
883
- "alias": "",
884
- "options": [
885
- [
886
- "v",
887
- "verbose",
888
- "show verbose output"
889
- ],
890
- [
891
- "d",
892
- "dry-run",
893
- "print the refs that are going to be deleted without actually deleting them"
894
- ],
895
- [
896
- "f",
897
- "find-comp-id-origin <comp-id>",
898
- "find the origin of a specific component"
899
- ],
900
- [
901
- "s",
902
- "find-scope-id-origin <scope-id>",
903
- "find the origin of all components of the given scope. for multiple scopes, wrap with quotes and separate with commas"
904
- ],
905
- [
906
- "r",
907
- "restore",
908
- "restore deleted objects (copy objects from \"deleted-objects\" directory to the scope)"
909
- ],
910
- [
911
- "",
912
- "restore-overwrite",
913
- "same as --restore but overwrite existing objects"
914
- ]
915
- ],
916
- "description": "delete objects that have no reference from the components/lanes of this scope",
917
- "extendedDescription": "the deleted objects are copied into \"deleted-objects\" directory in the local scope",
918
- "group": "ungrouped",
919
- "private": true,
920
- "remoteOp": true
921
- },
922
881
  {
923
882
  "name": "version-history <sub-command>",
924
883
  "alias": "vh",
@@ -3194,212 +3153,6 @@
3194
3153
  }
3195
3154
  ]
3196
3155
  },
3197
- {
3198
- "name": "_tag <data>",
3199
- "alias": "",
3200
- "options": [
3201
- [
3202
- "",
3203
- "push",
3204
- "export the updated objects to the original scopes once done"
3205
- ],
3206
- [
3207
- "",
3208
- "rebuild-artifacts",
3209
- "run the full build pipeline. do not use the saved artifacts from the last snap"
3210
- ],
3211
- [
3212
- "",
3213
- "ignore-last-pkg-json",
3214
- "ignore the package.json created by the last snap"
3215
- ],
3216
- [
3217
- "",
3218
- "override-head",
3219
- "opposite of detach-head. in case a component is checked out to an older version, change head to the newly created version"
3220
- ],
3221
- [
3222
- "m",
3223
- "message <message>",
3224
- "a log message describing latest changes"
3225
- ],
3226
- [
3227
- "v",
3228
- "ver <version>",
3229
- "tag with the given version"
3230
- ],
3231
- [
3232
- "l",
3233
- "increment <level>",
3234
- "options are: [major, premajor, minor, preminor, patch, prepatch, prerelease], default to patch"
3235
- ],
3236
- [
3237
- "",
3238
- "prerelease-id <id>",
3239
- "prerelease identifier (e.g. \"dev\" to get \"1.0.0-dev.1\")"
3240
- ],
3241
- [
3242
- "p",
3243
- "patch",
3244
- "syntactic sugar for \"--increment patch\""
3245
- ],
3246
- [
3247
- "",
3248
- "minor",
3249
- "syntactic sugar for \"--increment minor\""
3250
- ],
3251
- [
3252
- "",
3253
- "major",
3254
- "syntactic sugar for \"--increment major\""
3255
- ],
3256
- [
3257
- "",
3258
- "pre-release [identifier]",
3259
- "syntactic sugar for \"--increment prerelease\" and `--prerelease-id <identifier>`"
3260
- ],
3261
- [
3262
- "",
3263
- "skip-tests",
3264
- "skip running component tests during tag process"
3265
- ],
3266
- [
3267
- "",
3268
- "skip-tasks <string>",
3269
- "skip the given tasks. for multiple tasks, separate by a comma and wrap with quotes.\nspecify the task-name (e.g. \"TypescriptCompiler\") or the task-aspect-id (e.g. teambit.compilation/compiler)"
3270
- ],
3271
- [
3272
- "",
3273
- "skip-auto-tag",
3274
- "skip auto tagging dependents"
3275
- ],
3276
- [
3277
- "",
3278
- "disable-tag-pipeline",
3279
- "skip the tag pipeline to avoid publishing the components"
3280
- ],
3281
- [
3282
- "",
3283
- "ignore-build-errors",
3284
- "proceed to tag pipeline even when build pipeline fails"
3285
- ],
3286
- [
3287
- "",
3288
- "rebuild-deps-graph",
3289
- "do not reuse the saved dependencies graph, instead build it from scratch"
3290
- ],
3291
- [
3292
- "",
3293
- "increment-by <number>",
3294
- "(default to 1) increment semver flag (patch/minor/major) by. e.g. incrementing patch by 2: 0.0.1 -> 0.0.3."
3295
- ],
3296
- [
3297
- "i",
3298
- "ignore-issues <issues>",
3299
- "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 \"*\"."
3300
- ],
3301
- [
3302
- "I",
3303
- "ignore-newest-version",
3304
- "allow tagging even when the component has newer versions e.g. for hotfixes."
3305
- ],
3306
- [
3307
- "",
3308
- "fail-fast",
3309
- "stop pipeline execution on the first failed task (by default a task is skipped only when its dependency failed)"
3310
- ],
3311
- [
3312
- "b",
3313
- "build",
3314
- "locally run the build pipeline (i.e. not via rippleCI) and complete the tag"
3315
- ],
3316
- [
3317
- "",
3318
- "detach-head",
3319
- "UNSUPPORTED YET. in case a component is checked out to an older version, tag it without changing the head"
3320
- ]
3321
- ],
3322
- "description": "tag components from a bare-scope by using build artifacts from previous snap and running the deploy-pipeline only",
3323
- "extendedDescription": "this command should be running from a new bare scope, it first imports the components it needs and then processes the tag.\nthe input data is a stringified JSON of an array of the following object.\n{\n componentId: string; // ids always have scope, so it's safe to parse them from string\n dependencies?: string[]; // e.g. [teambit/compiler@1.0.0, teambit/tester^@1.0.0, teambit/linter~@0.0.1]\n versionToTag?: string; // specific version (e.g. '1.0.0') or semver (e.g. 'minor', 'patch')\n prereleaseId?: string; // applicable when versionToTag is a pre-release. (e.g. \"dev\", for 1.0.0-dev.1)\n message?: string; // tag-message.\n}\nan example of the final data: '[{\"componentId\":\"ci.remote2/comp-b\",\"dependencies\":[\"ci.remote/comp1@0.0.2\"]}]'\n",
3324
- "group": "development",
3325
- "private": true,
3326
- "remoteOp": true
3327
- },
3328
- {
3329
- "name": "_snap <data>",
3330
- "alias": "",
3331
- "options": [
3332
- [
3333
- "",
3334
- "push",
3335
- "export the updated objects to the original scopes once done"
3336
- ],
3337
- [
3338
- "m",
3339
- "message <message>",
3340
- "log message describing the latest changes"
3341
- ],
3342
- [
3343
- "",
3344
- "lane <lane-id>",
3345
- "fetch the components from the given lane"
3346
- ],
3347
- [
3348
- "",
3349
- "build",
3350
- "run the build pipeline"
3351
- ],
3352
- [
3353
- "",
3354
- "skip-tests",
3355
- "skip running component tests during snap process"
3356
- ],
3357
- [
3358
- "",
3359
- "disable-snap-pipeline",
3360
- "skip the snap pipeline"
3361
- ],
3362
- [
3363
- "",
3364
- "ignore-build-errors",
3365
- "run the snap pipeline although the build pipeline failed"
3366
- ],
3367
- [
3368
- "",
3369
- "rebuild-deps-graph",
3370
- "do not reuse the saved dependencies graph, instead build it from scratch"
3371
- ],
3372
- [
3373
- "i",
3374
- "ignore-issues [issues]",
3375
- "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 \"*\"."
3376
- ],
3377
- [
3378
- "",
3379
- "tag",
3380
- "make a tag instead of a snap"
3381
- ],
3382
- [
3383
- "",
3384
- "stream",
3385
- "relevant for --json only. stream loader as json strings"
3386
- ],
3387
- [
3388
- "j",
3389
- "json",
3390
- "output as json format"
3391
- ],
3392
- [
3393
- "",
3394
- "update-dependents",
3395
- "when snapped on a lane, mark it as update-dependents so it will be skipped from the workspace"
3396
- ]
3397
- ],
3398
- "description": "snap components from a bare-scope",
3399
- "extendedDescription": "this command should be running from a new bare scope, it first imports the components it needs and then processes the snap.\nthe input data is a stringified JSON of an array of the following object.\n{\n componentId: string; // ids always have scope, so it's safe to parse them from string\n dependencies?: string[]; // dependencies include versions. for components use component-id. e.g. [teambit.compilation/compiler@1.0.0, lodash@4.17.21]\n aspects?: Record<string,any> // e.g. { \"teambit.react/react\": {}, \"teambit.envs/envs\": { \"env\": \"teambit.react/react\" } }\n message?: string; // tag-message.\n files?: Array<{path: string, content: string}>; // replace content of specified source-files. the content is base64 encoded.\n isNew?: boolean; // if it's new, it'll be generated from the given files. otherwise, it'll be fetched from the scope and updated.\n mainFile?: string; // relevant when isNew is true. default to \"index.ts\".\n newDependencies?: Array<{ // new dependencies (components and packages) to add.\n id: string; // component-id or package-name. e.g. \"teambit.react/react\" or \"lodash\".\n version?: string; // version of the package. e.g. \"2.0.3\". for packages, it is mandatory.\n isComponent?: boolean; // default true. if false, it's a package dependency\n type?: 'runtime' | 'dev' | 'peer'; // default \"runtime\".\n }>;\n removeDependencies?: string[]; // component-id (for components) or package-name (for packages) to remove from the dependencies.\n forkFrom?: string; // origin id to fork from. the componentId is the new id. (no need to populate isNew prop).\n version?: string; // relevant when passing \"--tag\". optionally, specify the semver to tag. default to \"patch\".\n}\nan example of the final data: '[{\"componentId\":\"ci.remote2/comp-b\",\"message\": \"first snap\"}]'\n",
3400
- "group": "ungrouped",
3401
- "private": true
3402
- },
3403
3156
  {
3404
3157
  "name": "snap-distance <component-id> [source-snap] [target-snap]",
3405
3158
  "alias": "",
@@ -4627,77 +4380,6 @@
4627
4380
  "group": "general",
4628
4381
  "private": false
4629
4382
  },
4630
- {
4631
- "name": "_merge-lane <from-lane> [to-lane]",
4632
- "alias": "",
4633
- "options": [
4634
- [
4635
- "",
4636
- "pattern <string>",
4637
- "partially merge the lane with the specified component-pattern"
4638
- ],
4639
- [
4640
- "",
4641
- "title <string>",
4642
- "if provided, it replaces the original message with this title and append squashed snaps messages"
4643
- ],
4644
- [
4645
- "",
4646
- "title-base64 <string>",
4647
- "same as --title flag but the title is base64 encoded"
4648
- ],
4649
- [
4650
- "",
4651
- "push",
4652
- "export the updated objects to the original scopes once done"
4653
- ],
4654
- [
4655
- "",
4656
- "build",
4657
- "in case of snap during the merge, run the build-pipeline (similar to bit snap --build)"
4658
- ],
4659
- [
4660
- "",
4661
- "keep-readme",
4662
- "skip deleting the lane readme component after merging"
4663
- ],
4664
- [
4665
- "",
4666
- "no-squash",
4667
- "relevant for merging lanes into main, which by default squash."
4668
- ],
4669
- [
4670
- "",
4671
- "include-deps",
4672
- "relevant for \"--pattern\". merge also dependencies of the given components"
4673
- ],
4674
- [
4675
- "",
4676
- "re-merge",
4677
- "helpful when last merge failed during export. do not skip components that seemed to be merged"
4678
- ],
4679
- [
4680
- "j",
4681
- "json",
4682
- "output as json format"
4683
- ]
4684
- ],
4685
- "description": "merge a remote lane into another lane or main via a bare-scope (not workspace)",
4686
- "extendedDescription": "to merge from a workspace, use \"bit lane merge\" command.\nthis is intended to use from the UI, which will have a button to merge an existing lane.\nthe lane must be up-to-date with the other lane, otherwise, conflicts might occur which are not handled in this command",
4687
- "group": "ungrouped",
4688
- "private": true,
4689
- "remoteOp": true,
4690
- "arguments": [
4691
- {
4692
- "name": "from-lane",
4693
- "description": "lane-id to merge from or \"main\""
4694
- },
4695
- {
4696
- "name": "to-lane",
4697
- "description": "lane-id to merge to. default is \"main\""
4698
- }
4699
- ]
4700
- },
4701
4383
  {
4702
4384
  "name": "pack <componentId> [scopePath]",
4703
4385
  "alias": "",
@@ -1,4 +1,4 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.9.110'
2
+ description: 'Bit command synopses. Bit version: 1.9.112'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---