@teambit/harmony.content.cli-reference 2.0.397 → 2.0.398

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,5 +1,5 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.8.43'
2
+ description: 'Bit command synopses. Bit version: 1.8.44'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
5
5
 
@@ -1263,6 +1263,45 @@
1263
1263
  "group": "development",
1264
1264
  "private": false
1265
1265
  },
1266
+ {
1267
+ "name": "deprecate <component-name>",
1268
+ "alias": "d",
1269
+ "options": [
1270
+ [
1271
+ "",
1272
+ "new-id <string>",
1273
+ "if replaced by another component, enter the new component id. alternatively use \"bit rename --deprecate\" to do this automatically"
1274
+ ],
1275
+ [
1276
+ "",
1277
+ "range <string>",
1278
+ "enter a Semver range to deprecate specific versions. see https://www.npmjs.com/package/semver#ranges for the range syntax"
1279
+ ]
1280
+ ],
1281
+ "description": "deprecate a component",
1282
+ "extendedDescription": "",
1283
+ "group": "collaborate",
1284
+ "private": false,
1285
+ "remoteOp": true,
1286
+ "skipWorkspace": true,
1287
+ "arguments": [
1288
+ {
1289
+ "name": "component-name",
1290
+ "description": "component name or component id"
1291
+ }
1292
+ ]
1293
+ },
1294
+ {
1295
+ "name": "undeprecate <id>",
1296
+ "alias": "",
1297
+ "options": [],
1298
+ "description": "undeprecate a deprecated component (local/remote)",
1299
+ "extendedDescription": "",
1300
+ "group": "collaborate",
1301
+ "private": false,
1302
+ "remoteOp": true,
1303
+ "skipWorkspace": true
1304
+ },
1266
1305
  {
1267
1306
  "name": "ws-config <sub-command>",
1268
1307
  "alias": "workspace-config",
@@ -3396,45 +3435,6 @@
3396
3435
  }
3397
3436
  ]
3398
3437
  },
3399
- {
3400
- "name": "deprecate <component-name>",
3401
- "alias": "d",
3402
- "options": [
3403
- [
3404
- "",
3405
- "new-id <string>",
3406
- "if replaced by another component, enter the new component id. alternatively use \"bit rename --deprecate\" to do this automatically"
3407
- ],
3408
- [
3409
- "",
3410
- "range <string>",
3411
- "enter a Semver range to deprecate specific versions. see https://www.npmjs.com/package/semver#ranges for the range syntax"
3412
- ]
3413
- ],
3414
- "description": "deprecate a component",
3415
- "extendedDescription": "",
3416
- "group": "collaborate",
3417
- "private": false,
3418
- "remoteOp": true,
3419
- "skipWorkspace": true,
3420
- "arguments": [
3421
- {
3422
- "name": "component-name",
3423
- "description": "component name or component id"
3424
- }
3425
- ]
3426
- },
3427
- {
3428
- "name": "undeprecate <id>",
3429
- "alias": "",
3430
- "options": [],
3431
- "description": "undeprecate a deprecated component (local/remote)",
3432
- "extendedDescription": "",
3433
- "group": "collaborate",
3434
- "private": false,
3435
- "remoteOp": true,
3436
- "skipWorkspace": true
3437
- },
3438
3438
  {
3439
3439
  "name": "test [component-pattern]",
3440
3440
  "alias": "at",
@@ -4108,10 +4108,15 @@
4108
4108
  "workspace",
4109
4109
  "merge only lane components that are in the current workspace"
4110
4110
  ],
4111
+ [
4112
+ "",
4113
+ "no-auto-snap",
4114
+ "do not auto snap after merge completed without conflicts of diverged components (see command description)"
4115
+ ],
4111
4116
  [
4112
4117
  "",
4113
4118
  "no-snap",
4114
- "do not auto snap after merge completed without conflicts"
4119
+ "do not pass snaps from the other lane even for non-diverged components (see command description)"
4115
4120
  ],
4116
4121
  [
4117
4122
  "",
@@ -4185,7 +4190,7 @@
4185
4190
  ]
4186
4191
  ],
4187
4192
  "description": "merge a local or a remote lane to the current lane",
4188
- "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-snap\" to opt-out, or \"tag\" to tag instead.\n\nin case a component in both ends don'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",
4193
+ "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 in both ends don'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",
4189
4194
  "private": true,
4190
4195
  "remoteOp": true,
