@teambit/harmony.content.cli-reference 2.0.105 → 2.0.107

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.5.29'
2
+ description: 'Bit command synopses. Bit version: 1.5.30'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
5
5
 
@@ -2329,11 +2329,6 @@
2329
2329
  "update-main",
2330
2330
  "EXPERIMENTAL. delete component/s on the main lane after merging this lane into main"
2331
2331
  ],
2332
- [
2333
- "f",
2334
- "force",
2335
- "removes the component from the scope, even if used as a dependency. WARNING: components that depend on this component will corrupt"
2336
- ],
2337
2332
  [
2338
2333
  "s",
2339
2334
  "silent",
@@ -2343,6 +2338,11 @@
2343
2338
  "",
2344
2339
  "hard",
2345
2340
  "NOT-RECOMMENDED. delete a component completely from a remote scope. careful! this is a permanent change that could corrupt dependents."
2341
+ ],
2342
+ [
2343
+ "f",
2344
+ "force",
2345
+ "relevant for --hard. allow the deletion even if used as a dependency. WARNING: components that depend on this component will corrupt"
2346
2346
  ]
2347
2347
  ],
2348
2348
  "description": "mark components as deleted on the remote",
@@ -2981,7 +2981,7 @@
2981
2981
  ]
2982
2982
  ],
2983
2983
  "description": "switch between component versions or remove local changes",
2984
- "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 (use --latest if you only want semver tags), omit [component-pattern] to checkout head for all\n `bit checkout latest [component-pattern]` => checkout to the latest satisfying semver tag, omit [component-pattern] to checkout latest for all\n `bit checkout reset [component-pattern]` => remove local modifications from the specified ids (or all components when --all is used)",
2984
+ "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 (use --latest if you only want semver tags), omit [component-pattern] to checkout head for all\n`bit checkout latest [component-pattern]` => checkout to the latest satisfying semver tag, omit [component-pattern] to checkout latest for all\n`bit checkout reset [component-pattern]` => remove local modifications from the specified ids (or all components when --all is used)\nwhen on a lane, \"checkout head\" only checks out components on this lane. to update main components, run \"bit lane merge main\"",
2985
2985
  "group": "development",
2986
2986
  "private": false,
2987
2987
  "arguments": [
@@ -3735,7 +3735,12 @@
3735
3735
  [
3736
3736
  "",
3737
3737
  "include-non-lane-comps",
3738
- "when merging main, include workspace components that are not on the lane (by default only lane components are merged)"
3738
+ "DEPRECATED (this is now the default). when merging main, include workspace components that are not on the lane (by default only lane components are merged)"
3739
+ ],
3740
+ [
3741
+ "",
3742
+ "exclude-non-lane-comps",
3743
+ "when merging main into a lane, exclude workspace components that are not on the lane (by default all workspace components are merged)"
3739
3744
  ]
3740
3745
  ],
3741
3746
  "description": "merge a local or a remote lane to the current lane",
@@ -4021,6 +4026,11 @@
4021
4026
  "dev",
4022
4027
  "add to the devDependencies"
4023
4028
  ],
