@teambit/harmony.content.cli-reference 1.95.64 → 1.95.67

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 (9) hide show
  1. package/cli-reference.json +75 -70
  2. package/cli-reference.mdx +18 -22
  3. package/dist/cli-reference.json +75 -70
  4. package/dist/cli-reference.mdx.js +10 -42
  5. package/dist/cli-reference.mdx.js.map +1 -1
  6. package/package-tar/teambit-harmony.content.cli-reference-1.95.67.tgz +0 -0
  7. package/package.json +3 -3
  8. package/{preview-1662043423030.js → preview-1662281577904.js} +2 -2
  9. package/package-tar/teambit-harmony.content.cli-reference-1.95.64.tgz +0 -0
package/cli-reference.json CHANGED
@@ -494,76 +494,6 @@
494
494
  "private": true,
495
495
  "internal": true
496
496
  },
497
- {
498
- "name": "checkout [values...]",
499
- "alias": "U",
500
- "options": [
501
- [
502
- "i",
503
- "interactive-merge",
504
- "when a component is modified and the merge process found conflicts, display options to resolve them"
505
- ],
506
- [
507
- "o",
508
- "ours",
509
- "in case of a conflict, override the used version with the current modification"
510
- ],
511
- [
512
- "t",
513
- "theirs",
514
- "in case of a conflict, override the current modification with the specified version"
515
- ],
516
- [
517
- "m",
518
- "manual",
519
- "in case of a conflict, leave the files with a conflict state to resolve them manually later"
520
- ],
521
- [
522
- "r",
523
- "reset",
524
- "revert changes that were not snapped/tagged"
525
- ],
526
- [
527
- "a",
528
- "all",
529
- "all components"
530
- ],
531
- [
532
- "v",
533
- "verbose",
534
- "showing verbose output for inspection"
535
- ],
536
- [
537
- "",
538
- "skip-npm-install",
539
- "DEPRECATED. use \"--skip-dependency-installation\" instead"
540
- ],
541
- [
542
- "",
543
- "skip-dependency-installation",
544
- "do not install packages of the imported components"
545
- ],
546
- [
547
- "",
548
- "ignore-package-json",
549
- "do not generate package.json for the imported component(s). (it automatically enables skip-npm-install and save-dependencies-as-components flags)"
550
- ],
551
- [
552
- "",
553
- "conf [path]",
554
- "write the configuration file (bit.json) and the envs configuration files (use --conf without path to write to the default dir)"
555
- ],
556
- [
557
- "",
558
- "ignore-dist",
559
- "do not write dist files (when exist)"
560
- ]
561
- ],
562
- "description": "switch between component versions or remove local changes",
563
- "extendedDescription": "\n `bit checkout <version> [ids...]` => checkout the specified ids (or all components when --all is used) to the specified version\n `bit checkout head` => checkout all components to their latest versions\n `bit checkout head [ids...]` => checkout the specified ids to their latest versions\n `bit checkout [ids...] --reset` => remove local modifications from the specified ids (or all components when --all is used)\n you can use a pattern for multiple ids, such as bit checkout 0.0.1 \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
564
- "group": "development",
565
- "private": false
566
- },
567
497
  {
568
498
  "name": "diff [values...]",
569
499
  "alias": "",
@@ -1369,6 +1299,76 @@
1369
1299
  }
1370
1300
  ]
1371
1301
  },