4191
4196
  "arguments": [
package/cli-reference.mdx CHANGED
@@ -1206,7 +1206,11 @@ by default, the provided lane will be fetched from the remote before merging.
1206
1206
  to merge the lane from the local scope without updating it first, use "--skip-fetch" flag.
1207
1207
 
1208
1208
  when the current and merge candidate lanes are diverged in history and the files could be merged with no conflicts,
1209
- these components will be snap-merged to complete the merge. use "no-snap" to opt-out, or "tag" to tag instead.
1209
+ these components will be snap-merged to complete the merge. use "no-auto-snap" to opt-out, or "tag" to tag instead.
1210
+
1211
+ when the components are not diverged in history, and the current lane is behind the merge candidate, the merge will
1212
+ simply update the components and the heads according to the merge candidate.
1213
+ to opt-out, use "--no-snap", the components will be written as the merge candidate, and will be left as modified.
1210
1214
 
1211
1215
  in case a component in both ends don't share history (no snap is found in common), the merge will require "--resolve-unrelated" flag.
1212
1216
  this 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:
@@ -1230,7 +1234,8 @@ this flag keeps the history of one end and saves a reference to the other end. t
1230
1234
  | `--ours` | | DEPRECATED. use --auto-merge-resolve. in case of a conflict, keep local modifications |
1231
1235
  | `--theirs` | | DEPRECATED. use --auto-merge-resolve. in case of a conflict, override local with incoming changes |
1232
1236
  | `--workspace` | | merge only lane components that are in the current workspace |
1233
- | `--no-snap` | | do not auto snap after merge completed without conflicts |
1237
+ | `--no-auto-snap` | | do not auto snap after merge completed without conflicts of diverged components (see command description) |
1238
+ | `--no-snap` | | do not pass snaps from the other lane even for non-diverged components (see command description) |
1234
1239
  | `--tag` | | auto-tag all lane components after merging into main (or tag-merge in case of snap-merge) |
1235
1240
  | `--build` | | in case of snap during the merge, run the build-pipeline (similar to bit snap --build) |
1236
1241
  | `--message <message>` | `-m` | override the default message for the auto snap |
@@ -1,5 +1,5 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.8.43'
2
+ description: 'Bit command synopses. Bit version: 1.8.44'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
5
5
 
@@ -1263,6 +1263,45 @@
1263
1263
  "group": "development",
1264
1264
  "private": false
1265
1265
  },
1266
+ {
1267
+ "name": "deprecate <component-name>",
1268
+ "alias": "d",
1269
+ "options": [
1270
+ [
1271
+ "",
1272
+ "new-id <string>",
1273
+ "if replaced by another component, enter the new component id. alternatively use \"bit rename --deprecate\" to do this automatically"
1274
+ ],
1275
+ [
1276
+ "",
1277
+ "range <string>",
1278
+ "enter a Semver range to deprecate specific versions. see https://www.npmjs.com/package/semver#ranges for the range syntax"
1279
+ ]
1280
+ ],
1281
+ "description": "deprecate a component",
1282
+ "extendedDescription": "",
1283
+ "group": "collaborate",
1284
+ "private": false,
1285
+ "remoteOp": true,
1286
+ "skipWorkspace": true,
1287
+ "arguments": [
1288
+ {
1289
+ "name": "component-name",
1290
+ "description": "component name or component id"
1291
+ }
1292
+ ]
1293
+ },
1294
+ {
1295
+ "name": "undeprecate <id>",
1296
+ "alias": "",
1297
+ "options": [],
1298
+ "description": "undeprecate a deprecated component (local/remote)",
1299
+ "extendedDescription": "",
1300
+ "group": "collaborate",
1301
+ "private": false,
1302
+ "remoteOp": true,
1303
+ "skipWorkspace": true
1304
+ },
1266
1305
  {
1267
1306
  "name": "ws-config <sub-command>",
1268
1307
  "alias": "workspace-config",
@@ -3396,45 +3435,6 @@
3396
3435
  }
3397
3436
  ]
3398
3437
  },
3399
- {
3400
- "name": "deprecate <component-name>",
3401
- "alias": "d",
3402
- "options": [
3403
- [
3404
- "",
3405
- "new-id <string>",
3406
- "if replaced by another component, enter the new component id. alternatively use \"bit rename --deprecate\" to do this automatically"
3407
- ],
3408
- [
3409
- "",
3410
- "range <string>",
3411
- "enter a Semver range to deprecate specific versions. see https://www.npmjs.com/package/semver#ranges for the range syntax"
3412
- ]
3413
- ],
3414
- "description": "deprecate a component",
3415
- "extendedDescription": "",
3416
- "group": "collaborate",
3417
- "private": false,
3418
- "remoteOp": true,
3419
- "skipWorkspace": true,
3420
- "arguments": [
3421
- {
3422
- "name": "component-name",
3423
- "description": "component name or component id"
3424
- }
3425
- ]
3426
- },
3427
- {
3428
- "name": "undeprecate <id>",
3429
- "alias": "",
3430
- "options": [],
3431
- "description": "undeprecate a deprecated component (local/remote)",
3432
- "extendedDescription": "",
3433
- "group": "collaborate",
3434
- "private": false,
3435
- "remoteOp": true,
3436
- "skipWorkspace": true
3437
- },
3438
3438
  {
3439
3439
  "name": "test [component-pattern]",
3440
3440
  "alias": "at",
@@ -4108,10 +4108,15 @@
4108
4108
  "workspace",
4109
4109
  "merge only lane components that are in the current workspace"
4110
4110
  ],