4029
+ [
4030
+ "o",
4031
+ "optional",
4032
+ "add to the optionalDependencies"
4033
+ ],
4024
4034
  [
4025
4035
  "p",
4026
4036
  "peer",
package/cli-reference.mdx CHANGED
@@ -278,9 +278,10 @@ with no args, only workspace's capsules are deleted
278
278
  **Description**: switch between component versions or remove local changes
279
279
 
280
280
  `bit checkout <version> [component-pattern]` => checkout the specified ids (or all components when --all is used) to the specified version
281
- `bit checkout head [component-pattern]` => checkout to the last snap/tag (use --latest if you only want semver tags), omit [component-pattern] to checkout head for all
282
- `bit checkout latest [component-pattern]` => checkout to the latest satisfying semver tag, omit [component-pattern] to checkout latest for all
283
- `bit checkout reset [component-pattern]` => remove local modifications from the specified ids (or all components when --all is used)
281
+ `bit checkout head [component-pattern]` => checkout to the last snap/tag (use --latest if you only want semver tags), omit [component-pattern] to checkout head for all
282
+ `bit checkout latest [component-pattern]` => checkout to the latest satisfying semver tag, omit [component-pattern] to checkout latest for all
283
+ `bit checkout reset [component-pattern]` => remove local modifications from the specified ids (or all components when --all is used)
284
+ when on a lane, "checkout head" only checks out components on this lane. to update main components, run "bit lane merge main"
284
285
 
285
286
  `bit checkout <to> [component-pattern]`
286
287
 
@@ -442,9 +443,9 @@ this command marks the components as deleted, and after snap/tag and export they
442
443
  | --------------- | :--------------: | -------------------------------------------------------------------------------------------------------------------------------------- |
443
444
  | `--lane` | | when on a lane, delete the component from this lane only. avoid merging it to main or other lanes |
444
445
  | `--update-main` | | EXPERIMENTAL. delete component/s on the main lane after merging this lane into main |
445
- | `--force` | `-f` | removes the component from the scope, even if used as a dependency. WARNING: components that depend on this component will corrupt |
446
446
  | `--silent` | `-s` | skip confirmation |
447
447
  | `--hard` | | NOT-RECOMMENDED. delete a component completely from a remote scope. careful! this is a permanent change that could corrupt dependents. |
448
+ | `--force` | `-f` | relevant for --hard. allow the deletion even if used as a dependency. WARNING: components that depend on this component will corrupt |
448
449
 
449
450
  ---
450
451
 
@@ -547,10 +548,11 @@ this command marks the components as deleted, and after snap/tag and export they
547
548
  | `component-pattern` | component name, component id, or component pattern. use component pattern to select multiple components. wrap the pattern with quotes. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button". use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
548
549
  | `package...` | package name with or without a version, e.g. "lodash@1.0.0" or just "lodash" which will be resolved to the latest |
549
550
 
550
- | **Option** | **Option alias** | **Description** |
551
- | ---------- | :--------------: | --------------------------- |
552
- | `--dev` | `-d` | add to the devDependencies |
553
- | `--peer` | `-p` | add to the peerDependencies |
551
+ | **Option** | **Option alias** | **Description** |
552
+ | ------------ | :--------------: | ------------------------------- |
553
+ | `--dev` | `-d` | add to the devDependencies |
554
+ | `--optional` | `-o` | add to the optionalDependencies |
555
+ | `--peer` | `-p` | add to the peerDependencies |
554
556
 
555
557
  ### deps reset
556
558
 
@@ -1176,27 +1178,28 @@ this flag keeps the history of one end and saves a reference to the other end. t
1176
1178
  | `lane` | lane-name or full lane-id (if remote) to merge to the current lane |
1177
1179
  | `pattern` | partially merge the lane - only components that match the specified component-pattern Component pattern format: component name, component id, or component pattern. use component pattern to select multiple components. wrap the pattern with quotes. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button". use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
1178
1180
 
1179
- | **Option** | **Option alias** | **Description** |
1180
- | --------------------------------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------------------- |
1181
- | `--ours` | | DEPRECATED. use --auto-merge-resolve. in case of a conflict, keep local modifications |
1182
- | `--theirs` | | DEPRECATED. use --auto-merge-resolve. in case of a conflict, override local with incoming changes |
1183
- | `--manual` | | DEPRECATED. use --auto-merge-resolve |
1184
- | `--auto-merge-resolve <merge-strategy>` | | in case of a merge conflict, resolve according to the provided strategy: [ours, theirs, manual] |
1185
- | `--workspace` | | merge only lane components that are in the current workspace |
1186
- | `--no-snap` | | do not auto snap after merge completed without conflicts |
1187
- | `--tag` | | auto-tag all lane components after merging into main (or tag-merge in case of snap-merge) |
1188
- | `--build` | | in case of snap during the merge, run the build-pipeline (similar to bit snap --build) |
1189
- | `--message <message>` | `-m` | override the default message for the auto snap |
1190
- | `--keep-readme` | | skip deleting the lane readme component after merging |
1191
- | `--no-squash` | | relevant for merging lanes into main, which by default squashes all lane snaps |
1192
- | `--squash` | | EXPERIMENTAL. relevant for merging a lane into another non-main lane, which by default does not squash |
1193
- | `--ignore-config-changes` | | allow merging when components are modified due to config changes (such as dependencies) only and not files |
1194
- | `--verbose` | | show details of components that were not merged successfully |
1195
- | `--skip-dependency-installation` | `-x` | do not install dependencies of the imported components |
1196
- | `--skip-fetch` | | use the local state of target-lane if exits locally, without updating it from the remote |
1197
- | `--include-deps` | | relevant for "--pattern" and "--workspace". merge also dependencies of the specified components |
1198
- | `--resolve-unrelated [merge-strategy]` | | relevant when a component on a lane and the component on main have nothing in common. merge-strategy can be "ours" (default) or "theirs" |
1199
- | `--include-non-lane-comps` | | when merging main, include workspace components that are not on the lane (by default only lane components are merged) |
1181
+ | **Option** | **Option alias** | **Description** |
1182
+ | --------------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
1183
+ | `--ours` | | DEPRECATED. use --auto-merge-resolve. in case of a conflict, keep local modifications |
1184
+ | `--theirs` | | DEPRECATED. use --auto-merge-resolve. in case of a conflict, override local with incoming changes |
1185
+ | `--manual` | | DEPRECATED. use --auto-merge-resolve |
1186
+ | `--auto-merge-resolve <merge-strategy>` | | in case of a merge conflict, resolve according to the provided strategy: [ours, theirs, manual] |
1187
+ | `--workspace` | | merge only lane components that are in the current workspace |
1188
+ | `--no-snap` | | do not auto snap after merge completed without conflicts |
1189
+ | `--tag` | | auto-tag all lane components after merging into main (or tag-merge in case of snap-merge) |
1190
+ | `--build` | | in case of snap during the merge, run the build-pipeline (similar to bit snap --build) |
1191
+ | `--message <message>` | `-m` | override the default message for the auto snap |
1192
+ | `--keep-readme` | | skip deleting the lane readme component after merging |
1193
+ | `--no-squash` | | relevant for merging lanes into main, which by default squashes all lane snaps |
1194
+ | `--squash` | | EXPERIMENTAL. relevant for merging a lane into another non-main lane, which by default does not squash |
1195
+ | `--ignore-config-changes` | | allow merging when components are modified due to config changes (such as dependencies) only and not files |
1196
+ | `--verbose` | | show details of components that were not merged successfully |
1197
+ | `--skip-dependency-installation` | `-x` | do not install dependencies of the imported components |
1198
+ | `--skip-fetch` | | use the local state of target-lane if exits locally, without updating it from the remote |
1199
+ | `--include-deps` | | relevant for "--pattern" and "--workspace". merge also dependencies of the specified components |
1200
+ | `--resolve-unrelated [merge-strategy]` | | relevant when a component on a lane and the component on main have nothing in common. merge-strategy can be "ours" (default) or "theirs" |
1201
+ | `--include-non-lane-comps` | | DEPRECATED (this is now the default). when merging main, include workspace components that are not on the lane (by default only lane components are merged) |
1202
+ | `--exclude-non-lane-comps` | | when merging main into a lane, exclude workspace components that are not on the lane (by default all workspace components are merged) |
1200
1203
 
1201
1204
  ### lane merge-abort
1202
1205
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.5.29'
2
+ description: 'Bit command synopses. Bit version: 1.5.30'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
5
5
 
@@ -2329,11 +2329,6 @@
2329
2329
  "update-main",
2330
2330
  "EXPERIMENTAL. delete component/s on the main lane after merging this lane into main"
2331
2331
  ],