1302
+ {
1303
+ "name": "checkout <to> [component-pattern]",
1304
+ "alias": "U",
1305
+ "options": [
1306
+ [
1307
+ "i",
1308
+ "interactive-merge",
1309
+ "when a component is modified and the merge process found conflicts, display options to resolve them"
1310
+ ],
1311
+ [
1312
+ "o",
1313
+ "ours",
1314
+ "in case of a conflict, override the used version with the current modification"
1315
+ ],
1316
+ [
1317
+ "t",
1318
+ "theirs",
1319
+ "in case of a conflict, override the current modification with the specified version"
1320
+ ],
1321
+ [
1322
+ "m",
1323
+ "manual",
1324
+ "in case of a conflict, leave the files with a conflict state to resolve them manually later"
1325
+ ],
1326
+ [
1327
+ "r",
1328
+ "reset",
1329
+ "revert changes that were not snapped/tagged"
1330
+ ],
1331
+ [
1332
+ "a",
1333
+ "all",
1334
+ "all components"
1335
+ ],
1336
+ [
1337
+ "v",
1338
+ "verbose",
1339
+ "showing verbose output for inspection"
1340
+ ],
1341
+ [
1342
+ "",
1343
+ "reset",
1344
+ "DEPRECATED. run \"bit checkout reset\" instead"
1345
+ ],
1346
+ [
1347
+ "",
1348
+ "skip-npm-install",
1349
+ "DEPRECATED. use \"--skip-dependency-installation\" instead"
1350
+ ],
1351
+ [
1352
+ "",
1353
+ "skip-dependency-installation",
1354
+ "do not install packages of the imported components"
1355
+ ]
1356
+ ],
1357
+ "description": "switch between component versions or remove local changes",
1358
+ "extendedDescription": "\n `bit checkout <version> [component-pattern]` => checkout the specified ids (or all components when --all is used) to the specified version\n `bit checkout head [component-pattern]` => checkout to the last snap/tag, omit [component-pattern] to checkout head for all\n `bit checkout reset [component-pattern]` => remove local modifications from the specified ids (or all components when --all is used)",
1359
+ "group": "development",
1360
+ "private": false,
1361
+ "arguments": [
1362
+ {
1363
+ "name": "to",
1364
+ "description": "permitted values: [head, reset, specific-version]. 'head' - last snap/tag. 'reset' - removes local changes"
1365
+ },
1366
+ {
1367
+ "name": "component-pattern",
1368
+ "description": "component name, component id, or component pattern. use component pattern to select multiple components.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
1369
+ }
1370
+ ]
1371
+ },
1372
1372
  {
1373
1373
  "name": "remove <component-pattern>",
1374
1374
  "alias": "rm",
@@ -2113,6 +2113,11 @@
2113
2113
  "no-squash",
2114
2114
  "EXPERIMENTAL. relevant for merging lanes into main, which by default squash."
2115
2115
  ],
2116
+ [
2117
+ "",
2118
+ "ignore-config-changes",
2119
+ "allow merging when component are modified due to config changes (such as dependencies) only and not files"
2120
+ ],
2116
2121
  [
2117
2122
  "",
2118
2123
  "verbose",
package/cli-reference.mdx CHANGED
@@ -217,28 +217,24 @@ with no args, only workspace's capsules are deleted
217
217
  **Workspace only**: yes
218
218
  **Description**: switch between component versions or remove local changes
219
219
 
220
- `bit checkout <version> [ids...]` => checkout the specified ids (or all components when --all is used) to the specified version
221
- `bit checkout head` => checkout all components to their latest versions
222
- `bit checkout head [ids...]` => checkout the specified ids to their latest versions
223
- `bit checkout [ids...] --reset` => remove local modifications from the specified ids (or all components when --all is used)
224
- you can use a pattern for multiple ids, such as bit checkout 0.0.1 "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
225
-
226
- `bit checkout [values...]`
227
-
228
- | **Option** | **Option alias** | **Description** |
229
- | -------------------------------- | :--------------: | ------------------------------------------------------------------------------------------------------------------------------------------------- |
230
- | `--interactive-merge` | `-i` | when a component is modified and the merge process found conflicts, display options to resolve them |
231
- | `--ours` | `-o` | in case of a conflict, override the used version with the current modification |
232
- | `--theirs` | `-t` | in case of a conflict, override the current modification with the specified version |
233
- | `--manual` | `-m` | in case of a conflict, leave the files with a conflict state to resolve them manually later |
234
- | `--reset` | `-r` | revert changes that were not snapped/tagged |
235
- | `--all` | `-a` | all components |
236
- | `--verbose` | `-v` | showing verbose output for inspection |
237
- | `--skip-npm-install` | | DEPRECATED. use "--skip-dependency-installation" instead |
238
- | `--skip-dependency-installation` | | do not install packages of the imported components |
239
- | `--ignore-package-json` | | do not generate package.json for the imported component(s). (it automatically enables skip-npm-install and save-dependencies-as-components flags) |
240
- | `--conf [path]` | | write the configuration file (bit.json) and the envs configuration files (use --conf without path to write to the default dir) |
241
- | `--ignore-dist` | | do not write dist files (when exist) |
220
+ `bit checkout <version> [component-pattern]` => checkout the specified ids (or all components when --all is used) to the specified version
221
+ `bit checkout head [component-pattern]` => checkout to the last snap/tag, omit [component-pattern] to checkout head for all
222
+ `bit checkout reset [component-pattern]` => remove local modifications from the specified ids (or all components when --all is used)
223
+
224
+ `bit checkout <to> [component-pattern]`
225
+
226
+ | **Option** | **Option alias** | **Description** |
227
+ | -------------------------------- | :--------------: | --------------------------------------------------------------------------------------------------- |
228
+ | `--interactive-merge` | `-i` | when a component is modified and the merge process found conflicts, display options to resolve them |
229
+ | `--ours` | `-o` | in case of a conflict, override the used version with the current modification |
230
+ | `--theirs` | `-t` | in case of a conflict, override the current modification with the specified version |
231
+ | `--manual` | `-m` | in case of a conflict, leave the files with a conflict state to resolve them manually later |
232
+ | `--reset` | `-r` | revert changes that were not snapped/tagged |
233
+ | `--all` | `-a` | all components |
234
+ | `--verbose` | `-v` | showing verbose output for inspection |
235
+ | `--reset` | | DEPRECATED. run "bit checkout reset" instead |
236
+ | `--skip-npm-install` | | DEPRECATED. use "--skip-dependency-installation" instead |
237
+ | `--skip-dependency-installation` | | do not install packages of the imported components |
242
238
 
243
239
  ---
244
240
 
package/dist/cli-reference.json CHANGED
@@ -494,76 +494,6 @@
494
494
  "private": true,
495
495
  "internal": true
496
496
  },
