@teambit/harmony.content.cli-reference 1.95.84 → 1.95.86
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.
- package/cli-reference.json +16 -5
- package/cli-reference.mdx +8 -4
- package/dist/cli-reference.json +16 -5
- package/dist/cli-reference.mdx.js +58 -13
- package/dist/cli-reference.mdx.js.map +1 -1
- package/package-tar/teambit-harmony.content.cli-reference-1.95.86.tgz +0 -0
- package/package.json +3 -3
- package/{preview-1667014802517.js → preview-1667360527523.js} +2 -2
- package/package-tar/teambit-harmony.content.cli-reference-1.95.84.tgz +0 -0
package/cli-reference.json
CHANGED
|
@@ -436,7 +436,7 @@
|
|
|
436
436
|
]
|
|
437
437
|
],
|
|
438
438
|
"description": "Add any subset of files to be tracked as a component(s).",
|
|
439
|
-
"extendedDescription": "
|
|
439
|
+
"extendedDescription": "Learn the recommended workflow for tracking directories as components, in the link below.",
|
|
440
440
|
"group": "development",
|
|
441
441
|
"private": false
|
|
442
442
|
},
|
|
@@ -1215,13 +1215,13 @@
|
|
|
1215
1215
|
]
|
|
1216
1216
|
],
|
|
1217
1217
|
"description": "switch between component versions or remove local changes",
|
|
1218
|
-
"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)",
|
|
1218
|
+
"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 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)",
|
|
1219
1219
|
"group": "development",
|
|
1220
1220
|
"private": false,
|
|
1221
1221
|
"arguments": [
|
|
1222
1222
|
{
|
|
1223
1223
|
"name": "to",
|
|
1224
|
-
"description": "permitted values: [head, reset, specific-version]. 'head' - last snap/tag. 'reset' - removes local changes"
|
|
1224
|
+
"description": "permitted values: [head, latest, reset, specific-version]. 'head' - last snap/tag. 'latest' - semver latest tag. 'reset' - removes local changes"
|
|
1225
1225
|
},
|
|
1226
1226
|
{
|
|
1227
1227
|
"name": "component-pattern",
|
|
@@ -2777,7 +2777,18 @@
|
|
|
2777
2777
|
{
|
|
2778
2778
|
"name": "remove <component-pattern> <package...>",
|
|
2779
2779
|
"alias": "",
|
|
2780
|
-
"options": [
|
|
2780
|
+
"options": [
|
|
2781
|
+
[
|
|
2782
|
+
"d",
|
|
2783
|
+
"dev",
|
|
2784
|
+
"remove from devDependencies"
|
|
2785
|
+
],
|
|
2786
|
+
[
|
|
2787
|
+
"p",
|
|
2788
|
+
"peer",
|
|
2789
|
+
"remove from peerDependencies"
|
|
2790
|
+
]
|
|
2791
|
+
],
|
|
2781
2792
|
"description": "remove a dependency to component(s)",
|
|
2782
2793
|
"extendedDescription": "",
|
|
2783
2794
|
"group": "info",
|
|
@@ -3379,7 +3390,7 @@
|
|
|
3379
3390
|
]
|
|
3380
3391
|
],
|
|
3381
3392
|
"description": "clears Bit's cache from current working machine",
|
|
3382
|
-
"extendedDescription": "The following gets removed by this command:\n1) V8 compiled code (generated the first time Bit is loaded by v8-compile-cache package)\n2) components cache on the filesystem (mainly the dependencies graph and docs)\n3) scope's index file, which maps the component-id:object-hash
|
|
3393
|
+
"extendedDescription": "The following gets removed by this command:\n1) V8 compiled code (generated the first time Bit is loaded by v8-compile-cache package)\n2) components cache on the filesystem (mainly the dependencies graph and docs)\n3) scope's index file, which maps the component-id:object-hash",
|
|
3383
3394
|
"group": "general",
|
|
3384
3395
|
"private": false,
|
|
3385
3396
|
"skipWorkspace": true
|
package/cli-reference.mdx
CHANGED
|
@@ -7,8 +7,7 @@ Commands that are marked as workspace only must be executed inside a workspace.
|
|
|
7
7
|
**Alias**: `a`
|
|
8
8
|
**Workspace only**: yes
|
|
9
9
|
**Description**: Add any subset of files to be tracked as a component(s).
|
|
10
|
-
|
|
11
|
-
https://bit.dev/docs/components/adding-components
|
|
10
|
+
Learn the recommended workflow for tracking directories as components, in the link below.
|
|
12
11
|
|
|
13
12
|
`bit add [path...]`
|
|
14
13
|
|
|
@@ -221,6 +220,7 @@ with no args, only workspace's capsules are deleted
|
|
|
221
220
|
|
|
222
221
|
`bit checkout <version> [component-pattern]` => checkout the specified ids (or all components when --all is used) to the specified version
|
|
223
222
|
`bit checkout head [component-pattern]` => checkout to the last snap/tag, omit [component-pattern] to checkout head for all
|
|
223
|
+
`bit checkout latest [component-pattern]` => checkout to the latest satisfying semver tag, omit [component-pattern] to checkout latest for all
|
|
224
224
|
`bit checkout reset [component-pattern]` => remove local modifications from the specified ids (or all components when --all is used)
|
|
225
225
|
|
|
226
226
|
`bit checkout <to> [component-pattern]`
|
|
@@ -249,8 +249,7 @@ The following gets removed by this command:
|
|
|
249
249
|
|
|
250
250
|
1. V8 compiled code (generated the first time Bit is loaded by v8-compile-cache package)
|
|
251
251
|
2. components cache on the filesystem (mainly the dependencies graph and docs)
|
|
252
|
-
3. scope's index file, which maps the component-id:object-hash
|
|
253
|
-
https://bit.dev/docs/workspace/clearing-cache
|
|
252
|
+
3. scope's index file, which maps the component-id:object-hash
|
|
254
253
|
|
|
255
254
|
`bit clear-cache`
|
|
256
255
|
|
|
@@ -416,6 +415,11 @@ https://bit.dev/docs/config/bit-config
|
|
|
416
415
|
|
|
417
416
|
**Description**: remove a dependency to component(s)
|
|
418
417
|
|
|
418
|
+
| **Option** | **Option alias** | **Description** |
|
|
419
|
+
| ---------- | :--------------: | ---------------------------- |
|
|
420
|
+
| `--dev` | `-d` | remove from devDependencies |
|
|
421
|
+
| `--peer` | `-p` | remove from peerDependencies |
|
|
422
|
+
|
|
419
423
|
### deps debug
|
|
420
424
|
|
|
421
425
|
**Usage**: `deps debug <component-name>`
|
package/dist/cli-reference.json
CHANGED
|
@@ -436,7 +436,7 @@
|
|
|
436
436
|
]
|
|
437
437
|
],
|
|
438
438
|
"description": "Add any subset of files to be tracked as a component(s).",
|
|
439
|
-
"extendedDescription": "
|
|
439
|
+
"extendedDescription": "Learn the recommended workflow for tracking directories as components, in the link below.",
|
|
440
440
|
"group": "development",
|
|
441
441
|
"private": false
|
|
442
442
|
},
|
|
@@ -1215,13 +1215,13 @@
|
|
|
1215
1215
|
]
|
|
1216
1216
|
],
|
|
1217
1217
|
"description": "switch between component versions or remove local changes",
|
|
1218
|
-
"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)",
|
|
1218
|
+
"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 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)",
|
|
1219
1219
|
"group": "development",
|
|
1220
1220
|
"private": false,
|
|
1221
1221
|
"arguments": [
|
|
1222
1222
|
{
|
|
1223
1223
|
"name": "to",
|
|
1224
|
-
"description": "permitted values: [head, reset, specific-version]. 'head' - last snap/tag. 'reset' - removes local changes"
|
|
1224
|
+
"description": "permitted values: [head, latest, reset, specific-version]. 'head' - last snap/tag. 'latest' - semver latest tag. 'reset' - removes local changes"
|
|
1225
1225
|
},
|
|
1226
1226
|
{
|
|
1227
1227
|
"name": "component-pattern",
|
|
@@ -2777,7 +2777,18 @@
|
|
|
2777
2777
|
{
|
|
2778
2778
|
"name": "remove <component-pattern> <package...>",
|
|
2779
2779
|
"alias": "",
|
|
2780
|
-
"options": [
|
|
2780
|
+
"options": [
|
|
2781
|
+
[
|
|
2782
|
+
"d",
|
|
2783
|
+
"dev",
|
|
2784
|
+
"remove from devDependencies"
|
|
2785
|
+
],
|
|
2786
|
+
[
|
|
2787
|
+
"p",
|
|
2788
|
+
"peer",
|
|
2789
|
+
"remove from peerDependencies"
|
|
2790
|
+
]
|
|
2791
|
+
],
|
|
2781
2792
|
"description": "remove a dependency to component(s)",
|
|
2782
2793
|
"extendedDescription": "",
|
|
2783
2794
|
"group": "info",
|
|
@@ -3379,7 +3390,7 @@
|
|
|
3379
3390
|
]
|
|
3380
3391
|
],
|
|
3381
3392
|
"description": "clears Bit's cache from current working machine",
|
|
3382
|
-
"extendedDescription": "The following gets removed by this command:\n1) V8 compiled code (generated the first time Bit is loaded by v8-compile-cache package)\n2) components cache on the filesystem (mainly the dependencies graph and docs)\n3) scope's index file, which maps the component-id:object-hash
|
|
3393
|
+
"extendedDescription": "The following gets removed by this command:\n1) V8 compiled code (generated the first time Bit is loaded by v8-compile-cache package)\n2) components cache on the filesystem (mainly the dependencies graph and docs)\n3) scope's index file, which maps the component-id:object-hash",
|
|
3383
3394
|
"group": "general",
|
|
3384
3395
|
"private": false,
|
|
3385
3396
|
"skipWorkspace": true
|
|
@@ -36,12 +36,7 @@ function MDXContent(_ref) {
|
|
|
36
36
|
parentName: "p"
|
|
37
37
|
}, "Description"), ": Add any subset of files to be tracked as a component(s).", (0, _react2.mdx)("br", {
|
|
38
38
|
parentName: "p"
|
|
39
|
-
}), "\n", "
|
|
40
|
-
parentName: "p"
|
|
41
|
-
}), "\n", "", (0, _react2.mdx)("a", {
|
|
42
|
-
parentName: "p",
|
|
43
|
-
"href": "https://bit.dev/docs/components/adding-components"
|
|
44
|
-
}, "https://bit.dev/docs/components/adding-components")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
39
|
+
}), "\n", "Learn the recommended workflow for tracking directories as components, in the link below."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
45
40
|
parentName: "p"
|
|
46
41
|
}, "bit add [path...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
47
42
|
parentName: "table"
|
|
@@ -1024,6 +1019,10 @@ function MDXContent(_ref) {
|
|
|
1024
1019
|
parentName: "p"
|
|
1025
1020
|
}), "\n", "", (0, _react2.mdx)("inlineCode", {
|
|
1026
1021
|
parentName: "p"
|
|
1022
|
+
}, "bit checkout latest [component-pattern]"), " => checkout to the latest satisfying semver tag, omit ", "[component-pattern]", " to checkout latest for all", (0, _react2.mdx)("br", {
|
|
1023
|
+
parentName: "p"
|
|
1024
|
+
}), "\n", "", (0, _react2.mdx)("inlineCode", {
|
|
1025
|
+
parentName: "p"
|
|
1027
1026
|
}, "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", {
|
|
1028
1027
|
parentName: "p"
|
|
1029
1028
|
}, "bit checkout <to> [component-pattern]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
@@ -1211,12 +1210,7 @@ function MDXContent(_ref) {
|
|
|
1211
1210
|
parentName: "ol"
|
|
1212
1211
|
}, "components cache on the filesystem (mainly the dependencies graph and docs)"), (0, _react2.mdx)("li", {
|
|
1213
1212
|
parentName: "ol"
|
|
1214
|
-
}, "scope's index file, which maps the component-id:object-hash", (0, _react2.mdx)("
|
|
1215
|
-
parentName: "li"
|
|
1216
|
-
}), (0, _react2.mdx)("a", {
|
|
1217
|
-
parentName: "li",
|
|
1218
|
-
"href": "https://bit.dev/docs/workspace/clearing-cache"
|
|
1219
|
-
}, "https://bit.dev/docs/workspace/clearing-cache"))), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
1213
|
+
}, "scope's index file, which maps the component-id:object-hash")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
|
|
1220
1214
|
parentName: "p"
|
|
1221
1215
|
}, "bit clear-cache")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
1222
1216
|
parentName: "table"
|
|
@@ -1719,7 +1713,58 @@ function MDXContent(_ref) {
|
|
|
1719
1713
|
parentName: "p"
|
|
1720
1714
|
}, "deps remove <component-pattern> <package...>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
1721
1715
|
parentName: "p"
|
|
1722
|
-
}, "Description"), ": remove a dependency to component(s)"), (0, _react2.mdx)("
|
|
1716
|
+
}, "Description"), ": remove a dependency to component(s)"), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
|
|
1717
|
+
parentName: "table"
|
|
1718
|
+
}, (0, _react2.mdx)("tr", {
|
|
1719
|
+
parentName: "thead"
|
|
1720
|
+
}, (0, _react2.mdx)("th", {
|
|
1721
|
+
parentName: "tr",
|
|
1722
|
+
"align": null
|
|
1723
|
+
}, (0, _react2.mdx)("strong", {
|
|
1724
|
+
parentName: "th"
|
|
1725
|
+
}, "Option")), (0, _react2.mdx)("th", {
|
|
1726
|
+
parentName: "tr",
|
|
1727
|
+
"align": "center"
|
|
1728
|
+
}, (0, _react2.mdx)("strong", {
|
|
1729
|
+
parentName: "th"
|
|
1730
|
+
}, "Option alias")), (0, _react2.mdx)("th", {
|
|
1731
|
+
parentName: "tr",
|
|
1732
|
+
"align": null
|
|
1733
|
+
}, (0, _react2.mdx)("strong", {
|
|
1734
|
+
parentName: "th"
|
|
1735
|
+
}, "Description")))), (0, _react2.mdx)("tbody", {
|
|
1736
|
+
parentName: "table"
|
|
1737
|
+
}, (0, _react2.mdx)("tr", {
|
|
1738
|
+
parentName: "tbody"
|
|
1739
|
+
}, (0, _react2.mdx)("td", {
|
|
1740
|
+
parentName: "tr",
|
|
1741
|
+
"align": null
|
|
1742
|
+
}, (0, _react2.mdx)("inlineCode", {
|
|
1743
|
+
parentName: "td"
|
|
1744
|
+
}, "--dev")), (0, _react2.mdx)("td", {
|
|
1745
|
+
parentName: "tr",
|
|
1746
|
+
"align": "center"
|
|
1747
|
+
}, (0, _react2.mdx)("inlineCode", {
|
|
1748
|
+
parentName: "td"
|
|
1749
|
+
}, "-d")), (0, _react2.mdx)("td", {
|
|
1750
|
+
parentName: "tr",
|
|
1751
|
+
"align": null
|
|
1752
|
+
}, "remove from devDependencies")), (0, _react2.mdx)("tr", {
|
|
1753
|
+
parentName: "tbody"
|
|
1754
|
+
}, (0, _react2.mdx)("td", {
|
|
1755
|
+
parentName: "tr",
|
|
1756
|
+
"align": null
|
|
1757
|
+
}, (0, _react2.mdx)("inlineCode", {
|
|
1758
|
+
parentName: "td"
|
|
1759
|
+
}, "--peer")), (0, _react2.mdx)("td", {
|
|
1760
|
+
parentName: "tr",
|
|
1761
|
+
"align": "center"
|
|
1762
|
+
}, (0, _react2.mdx)("inlineCode", {
|
|
1763
|
+
parentName: "td"
|
|
1764
|
+
}, "-p")), (0, _react2.mdx)("td", {
|
|
1765
|
+
parentName: "tr",
|
|
1766
|
+
"align": null
|
|
1767
|
+
}, "remove from peerDependencies")))), (0, _react2.mdx)("h3", null, "deps debug"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
1723
1768
|
parentName: "p"
|
|
1724
1769
|
}, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
|
|
1725
1770
|
parentName: "p"
|