2332
- [
2333
- "f",
2334
- "force",
2335
- "removes the component from the scope, even if used as a dependency. WARNING: components that depend on this component will corrupt"
2336
- ],
2337
2332
  [
2338
2333
  "s",
2339
2334
  "silent",
@@ -2343,6 +2338,11 @@
2343
2338
  "",
2344
2339
  "hard",
2345
2340
  "NOT-RECOMMENDED. delete a component completely from a remote scope. careful! this is a permanent change that could corrupt dependents."
2341
+ ],
2342
+ [
2343
+ "f",
2344
+ "force",
2345
+ "relevant for --hard. allow the deletion even if used as a dependency. WARNING: components that depend on this component will corrupt"
2346
2346
  ]
2347
2347
  ],
2348
2348
  "description": "mark components as deleted on the remote",
@@ -2981,7 +2981,7 @@
2981
2981
  ]
2982
2982
  ],
2983
2983
  "description": "switch between component versions or remove local changes",
2984
- "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 (use --latest if you only want semver tags), omit [component-pattern] to checkout head for all\n `bit checkout latest [component-pattern]` => checkout to the latest satisfying semver tag, omit [component-pattern] to checkout latest for all\n `bit checkout reset [component-pattern]` => remove local modifications from the specified ids (or all components when --all is used)",
2984
+ "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 (use --latest if you only want semver tags), omit [component-pattern] to checkout head for all\n`bit checkout latest [component-pattern]` => checkout to the latest satisfying semver tag, omit [component-pattern] to checkout latest for all\n`bit checkout reset [component-pattern]` => remove local modifications from the specified ids (or all components when --all is used)\nwhen on a lane, \"checkout head\" only checks out components on this lane. to update main components, run \"bit lane merge main\"",
2985
2985
  "group": "development",
