@teambit/harmony.content.cli-reference 1.95.25 → 1.95.28
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 +38 -10
- package/cli-reference.mdx +21 -18
- package/dist/cli-reference.json +38 -10
- package/dist/cli-reference.mdx.js +10 -4
- package/dist/cli-reference.mdx.js.map +1 -1
- package/package-tar/teambit-harmony.content.cli-reference-1.95.28.tgz +0 -0
- package/package.json +2 -2
- package/{preview-1654572446572.js → preview-1654918011878.js} +2 -2
- package/package-tar/teambit-harmony.content.cli-reference-1.95.25.tgz +0 -0
package/cli-reference.json
CHANGED
|
@@ -1086,17 +1086,33 @@
|
|
|
1086
1086
|
"group": "development"
|
|
1087
1087
|
},
|
|
1088
1088
|
{
|
|
1089
|
-
"name": "unset <
|
|
1089
|
+
"name": "unset <pattern>",
|
|
1090
1090
|
"options": [],
|
|
1091
|
-
"description": "unset an environment from component(s)",
|
|
1092
|
-
"extendedDescription": "
|
|
1091
|
+
"description": "unset an environment from component(s) that was set by \"bit env set\"",
|
|
1092
|
+
"extendedDescription": "keep in mind that this doesn't remove envs that are set in the variants.\nin only removes envs that appear in the .bitmap file, which were previously configured via \"bit env set\".\nthe purpose of this command is to remove the specific settings and let the the variants in workspace.jsonc to control the env.\nyou can use a `<pattern>` for multiple component ids, such as `bit env unset \"org.scope/utils/**\"`. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nto validate the pattern before running this command, run `bit pattern <pattern>`.\n",
|
|
1093
1093
|
"group": "development"
|
|
1094
1094
|
},
|
|
1095
1095
|
{
|
|
1096
1096
|
"name": "replace <old-env> <new-env>",
|
|
1097
1097
|
"options": [],
|
|
1098
1098
|
"description": "replace an existing env with another env for all components using the old env",
|
|
1099
|
-
"group": "development"
|
|
1099
|
+
"group": "development",
|
|
1100
|
+
"arguments": [
|
|
1101
|
+
{
|
|
1102
|
+
"name": "old-env",
|
|
1103
|
+
"description": "current environment id"
|
|
1104
|
+
},
|
|
1105
|
+
{
|
|
1106
|
+
"name": "new-env",
|
|
1107
|
+
"description": "target environment id"
|
|
1108
|
+
}
|
|
1109
|
+
],
|
|
1110
|
+
"examples": [
|
|
1111
|
+
{
|
|
1112
|
+
"cmd": "replace teambit.harmony/aspect teambit.harmony/node",
|
|
1113
|
+
"description": "all components using aspect env, will be replaced with node env"
|
|
1114
|
+
}
|
|
1115
|
+
]
|
|
1100
1116
|
}
|
|
1101
1117
|
]
|
|
1102
1118
|
},
|
|
@@ -1511,8 +1527,8 @@
|
|
|
1511
1527
|
],
|
|
1512
1528
|
[
|
|
1513
1529
|
"",
|
|
1514
|
-
"
|
|
1515
|
-
"EXPERIMENTAL. when checked out to a lane
|
|
1530
|
+
"save-in-lane",
|
|
1531
|
+
"EXPERIMENTAL. when checked out to a lane and the component is not on the remote-lane, save it in the lane (default to save on main)"
|
|
1516
1532
|
],
|
|
1517
1533
|
[
|
|
1518
1534
|
"",
|
|
@@ -1930,7 +1946,13 @@
|
|
|
1930
1946
|
"extendedDescription": "if no ids are provided, it will tag all new and modified components.\nif component ids are entered, you can specify a version per id using \"@\" sign, e.g. bit tag foo@1.0.0 bar@minor baz@major\nhttps://bit.dev/components/tags\nyou can use a pattern for multiple ids, such as bit tag \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
|
|
1931
1947
|
"group": "development",
|
|
1932
1948
|
"private": false,
|
|
1933
|
-
"remoteOp": true
|
|
1949
|
+
"remoteOp": true,
|
|
1950
|
+
"examples": [
|
|
1951
|
+
{
|
|
1952
|
+
"cmd": "tag --ver 1.0.0",
|
|
1953
|
+
"description": "tag all components to version 1.0.0"
|
|
1954
|
+
}
|
|
1955
|
+
]
|
|
1934
1956
|
},
|
|
1935
1957
|
{
|
|
1936
1958
|
"name": "snap [id]",
|
|
@@ -1987,8 +2009,8 @@
|
|
|
1987
2009
|
"DEPRECATED (use \"--skip-tests\" or \"--unmodified\" instead). force-snap even if tests are failing and even when component has not changed"
|
|
1988
2010
|
]
|
|
1989
2011
|
],
|
|
1990
|
-
"description": "record component changes
|
|
1991
|
-
"extendedDescription": "",
|
|
2012
|
+
"description": "EXPERIMENTAL. record component changes",
|
|
2013
|
+
"extendedDescription": "https://bit.dev/components/snaps\nyou can use a pattern for multiple ids, such as bit snap \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
|
|
1992
2014
|
"group": "ungrouped",
|
|
1993
2015
|
"private": true
|
|
1994
2016
|
},
|
|
@@ -2347,7 +2369,13 @@
|
|
|
2347
2369
|
"group": "info",
|
|
2348
2370
|
"private": false,
|
|
2349
2371
|
"remoteOp": true,
|
|
2350
|
-
"skipWorkspace": true
|
|
2372
|
+
"skipWorkspace": true,
|
|
2373
|
+
"arguments": [
|
|
2374
|
+
{
|
|
2375
|
+
"name": "id",
|
|
2376
|
+
"description": "component-id or component-name"
|
|
2377
|
+
}
|
|
2378
|
+
]
|
|
2351
2379
|
},
|
|
2352
2380
|
{
|
|
2353
2381
|
"name": "deprecate <id>",
|
package/cli-reference.mdx
CHANGED
|
@@ -512,9 +512,12 @@ to validate the pattern before running this command, run `bit pattern <pattern>`
|
|
|
512
512
|
|
|
513
513
|
### envs unset
|
|
514
514
|
|
|
515
|
-
**Usage**: `envs unset <
|
|
515
|
+
**Usage**: `envs unset <pattern>`
|
|
516
516
|
|
|
517
|
-
**Description**: unset an environment from component(s)
|
|
517
|
+
**Description**: unset an environment from component(s) that was set by "bit env set"
|
|
518
|
+
keep in mind that this doesn't remove envs that are set in the variants.
|
|
519
|
+
in only removes envs that appear in the .bitmap file, which were previously configured via "bit env set".
|
|
520
|
+
the purpose of this command is to remove the specific settings and let the the variants in workspace.jsonc to control the env.
|
|
518
521
|
you can use a `<pattern>` for multiple component ids, such as `bit env unset "org.scope/utils/**"`. use comma to separate patterns and "!" to exclude. e.g. "ui/\*\*, !ui/button"
|
|
519
522
|
always wrap the pattern with quotes to avoid collision with shell commands.
|
|
520
523
|
to validate the pattern before running this command, run `bit pattern <pattern>`.
|
|
@@ -636,22 +639,22 @@ you can use a pattern for multiple ids, such as bit import "utils/\*". (wrap the
|
|
|
636
639
|
|
|
637
640
|
`bit import [ids...]`
|
|
638
641
|
|
|
639
|
-
| **Option** | **Option alias** | **Description**
|
|
640
|
-
| -------------------------------- | :--------------: |
|
|
641
|
-
| `--path <path>` | `-p` | import components into a specific directory
|
|
642
|
-
| `--objects` | `-o` | import components objects only, don't write the components to the file system. This is a default behavior for import with no id
|
|
643
|
-
| `--display-dependencies` | `-d` | display the imported dependencies
|
|
644
|
-
| `--override` | `-O` | override local changes
|
|
645
|
-
| `--verbose` | `-v` | showing verbose output for inspection
|
|
646
|
-
| `--json` | `-j` | return the output as JSON
|
|
647
|
-
| `--conf` | | write the configuration file (component.json) of the component (harmony components only)
|
|
648
|
-
| `--skip-npm-install` | | DEPRECATED. use "--skip-dependency-installation" instead
|
|
649
|
-
| `--skip-dependency-installation` | | do not install packages of the imported components
|
|
650
|
-
| `--merge [strategy]` | `-m` | merge local changes with the imported version. strategy should be "theirs", "ours" or "manual"
|
|
651
|
-
| `--dependencies` | | EXPERIMENTAL. import all dependencies and write them to the workspace
|
|
652
|
-
| `--dependents` | | EXPERIMENTAL. import component dependents to allow auto-tag updating them upon tag
|
|
653
|
-
| `--
|
|
654
|
-
| `--all-history` | | relevant for fetching all components objects. avoid optimizations, fetch all history versions, always
|
|
642
|
+
| **Option** | **Option alias** | **Description** |
|
|
643
|
+
| -------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------- |
|
|
644
|
+
| `--path <path>` | `-p` | import components into a specific directory |
|
|
645
|
+
| `--objects` | `-o` | import components objects only, don't write the components to the file system. This is a default behavior for import with no id |
|
|
646
|
+
| `--display-dependencies` | `-d` | display the imported dependencies |
|
|
647
|
+
| `--override` | `-O` | override local changes |
|
|
648
|
+
| `--verbose` | `-v` | showing verbose output for inspection |
|
|
649
|
+
| `--json` | `-j` | return the output as JSON |
|
|
650
|
+
| `--conf` | | write the configuration file (component.json) of the component (harmony components only) |
|
|
651
|
+
| `--skip-npm-install` | | DEPRECATED. use "--skip-dependency-installation" instead |
|
|
652
|
+
| `--skip-dependency-installation` | | do not install packages of the imported components |
|
|
653
|
+
| `--merge [strategy]` | `-m` | merge local changes with the imported version. strategy should be "theirs", "ours" or "manual" |
|
|
654
|
+
| `--dependencies` | | EXPERIMENTAL. import all dependencies and write them to the workspace |
|
|
655
|
+
| `--dependents` | | EXPERIMENTAL. import component dependents to allow auto-tag updating them upon tag |
|
|
656
|
+
| `--save-in-lane` | | EXPERIMENTAL. when checked out to a lane and the component is not on the remote-lane, save it in the lane (default to save on main) |
|
|
657
|
+
| `--all-history` | | relevant for fetching all components objects. avoid optimizations, fetch all history versions, always |
|
|
655
658
|
|
|
656
659
|
---
|
|
657
660
|
|
package/dist/cli-reference.json
CHANGED
|
@@ -1086,17 +1086,33 @@
|
|
|
1086
1086
|
"group": "development"
|
|
1087
1087
|
},
|
|
1088
1088
|
{
|
|
1089
|
-
"name": "unset <
|
|
1089
|
+
"name": "unset <pattern>",
|
|
1090
1090
|
"options": [],
|
|
1091
|
-
"description": "unset an environment from component(s)",
|
|
1092
|
-
"extendedDescription": "
|
|
1091
|
+
"description": "unset an environment from component(s) that was set by \"bit env set\"",
|
|
1092
|
+
"extendedDescription": "keep in mind that this doesn't remove envs that are set in the variants.\nin only removes envs that appear in the .bitmap file, which were previously configured via \"bit env set\".\nthe purpose of this command is to remove the specific settings and let the the variants in workspace.jsonc to control the env.\nyou can use a `<pattern>` for multiple component ids, such as `bit env unset \"org.scope/utils/**\"`. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nalways wrap the pattern with quotes to avoid collision with shell commands.\nto validate the pattern before running this command, run `bit pattern <pattern>`.\n",
|
|
1093
1093
|
"group": "development"
|
|
1094
1094
|
},
|
|
1095
1095
|
{
|
|
1096
1096
|
"name": "replace <old-env> <new-env>",
|
|
1097
1097
|
"options": [],
|
|
1098
1098
|
"description": "replace an existing env with another env for all components using the old env",
|
|
1099
|
-
"group": "development"
|
|
1099
|
+
"group": "development",
|
|
1100
|
+
"arguments": [
|
|
1101
|
+
{
|
|
1102
|
+
"name": "old-env",
|
|
1103
|
+
"description": "current environment id"
|
|
1104
|
+
},
|
|
1105
|
+
{
|
|
1106
|
+
"name": "new-env",
|
|
1107
|
+
"description": "target environment id"
|
|
1108
|
+
}
|
|
1109
|
+
],
|
|
1110
|
+
"examples": [
|
|
1111
|
+
{
|
|
1112
|
+
"cmd": "replace teambit.harmony/aspect teambit.harmony/node",
|
|
1113
|
+
"description": "all components using aspect env, will be replaced with node env"
|
|
1114
|
+
}
|
|
1115
|
+
]
|
|
1100
1116
|
}
|
|
1101
1117
|
]
|
|
1102
1118
|
},
|
|
@@ -1511,8 +1527,8 @@
|
|
|
1511
1527
|
],
|
|
1512
1528
|
[
|
|
1513
1529
|
"",
|
|
1514
|
-
"
|
|
1515
|
-
"EXPERIMENTAL. when checked out to a lane
|
|
1530
|
+
"save-in-lane",
|
|
1531
|
+
"EXPERIMENTAL. when checked out to a lane and the component is not on the remote-lane, save it in the lane (default to save on main)"
|
|
1516
1532
|
],
|
|
1517
1533
|
[
|
|
1518
1534
|
"",
|
|
@@ -1930,7 +1946,13 @@
|
|
|
1930
1946
|
"extendedDescription": "if no ids are provided, it will tag all new and modified components.\nif component ids are entered, you can specify a version per id using \"@\" sign, e.g. bit tag foo@1.0.0 bar@minor baz@major\nhttps://bit.dev/components/tags\nyou can use a pattern for multiple ids, such as bit tag \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
|
|
1931
1947
|
"group": "development",
|
|
1932
1948
|
"private": false,
|
|
1933
|
-
"remoteOp": true
|
|
1949
|
+
"remoteOp": true,
|
|
1950
|
+
"examples": [
|
|
1951
|
+
{
|
|
1952
|
+
"cmd": "tag --ver 1.0.0",
|
|
1953
|
+
"description": "tag all components to version 1.0.0"
|
|
1954
|
+
}
|
|
1955
|
+
]
|
|
1934
1956
|
},
|
|
1935
1957
|
{
|
|
1936
1958
|
"name": "snap [id]",
|
|
@@ -1987,8 +2009,8 @@
|
|
|
1987
2009
|
"DEPRECATED (use \"--skip-tests\" or \"--unmodified\" instead). force-snap even if tests are failing and even when component has not changed"
|
|
1988
2010
|
]
|
|
1989
2011
|
],
|
|
1990
|
-
"description": "record component changes
|
|
1991
|
-
"extendedDescription": "",
|
|
2012
|
+
"description": "EXPERIMENTAL. record component changes",
|
|
2013
|
+
"extendedDescription": "https://bit.dev/components/snaps\nyou can use a pattern for multiple ids, such as bit snap \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
|
|
1992
2014
|
"group": "ungrouped",
|
|
1993
2015
|
"private": true
|
|
1994
2016
|
},
|
|
@@ -2347,7 +2369,13 @@
|
|
|
2347
2369
|
"group": "info",
|
|
2348
2370
|
"private": false,
|
|
2349
2371
|
"remoteOp": true,
|
|
2350
|
-
"skipWorkspace": true
|
|
2372
|
+
"skipWorkspace": true,
|
|
2373
|
+
"arguments": [
|
|
2374
|
+
{
|
|
2375
|
+
"name": "id",
|
|
2376
|
+
"description": "component-id or component-name"
|
|
2377
|
+
}
|
|
2378
|
+
]
|
|
2351
2379
|
},
|
|
2352
2380
|
{
|
|
2353
2381
|
"name": "deprecate <id>",
|
|
@@ -2041,9 +2041,15 @@ function MDXContent(_ref) {
|
|
|
2041
2041
|
parentName: "p"
|
|
2042
2042
|
}, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
|
|
2043
2043
|
parentName: "p"
|
|
2044
|
-
}, "envs unset <
|
|
2044
|
+
}, "envs unset <pattern>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
|
|
2045
2045
|
parentName: "p"
|
|
2046
|
-
}, "Description"), ": unset an environment from component(s)", (0, _react2.mdx)("br", {
|
|
2046
|
+
}, "Description"), ": unset an environment from component(s) that was set by \"bit env set\"", (0, _react2.mdx)("br", {
|
|
2047
|
+
parentName: "p"
|
|
2048
|
+
}), "\n", "keep in mind that this doesn't remove envs that are set in the variants.", (0, _react2.mdx)("br", {
|
|
2049
|
+
parentName: "p"
|
|
2050
|
+
}), "\n", "in only removes envs that appear in the .bitmap file, which were previously configured via \"bit env set\".", (0, _react2.mdx)("br", {
|
|
2051
|
+
parentName: "p"
|
|
2052
|
+
}), "\n", "the purpose of this command is to remove the specific settings and let the the variants in workspace.jsonc to control the env.", (0, _react2.mdx)("br", {
|
|
2047
2053
|
parentName: "p"
|
|
2048
2054
|
}), "\n", "you can use a ", (0, _react2.mdx)("inlineCode", {
|
|
2049
2055
|
parentName: "p"
|
|
@@ -2772,13 +2778,13 @@ function MDXContent(_ref) {
|
|
|
2772
2778
|
"align": null
|
|
2773
2779
|
}, (0, _react2.mdx)("inlineCode", {
|
|
2774
2780
|
parentName: "td"
|
|
2775
|
-
}, "--
|
|
2781
|
+
}, "--save-in-lane")), (0, _react2.mdx)("td", {
|
|
2776
2782
|
parentName: "tr",
|
|
2777
2783
|
"align": "center"
|
|
2778
2784
|
}), (0, _react2.mdx)("td", {
|
|
2779
2785
|
parentName: "tr",
|
|
2780
2786
|
"align": null
|
|
2781
|
-
}, "EXPERIMENTAL. when checked out to a lane
|
|
2787
|
+
}, "EXPERIMENTAL. when checked out to a lane and the component is not on the remote-lane, save it in the lane (default to save on main)")), (0, _react2.mdx)("tr", {
|
|
2782
2788
|
parentName: "tbody"
|
|
2783
2789
|
}, (0, _react2.mdx)("td", {
|
|
2784
2790
|
parentName: "tr",
|