497
- {
498
- "name": "checkout [values...]",
499
- "alias": "U",
500
- "options": [
501
- [
502
- "i",
503
- "interactive-merge",
504
- "when a component is modified and the merge process found conflicts, display options to resolve them"
505
- ],
506
- [
507
- "o",
508
- "ours",
509
- "in case of a conflict, override the used version with the current modification"
510
- ],
511
- [
512
- "t",
513
- "theirs",
514
- "in case of a conflict, override the current modification with the specified version"
515
- ],
516
- [
517
- "m",
518
- "manual",
519
- "in case of a conflict, leave the files with a conflict state to resolve them manually later"
520
- ],
521
- [
522
- "r",
523
- "reset",
524
- "revert changes that were not snapped/tagged"
525
- ],
526
- [
527
- "a",
528
- "all",
529
- "all components"
530
- ],
531
- [
532
- "v",
533
- "verbose",
534
- "showing verbose output for inspection"
535
- ],
536
- [
537
- "",
538
- "skip-npm-install",
539
- "DEPRECATED. use \"--skip-dependency-installation\" instead"
540
- ],
541
- [
542
- "",
543
- "skip-dependency-installation",
544
- "do not install packages of the imported components"
545
- ],
546
- [
547
- "",
548
- "ignore-package-json",
549
- "do not generate package.json for the imported component(s). (it automatically enables skip-npm-install and save-dependencies-as-components flags)"
550
- ],
551
- [
552
- "",
553
- "conf [path]",
554
- "write the configuration file (bit.json) and the envs configuration files (use --conf without path to write to the default dir)"
555
- ],
556
- [
557
- "",
558
- "ignore-dist",
559
- "do not write dist files (when exist)"
560
- ]
561
- ],
562
- "description": "switch between component versions or remove local changes",
563
- "extendedDescription": "\n `bit checkout <version> [ids...]` => checkout the specified ids (or all components when --all is used) to the specified version\n `bit checkout head` => checkout all components to their latest versions\n `bit checkout head [ids...]` => checkout the specified ids to their latest versions\n `bit checkout [ids...] --reset` => remove local modifications from the specified ids (or all components when --all is used)\n you can use a pattern for multiple ids, such as bit checkout 0.0.1 \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
564
- "group": "development",
565
- "private": false
566
- },
567
497
  {
568
498
  "name": "diff [values...]",
569
499
  "alias": "",
@@ -1369,6 +1299,76 @@
1369
1299
  }
1370
1300
  ]
1371
1301
  },