2986
2986
  "private": false,
2987
2987
  "arguments": [
@@ -3735,7 +3735,12 @@
3735
3735
  [
3736
3736
  "",
3737
3737
  "include-non-lane-comps",
3738
- "when merging main, include workspace components that are not on the lane (by default only lane components are merged)"
3738
+ "DEPRECATED (this is now the default). when merging main, include workspace components that are not on the lane (by default only lane components are merged)"
3739
+ ],
3740
+ [
3741
+ "",
3742
+ "exclude-non-lane-comps",
3743
+ "when merging main into a lane, exclude workspace components that are not on the lane (by default all workspace components are merged)"
3739
3744
  ]
3740
3745
  ],
3741
3746
  "description": "merge a local or a remote lane to the current lane",
@@ -4021,6 +4026,11 @@
4021
4026
  "dev",
4022
4027
  "add to the devDependencies"
4023
4028
  ],
4029
+ [
4030
+ "o",
4031
+ "optional",
4032
+ "add to the optionalDependencies"
4033
+ ],
4024
4034
  [
4025
4035
  "p",
4026
4036
  "peer",
@@ -1414,17 +1414,19 @@ function MDXContent(_ref) {
1414
1414
  parentName: "p"
1415
1415
  }, "bit checkout <version> [component-pattern]"), " => checkout the specified ids (or all components when --all is used) to the specified version", (0, _react2.mdx)("br", {
1416
1416
  parentName: "p"
1417
- }), "\n", "", (0, _react2.mdx)("inlineCode", {
1417
+ }), "\n", (0, _react2.mdx)("inlineCode", {
1418
1418
  parentName: "p"
1419
1419
  }, "bit checkout head [component-pattern]"), " => checkout to the last snap/tag (use --latest if you only want semver tags), omit ", "[component-pattern]", " to checkout head for all", (0, _react2.mdx)("br", {
1420
1420
  parentName: "p"
1421
- }), "\n", "", (0, _react2.mdx)("inlineCode", {
1421
+ }), "\n", (0, _react2.mdx)("inlineCode", {
1422
1422
  parentName: "p"
1423
1423
  }, "bit checkout latest [component-pattern]"), " => checkout to the latest satisfying semver tag, omit ", "[component-pattern]", " to checkout latest for all", (0, _react2.mdx)("br", {
1424
1424
  parentName: "p"
1425
- }), "\n", "", (0, _react2.mdx)("inlineCode", {
1425
+ }), "\n", (0, _react2.mdx)("inlineCode", {
1426
1426
  parentName: "p"
1427
- }, "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", {
1427
+ }, "bit checkout reset [component-pattern]"), " => remove local modifications from the specified ids (or all components when --all is used)", (0, _react2.mdx)("br", {
1428
+ parentName: "p"
1429
+ }), "\n", "when on a lane, \"checkout head\" only checks out components on this lane. to update main components, run \"bit lane merge main\""), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
1428
1430
  parentName: "p"
1429
1431
  }, "bit checkout <to> [component-pattern]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
1430
1432
  parentName: "table"