4111
+ [
4112
+ "",
4113
+ "no-auto-snap",
4114
+ "do not auto snap after merge completed without conflicts of diverged components (see command description)"
4115
+ ],
4111
4116
  [
4112
4117
  "",
4113
4118
  "no-snap",
4114
- "do not auto snap after merge completed without conflicts"
4119
+ "do not pass snaps from the other lane even for non-diverged components (see command description)"
4115
4120
  ],
4116
4121
  [
4117
4122
  "",
@@ -4185,7 +4190,7 @@
4185
4190
  ]
4186
4191
  ],
4187
4192
  "description": "merge a local or a remote lane to the current lane",
4188
- "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-snap\" to opt-out, or \"tag\" to tag instead.\n\nin case a component in both ends don'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",
4193
+ "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 in both ends don'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",
4189
4194
  "private": true,
4190
4195
  "remoteOp": true,
4191
4196
  "arguments": [
@@ -6231,7 +6231,11 @@ function MDXContent(_ref) {
6231
6231
  parentName: "p"
6232
6232
  }), "\n", "to merge the lane from the local scope without updating it first, use \"--skip-fetch\" flag."), (0, _react2.mdx)("p", null, "when the current and merge candidate lanes are diverged in history and the files could be merged with no conflicts,", (0, _react2.mdx)("br", {
6233
6233
  parentName: "p"
6234
- }), "\n", "these components will be snap-merged to complete the merge. use \"no-snap\" to opt-out, or \"tag\" to tag instead."), (0, _react2.mdx)("p", null, "in case a component in both ends don't share history (no snap is found in common), the merge will require \"--resolve-unrelated\" flag.", (0, _react2.mdx)("br", {
6234
+ }), "\n", "these components will be snap-merged to complete the merge. use \"no-auto-snap\" to opt-out, or \"tag\" to tag instead."), (0, _react2.mdx)("p", null, "when the components are not diverged in history, and the current lane is behind the merge candidate, the merge will", (0, _react2.mdx)("br", {
6235
+ parentName: "p"
6236
+ }), "\n", "simply update the components and the heads according to the merge candidate.", (0, _react2.mdx)("br", {
6237
+ parentName: "p"
6238
+ }), "\n", "to opt-out, use \"--no-snap\", the components will be written as the merge candidate, and will be left as modified."), (0, _react2.mdx)("p", null, "in case a component in both ends don't share history (no snap is found in common), the merge will require \"--resolve-unrelated\" flag.", (0, _react2.mdx)("br", {
6235
6239
  parentName: "p"
6236
6240
  }), "\n", "this 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:"), (0, _react2.mdx)("ol", null, (0, _react2.mdx)("li", {
6237
6241
  parentName: "ol"
@@ -6380,13 +6384,26 @@ function MDXContent(_ref) {
6380
6384
  "align": null
6381
6385
  }, (0, _react2.mdx)("inlineCode", {
6382
6386
  parentName: "td"
6387
+ }, "--no-auto-snap")), (0, _react2.mdx)("td", {
6388
+ parentName: "tr",
6389
+ "align": "center"
6390
+ }), (0, _react2.mdx)("td", {
6391
+ parentName: "tr",
6392
+ "align": null
6393
+ }, "do not auto snap after merge completed without conflicts of diverged components (see command description)")), (0, _react2.mdx)("tr", {
6394
+ parentName: "tbody"
6395
+ }, (0, _react2.mdx)("td", {
6396
+ parentName: "tr",
6397
+ "align": null
6398
+ }, (0, _react2.mdx)("inlineCode", {
6399
+ parentName: "td"
6383
6400
  }, "--no-snap")), (0, _react2.mdx)("td", {
6384
6401
  parentName: "tr",
6385
6402
  "align": "center"
6386
6403
  }), (0, _react2.mdx)("td", {
6387
6404
  parentName: "tr",
6388
6405
  "align": null
6389
- }, "do not auto snap after merge completed without conflicts")), (0, _react2.mdx)("tr", {
6406
+ }, "do not pass snaps from the other lane even for non-diverged components (see command description)")), (0, _react2.mdx)("tr", {
6390
6407
  parentName: "tbody"
6391
6408
  }, (0, _react2.mdx)("td", {
6392
6409
  parentName: "tr",