1302
+ {
1303
+ "name": "checkout <to> [component-pattern]",
1304
+ "alias": "U",
1305
+ "options": [
1306
+ [
1307
+ "i",
1308
+ "interactive-merge",
1309
+ "when a component is modified and the merge process found conflicts, display options to resolve them"
1310
+ ],
1311
+ [
1312
+ "o",
1313
+ "ours",
1314
+ "in case of a conflict, override the used version with the current modification"
1315
+ ],
1316
+ [
1317
+ "t",
1318
+ "theirs",
1319
+ "in case of a conflict, override the current modification with the specified version"
1320
+ ],
1321
+ [
1322
+ "m",
1323
+ "manual",
1324
+ "in case of a conflict, leave the files with a conflict state to resolve them manually later"
1325
+ ],
1326
+ [
1327
+ "r",
1328
+ "reset",
1329
+ "revert changes that were not snapped/tagged"
1330
+ ],
1331
+ [
1332
+ "a",
1333
+ "all",
1334
+ "all components"
1335
+ ],
1336
+ [
1337
+ "v",
1338
+ "verbose",
1339
+ "showing verbose output for inspection"
1340
+ ],
1341
+ [
1342
+ "",
1343
+ "reset",
1344
+ "DEPRECATED. run \"bit checkout reset\" instead"
1345
+ ],
1346
+ [
1347
+ "",
1348
+ "skip-npm-install",
1349
+ "DEPRECATED. use \"--skip-dependency-installation\" instead"
1350
+ ],
1351
+ [
1352
+ "",
1353
+ "skip-dependency-installation",
1354
+ "do not install packages of the imported components"
1355
+ ]
1356
+ ],
1357
+ "description": "switch between component versions or remove local changes",
1358
+ "extendedDescription": "\n `bit checkout <version> [component-pattern]` => checkout the specified ids (or all components when --all is used) to the specified version\n `bit checkout head [component-pattern]` => checkout to the last snap/tag, omit [component-pattern] to checkout head for all\n `bit checkout reset [component-pattern]` => remove local modifications from the specified ids (or all components when --all is used)",
1359
+ "group": "development",
1360
+ "private": false,
1361
+ "arguments": [
1362
+ {
1363
+ "name": "to",
1364
+ "description": "permitted values: [head, reset, specific-version]. 'head' - last snap/tag. 'reset' - removes local changes"
1365
+ },
1366
+ {
1367
+ "name": "component-pattern",
1368
+ "description": "component name, component id, or component pattern. use component pattern to select multiple components.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
1369
+ }
1370
+ ]
1371
+ },
1372
1372
  {
1373
1373
  "name": "remove <component-pattern>",
1374
1374
  "alias": "rm",
@@ -2113,6 +2113,11 @@
2113
2113
  "no-squash",
2114
2114
  "EXPERIMENTAL. relevant for merging lanes into main, which by default squash."
2115
2115
  ],
2116
+ [
2117
+ "",
2118
+ "ignore-config-changes",
2119
+ "allow merging when component are modified due to config changes (such as dependencies) only and not files"
2120
+ ],
2116
2121
  [
2117
2122
  "",
2118
2123
  "verbose",
package/dist/cli-reference.mdx.js CHANGED
@@ -998,23 +998,17 @@ function MDXContent(_ref) {
998
998
  parentName: "p"
999
999
  }, "Description"), ": switch between component versions or remove local changes"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
1000
1000
  parentName: "p"
1001
- }, "bit checkout <version> [ids...]"), " => checkout the specified ids (or all components when --all is used) to the specified version", (0, _react2.mdx)("br", {
1001
+ }, "bit checkout <version> [component-pattern]"), " => checkout the specified ids (or all components when --all is used) to the specified version", (0, _react2.mdx)("br", {
1002
1002
  parentName: "p"
1003
1003
  }), "\n", "", (0, _react2.mdx)("inlineCode", {
1004
1004
  parentName: "p"
1005
- }, "bit checkout head"), " => checkout all components to their latest versions", (0, _react2.mdx)("br", {
1005
+ }, "bit checkout head [component-pattern]"), " => checkout to the last snap/tag, omit ", "[component-pattern]", " to checkout head for all", (0, _react2.mdx)("br", {
1006
1006
  parentName: "p"
1007
1007
  }), "\n", "", (0, _react2.mdx)("inlineCode", {
1008
1008
  parentName: "p"
1009
- }, "bit checkout head [ids...]"), " => checkout the specified ids to their latest versions", (0, _react2.mdx)("br", {
1009
+ }, "bit checkout reset [component-pattern]"), " => remove local modifications from the specified ids (or all components when --all is used)"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
1010
1010
  parentName: "p"
1011
- }), "\n", "", (0, _react2.mdx)("inlineCode", {
1012
- parentName: "p"
1013
- }, "bit checkout [ids...] --reset"), " => remove local modifications from the specified ids (or all components when --all is used)", (0, _react2.mdx)("br", {
1014
- parentName: "p"
1015
- }), "\n", "you can use a pattern for multiple ids, such as bit checkout 0.0.1 \"utils/", "*", "\". (wrap the pattern with quotes to avoid collision with shell commands)"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
1016
- parentName: "p"
1017
- }, "bit checkout [values...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
1011
+ }, "bit checkout <to> [component-pattern]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
1018
1012
  parentName: "table"