@@ -2154,43 +2156,43 @@ function MDXContent(_ref) {
2154
2156
  "align": null
2155
2157
  }, (0, _react2.mdx)("inlineCode", {
2156
2158
  parentName: "td"
2157
- }, "--force")), (0, _react2.mdx)("td", {
2159
+ }, "--silent")), (0, _react2.mdx)("td", {
2158
2160
  parentName: "tr",
2159
2161
  "align": "center"
2160
2162
  }, (0, _react2.mdx)("inlineCode", {
2161
2163
  parentName: "td"
2162
- }, "-f")), (0, _react2.mdx)("td", {
2164
+ }, "-s")), (0, _react2.mdx)("td", {
2163
2165
  parentName: "tr",
2164
2166
  "align": null
2165
- }, "removes the component from the scope, even if used as a dependency. WARNING: components that depend on this component will corrupt")), (0, _react2.mdx)("tr", {
2167
+ }, "skip confirmation")), (0, _react2.mdx)("tr", {
2166
2168
  parentName: "tbody"
2167
2169
  }, (0, _react2.mdx)("td", {
2168
2170
  parentName: "tr",
2169
2171
  "align": null
2170
2172
  }, (0, _react2.mdx)("inlineCode", {
2171
2173
  parentName: "td"
2172
- }, "--silent")), (0, _react2.mdx)("td", {
2174
+ }, "--hard")), (0, _react2.mdx)("td", {
2173
2175
  parentName: "tr",
2174
2176
  "align": "center"
2175
- }, (0, _react2.mdx)("inlineCode", {
2176
- parentName: "td"
2177
- }, "-s")), (0, _react2.mdx)("td", {
2177
+ }), (0, _react2.mdx)("td", {
2178
2178
  parentName: "tr",
2179
2179
  "align": null
2180
- }, "skip confirmation")), (0, _react2.mdx)("tr", {
2180
+ }, "NOT-RECOMMENDED. delete a component completely from a remote scope. careful! this is a permanent change that could corrupt dependents.")), (0, _react2.mdx)("tr", {
2181
2181
  parentName: "tbody"
2182
2182
  }, (0, _react2.mdx)("td", {
2183
2183
  parentName: "tr",
2184
2184
  "align": null
2185
2185
  }, (0, _react2.mdx)("inlineCode", {
2186
2186
  parentName: "td"
2187
- }, "--hard")), (0, _react2.mdx)("td", {
2187
+ }, "--force")), (0, _react2.mdx)("td", {
2188
2188
  parentName: "tr",
2189
2189
  "align": "center"
2190
- }), (0, _react2.mdx)("td", {
2190
+ }, (0, _react2.mdx)("inlineCode", {
2191
+ parentName: "td"
2192
+ }, "-f")), (0, _react2.mdx)("td", {
2191
2193
  parentName: "tr",
2192
2194
  "align": null
2193
- }, "NOT-RECOMMENDED. delete a component completely from a remote scope. careful! this is a permanent change that could corrupt dependents.")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "dependents"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2195
+ }, "relevant for --hard. allow the deletion even if used as a dependency. WARNING: components that depend on this component will corrupt")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "dependents"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2194
2196
  parentName: "p"
2195
2197
  }, "Description"), ": show dependents of the given component"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
2196
2198
  parentName: "p"
@@ -2666,6 +2668,21 @@ function MDXContent(_ref) {
2666
2668
  "align": null
2667
2669
  }, (0, _react2.mdx)("inlineCode", {
2668
2670
  parentName: "td"
2671
+ }, "--optional")), (0, _react2.mdx)("td", {
2672
+ parentName: "tr",
2673
+ "align": "center"
2674
+ }, (0, _react2.mdx)("inlineCode", {
2675
+ parentName: "td"
2676
+ }, "-o")), (0, _react2.mdx)("td", {
2677
+ parentName: "tr",
2678
+ "align": null
2679
+ }, "add to the optionalDependencies")), (0, _react2.mdx)("tr", {
2680
+ parentName: "tbody"
2681
+ }, (0, _react2.mdx)("td", {
2682
+ parentName: "tr",
2683
+ "align": null
2684
+ }, (0, _react2.mdx)("inlineCode", {
2685
+ parentName: "td"
2669
2686
  }, "--peer")), (0, _react2.mdx)("td", {
2670
2687
  parentName: "tr",
2671
2688
  "align": "center"
@@ -6138,7 +6155,20 @@ function MDXContent(_ref) {
6138
6155
  }), (0, _react2.mdx)("td", {
6139
6156
  parentName: "tr",
6140
6157
  "align": null
6141
- }, "when merging main, include workspace components that are not on the lane (by default only lane components are merged)")))), (0, _react2.mdx)("h3", null, "lane merge-abort"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
6158
+ }, "DEPRECATED (this is now the default). when merging main, include workspace components that are not on the lane (by default only lane components are merged)")), (0, _react2.mdx)("tr", {
6159
+ parentName: "tbody"
6160
+ }, (0, _react2.mdx)("td", {
6161
+ parentName: "tr",
6162
+ "align": null
6163
+ }, (0, _react2.mdx)("inlineCode", {
6164
+ parentName: "td"
6165
+ }, "--exclude-non-lane-comps")), (0, _react2.mdx)("td", {
6166
+ parentName: "tr",
6167
+ "align": "center"
6168
+ }), (0, _react2.mdx)("td", {
6169
+ parentName: "tr",
6170
+ "align": null
6171
+ }, "when merging main into a lane, exclude workspace components that are not on the lane (by default all workspace components are merged)")))), (0, _react2.mdx)("h3", null, "lane merge-abort"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
6142
6172
  parentName: "p"
6143
6173
  }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
6144
6174
  parentName: "p"