1019
1013
  }, (0, _react2.mdx)("tr", {
1020
1014
  parentName: "thead"
@@ -1147,65 +1141,39 @@ function MDXContent(_ref) {
1147
1141
  "align": null
1148
1142
  }, (0, _react2.mdx)("inlineCode", {
1149
1143
  parentName: "td"
1150
- }, "--skip-npm-install")), (0, _react2.mdx)("td", {
1151
- parentName: "tr",
1152
- "align": "center"
1153
- }), (0, _react2.mdx)("td", {
1154
- parentName: "tr",
1155
- "align": null
1156
- }, "DEPRECATED. use \"--skip-dependency-installation\" instead")), (0, _react2.mdx)("tr", {
1157
- parentName: "tbody"
1158
- }, (0, _react2.mdx)("td", {
1159
- parentName: "tr",
1160
- "align": null
1161
- }, (0, _react2.mdx)("inlineCode", {
1162
- parentName: "td"
1163
- }, "--skip-dependency-installation")), (0, _react2.mdx)("td", {
1164
- parentName: "tr",
1165
- "align": "center"
1166
- }), (0, _react2.mdx)("td", {
1167
- parentName: "tr",
1168
- "align": null
1169
- }, "do not install packages of the imported components")), (0, _react2.mdx)("tr", {
1170
- parentName: "tbody"
1171
- }, (0, _react2.mdx)("td", {
1172
- parentName: "tr",
1173
- "align": null
1174
- }, (0, _react2.mdx)("inlineCode", {
1175
- parentName: "td"
1176
- }, "--ignore-package-json")), (0, _react2.mdx)("td", {
1144
+ }, "--reset")), (0, _react2.mdx)("td", {
1177
1145
  parentName: "tr",
1178
1146
  "align": "center"
1179
1147
  }), (0, _react2.mdx)("td", {
1180
1148
  parentName: "tr",
1181
1149
  "align": null
1182
- }, "do not generate package.json for the imported component(s). (it automatically enables skip-npm-install and save-dependencies-as-components flags)")), (0, _react2.mdx)("tr", {
1150
+ }, "DEPRECATED. run \"bit checkout reset\" instead")), (0, _react2.mdx)("tr", {
1183
1151
  parentName: "tbody"
1184
1152
  }, (0, _react2.mdx)("td", {
1185
1153
  parentName: "tr",
1186
1154
  "align": null
1187
1155
  }, (0, _react2.mdx)("inlineCode", {
1188
1156
  parentName: "td"
1189
- }, "--conf [path]")), (0, _react2.mdx)("td", {
1157
+ }, "--skip-npm-install")), (0, _react2.mdx)("td", {
1190
1158
  parentName: "tr",
1191
1159
  "align": "center"
1192
1160
  }), (0, _react2.mdx)("td", {
1193
1161
  parentName: "tr",
1194
1162
  "align": null
1195
- }, "write the configuration file (bit.json) and the envs configuration files (use --conf without path to write to the default dir)")), (0, _react2.mdx)("tr", {
1163
+ }, "DEPRECATED. use \"--skip-dependency-installation\" instead")), (0, _react2.mdx)("tr", {
1196
1164
  parentName: "tbody"
1197
1165
  }, (0, _react2.mdx)("td", {
1198
1166
  parentName: "tr",
1199
1167
  "align": null
1200
1168
  }, (0, _react2.mdx)("inlineCode", {
1201
1169
  parentName: "td"
1202
- }, "--ignore-dist")), (0, _react2.mdx)("td", {
1170
+ }, "--skip-dependency-installation")), (0, _react2.mdx)("td", {
1203
1171
  parentName: "tr",
1204
1172
  "align": "center"
1205
1173
  }), (0, _react2.mdx)("td", {
1206
1174
  parentName: "tr",
1207
1175
  "align": null
1208
- }, "do not write dist files (when exist)")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "clear-cache"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
1176
+ }, "do not install packages of the imported components")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "clear-cache"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
1209
1177
  parentName: "p"
1210
1178
  }, "Alias"), ": ", (0, _react2.mdx)("inlineCode", {
1211
1179
  parentName: "p"