@teambit/harmony.content.cli-reference 2.0.351 → 2.0.353

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.7.56'
2
+ description: 'Bit command synopses. Bit version: 1.7.58'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
5
5
 
@@ -131,7 +131,7 @@
131
131
  [
132
132
  "",
133
133
  "generator <env-id>",
134
- "add env-id into the generators field in the workspace config for future \"bit create\" templates"
134
+ "for multiple, separate by a comma. add env-ids into the generators field in the workspace config for future \"bit create\" templates"
135
135
  ],
136
136
  [
137
137
  "T",
@@ -1117,7 +1117,7 @@
1117
1117
  ]
1118
1118
  ],
1119
1119
  "description": "list the component ids matching the given pattern",
1120
- "extendedDescription": "this command helps validating a pattern before using it in other commands.\nNOTE: always wrap the pattern with quotes to avoid collision with shell commands. depending on your shell, it might be single or double quotes.\na pattern can be a simple component-id or component-name. e.g. 'ui/button'.\na pattern can be used with wildcards for multiple component ids, e.g. 'org.scope/utils/**' or '**/utils/**' to capture all org/scopes.\nto enter multiple patterns, separate them by a comma, e.g. 'ui/*, lib/*'\nto exclude, use '!'. e.g. 'ui/**, !ui/button'\nthe matching algorithm is from multimatch (@see https://github.com/sindresorhus/multimatch).\n\nto filter by a state or attribute, prefix the pattern with \"$\". e.g. '$deprecated', '$modified'.\nlist of supported states: [new, modified, deprecated, deleted, snappedOnMain, softTagged, codeModified].\nto filter by multi-params state/attribute, separate the params with \":\", e.g. '$env:teambit.react/react'.\nlist of supported multi-params states: [env].\nto match a state and another criteria, use \" AND \" keyword. e.g. '$modified AND teambit.workspace/**'. note that the state must be first.\n",
1120
+ "extendedDescription": "this command helps validating a pattern before using it in other commands.\nNOTE: always wrap the pattern with quotes to avoid collision with shell commands. depending on your shell, it might be single or double quotes.\na pattern can be a simple component-id or component-name. e.g. 'ui/button'.\na pattern can be used with wildcards for multiple component ids, e.g. 'org.scope/utils/**' or '**/utils/**' to capture all org/scopes.\nto enter multiple patterns, separate them by a comma, e.g. 'ui/*, lib/*'\nto exclude, use '!'. e.g. 'ui/**, !ui/button'\nthe matching algorithm is from multimatch (@see https://github.com/sindresorhus/multimatch).\n\nto filter by a state or attribute, prefix the pattern with \"$\". e.g. '$deprecated', '$modified'.\nlist of supported states: [new, modified, deprecated, deleted, snappedOnMain, softTagged, codeModified, localOnly].\nto filter by multi-params state/attribute, separate the params with \":\", e.g. '$env:teambit.react/react'.\nlist of supported multi-params states: [env].\nto match a state and another criteria, use \" AND \" keyword. e.g. '$modified AND teambit.workspace/**'. note that the state must be first.\n",
1121
1121
  "group": "development",
1122
1122
  "private": false,
1123
1123
  "examples": [
@@ -1143,6 +1143,56 @@
1143
1143
  }
1144
1144
  ]
1145
1145
  },
1146
+ {
1147
+ "name": "local-only <sub-command>",
1148
+ "alias": "",
1149
+ "options": [],
1150
+ "description": "manage local-only components, which reside only in the workspace and are not snapped/tagged",
1151
+ "extendedDescription": "",
1152
+ "group": "development",
1153
+ "private": false,
1154
+ "commands": [
1155
+ {
1156
+ "name": "set <component-pattern>",
1157
+ "alias": "",
1158
+ "options": [],
1159
+ "description": "set a component as local-only",
1160
+ "extendedDescription": "",
1161
+ "group": "ungrouped",
1162
+ "private": false,
1163
+ "arguments": [
1164
+ {
1165
+ "name": "component-pattern",
1166
+ "description": "component name, component id, or component pattern. use component pattern to select multiple components.\nwrap the pattern with quotes. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\".\nuse '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern."
1167
+ }
1168
+ ]
1169
+ },
1170
+ {
1171
+ "name": "unset <component-pattern>",
1172
+ "alias": "",
1173
+ "options": [],
1174
+ "description": "remove a component from local-only",
1175
+ "extendedDescription": "",
1176
+ "group": "ungrouped",
1177
+ "private": false,
1178
+ "arguments": [
1179
+ {
1180
+ "name": "component-pattern",
1181
+ "description": "component name, component id, or component pattern. use component pattern to select multiple components.\nwrap the pattern with quotes. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\".\nuse '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern."
1182
+ }
1183
+ ]
1184
+ },
1185
+ {
1186
+ "name": "list",
1187
+ "alias": "",
1188
+ "options": [],
1189
+ "description": "list all local-only components",
1190
+ "extendedDescription": "",
1191
+ "group": "ungrouped",
1192
+ "private": false
1193
+ }
1194
+ ]
1195
+ },
1146
1196
  {
1147
1197
  "name": "git <sub-command>",
1148
1198
  "alias": "",
package/cli-reference.mdx CHANGED
@@ -954,7 +954,7 @@ if the current directory is already a workspace, it validates that bit files are
954
954
  | **Option** | **Option alias** | **Description** |
955
955
  | ----------------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------------- |
956
956
  | `--name <workspace-name>` | `-n` | name of the workspace |
957
- | `--generator <env-id>` | | add env-id into the generators field in the workspace config for future "bit create" templates |
957
+ | `--generator <env-id>` | | for multiple, separate by a comma. add env-ids into the generators field in the workspace config for future "bit create" templates |
958
958
  | `--standalone` | `-T` | do not nest component store within .git directory and do not write config data inside package.json |
959
959
  | `--no-package-json` | | do not generate package.json |
960
960
  | `--reset` | `-r` | write missing or damaged Bit files |
@@ -1355,6 +1355,40 @@ this command does the following:
1355
1355
 
1356
1356
  ---
1357
1357
 
1358
+ ## local-only
1359
+
1360
+ **Description**: manage local-only components, which reside only in the workspace and are not snapped/tagged
1361
+
1362
+ `bit local-only <sub-command>`
1363
+
1364
+ ### local-only set
1365
+
1366
+ **Usage**: `local-only set <component-pattern>`
1367
+
1368
+ **Description**: set a component as local-only
1369
+
1370
+ | **Arg** | **Description** |
1371
+ | ------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
1372
+ | `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 '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'. use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
1373
+
1374
+ ### local-only unset
1375
+
1376
+ **Usage**: `local-only unset <component-pattern>`
1377
+
1378
+ **Description**: remove a component from local-only
1379
+
1380
+ | **Arg** | **Description** |
1381
+ | ------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
1382
+ | `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 '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'. use `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
1383
+
1384
+ ### local-only list
1385
+
1386
+ **Usage**: `local-only list`
1387
+
1388
+ **Description**: list all local-only components
1389
+
1390
+ ---
1391
+
1358
1392
  ## log
1359
1393
 
1360
1394
  **Description**: show components(s) version history
@@ -1540,7 +1574,7 @@ to exclude, use '!'. e.g. 'ui/**, !ui/button'
1540
1574
  the matching algorithm is from multimatch (@see https://github.com/sindresorhus/multimatch).
1541
1575
 
1542
1576
  to filter by a state or attribute, prefix the pattern with "$". e.g. '$deprecated', '$modified'.
1543
- list of supported states: [new, modified, deprecated, deleted, snappedOnMain, softTagged, codeModified].
1577
+ list of supported states: [new, modified, deprecated, deleted, snappedOnMain, softTagged, codeModified, localOnly].
1544
1578
  to filter by multi-params state/attribute, separate the params with ":", e.g. '$env:teambit.react/react'.
1545
1579
  list of supported multi-params states: [env].
1546
1580
  to match a state and another criteria, use " AND " keyword. e.g. '$modified AND teambit.workspace/\*\*'. note that the state must be first.
@@ -1,5 +1,5 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.7.56'
2
+ description: 'Bit command synopses. Bit version: 1.7.58'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
5
5
 
@@ -131,7 +131,7 @@
131
131
  [
132
132
  "",
133
133
  "generator <env-id>",
134
- "add env-id into the generators field in the workspace config for future \"bit create\" templates"
134
+ "for multiple, separate by a comma. add env-ids into the generators field in the workspace config for future \"bit create\" templates"
135
135
  ],
136
136
  [
137
137
  "T",
@@ -1117,7 +1117,7 @@
1117
1117
  ]
1118
1118
  ],
1119
1119
  "description": "list the component ids matching the given pattern",
1120
- "extendedDescription": "this command helps validating a pattern before using it in other commands.\nNOTE: always wrap the pattern with quotes to avoid collision with shell commands. depending on your shell, it might be single or double quotes.\na pattern can be a simple component-id or component-name. e.g. 'ui/button'.\na pattern can be used with wildcards for multiple component ids, e.g. 'org.scope/utils/**' or '**/utils/**' to capture all org/scopes.\nto enter multiple patterns, separate them by a comma, e.g. 'ui/*, lib/*'\nto exclude, use '!'. e.g. 'ui/**, !ui/button'\nthe matching algorithm is from multimatch (@see https://github.com/sindresorhus/multimatch).\n\nto filter by a state or attribute, prefix the pattern with \"$\". e.g. '$deprecated', '$modified'.\nlist of supported states: [new, modified, deprecated, deleted, snappedOnMain, softTagged, codeModified].\nto filter by multi-params state/attribute, separate the params with \":\", e.g. '$env:teambit.react/react'.\nlist of supported multi-params states: [env].\nto match a state and another criteria, use \" AND \" keyword. e.g. '$modified AND teambit.workspace/**'. note that the state must be first.\n",
1120
+ "extendedDescription": "this command helps validating a pattern before using it in other commands.\nNOTE: always wrap the pattern with quotes to avoid collision with shell commands. depending on your shell, it might be single or double quotes.\na pattern can be a simple component-id or component-name. e.g. 'ui/button'.\na pattern can be used with wildcards for multiple component ids, e.g. 'org.scope/utils/**' or '**/utils/**' to capture all org/scopes.\nto enter multiple patterns, separate them by a comma, e.g. 'ui/*, lib/*'\nto exclude, use '!'. e.g. 'ui/**, !ui/button'\nthe matching algorithm is from multimatch (@see https://github.com/sindresorhus/multimatch).\n\nto filter by a state or attribute, prefix the pattern with \"$\". e.g. '$deprecated', '$modified'.\nlist of supported states: [new, modified, deprecated, deleted, snappedOnMain, softTagged, codeModified, localOnly].\nto filter by multi-params state/attribute, separate the params with \":\", e.g. '$env:teambit.react/react'.\nlist of supported multi-params states: [env].\nto match a state and another criteria, use \" AND \" keyword. e.g. '$modified AND teambit.workspace/**'. note that the state must be first.\n",
1121
1121
  "group": "development",
1122
1122
  "private": false,
1123
1123
  "examples": [
@@ -1143,6 +1143,56 @@
1143
1143
  }
1144
1144
  ]
1145
1145
  },
1146
+ {
1147
+ "name": "local-only <sub-command>",
1148
+ "alias": "",
1149
+ "options": [],
1150
+ "description": "manage local-only components, which reside only in the workspace and are not snapped/tagged",
1151
+ "extendedDescription": "",
1152
+ "group": "development",
1153
+ "private": false,
1154
+ "commands": [
1155
+ {
1156
+ "name": "set <component-pattern>",
1157
+ "alias": "",
1158
+ "options": [],
1159
+ "description": "set a component as local-only",
1160
+ "extendedDescription": "",
1161
+ "group": "ungrouped",
1162
+ "private": false,
1163
+ "arguments": [
1164
+ {
1165
+ "name": "component-pattern",
1166
+ "description": "component name, component id, or component pattern. use component pattern to select multiple components.\nwrap the pattern with quotes. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\".\nuse '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern."
1167
+ }
1168
+ ]
1169
+ },
1170
+ {
1171
+ "name": "unset <component-pattern>",
1172
+ "alias": "",
1173
+ "options": [],
1174
+ "description": "remove a component from local-only",
1175
+ "extendedDescription": "",
1176
+ "group": "ungrouped",
1177
+ "private": false,
1178
+ "arguments": [
1179
+ {
1180
+ "name": "component-pattern",
1181
+ "description": "component name, component id, or component pattern. use component pattern to select multiple components.\nwrap the pattern with quotes. use comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\".\nuse '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern."
1182
+ }
1183
+ ]
1184
+ },
1185
+ {
1186
+ "name": "list",
1187
+ "alias": "",
1188
+ "options": [],
1189
+ "description": "list all local-only components",
1190
+ "extendedDescription": "",
1191
+ "group": "ungrouped",
1192
+ "private": false
1193
+ }
1194
+ ]
1195
+ },
1146
1196
  {
1147
1197
  "name": "git <sub-command>",
1148
1198
  "alias": "",
@@ -4800,7 +4800,7 @@ function MDXContent(_ref) {
4800
4800
  }), (0, _react2.mdx)("td", {
4801
4801
  parentName: "tr",
4802
4802
  "align": null
4803
- }, "add env-id into the generators field in the workspace config for future \"bit create\" templates")), (0, _react2.mdx)("tr", {
4803
+ }, "for multiple, separate by a comma. add env-ids into the generators field in the workspace config for future \"bit create\" templates")), (0, _react2.mdx)("tr", {
4804
4804
  parentName: "tbody"
4805
4805
  }, (0, _react2.mdx)("td", {
4806
4806
  parentName: "tr",
@@ -7199,7 +7199,89 @@ function MDXContent(_ref) {
7199
7199
  }, "-n")), (0, _react2.mdx)("td", {
7200
7200
  parentName: "tr",
7201
7201
  "align": null
7202
- }, "show only components in the specified namespace/s e.g. '-n ui' or '", "*", "/ui'")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "log"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
7202
+ }, "show only components in the specified namespace/s e.g. '-n ui' or '", "*", "/ui'")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "local-only"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
7203
+ parentName: "p"
7204
+ }, "Description"), ": manage local-only components, which reside only in the workspace and are not snapped/tagged"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
7205
+ parentName: "p"
7206
+ }, "bit local-only <sub-command>")), (0, _react2.mdx)("h3", null, "local-only set"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
7207
+ parentName: "p"
7208
+ }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
7209
+ parentName: "p"
7210
+ }, "local-only set <component-pattern>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
7211
+ parentName: "p"
7212
+ }, "Description"), ": set a component as local-only"), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
7213
+ parentName: "table"
7214
+ }, (0, _react2.mdx)("tr", {
7215
+ parentName: "thead"
7216
+ }, (0, _react2.mdx)("th", {
7217
+ parentName: "tr",
7218
+ "align": null
7219
+ }, (0, _react2.mdx)("strong", {
7220
+ parentName: "th"
7221
+ }, "Arg")), (0, _react2.mdx)("th", {
7222
+ parentName: "tr",
7223
+ "align": "center"
7224
+ }, (0, _react2.mdx)("strong", {
7225
+ parentName: "th"
7226
+ }, "Description")))), (0, _react2.mdx)("tbody", {
7227
+ parentName: "table"
7228
+ }, (0, _react2.mdx)("tr", {
7229
+ parentName: "tbody"
7230
+ }, (0, _react2.mdx)("td", {
7231
+ parentName: "tr",
7232
+ "align": null
7233
+ }, (0, _react2.mdx)("inlineCode", {
7234
+ parentName: "td"
7235
+ }, "component-pattern")), (0, _react2.mdx)("td", {
7236
+ parentName: "tr",
7237
+ "align": "center"
7238
+ }, "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 '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'. use ", (0, _react2.mdx)("inlineCode", {
7239
+ parentName: "td"
7240
+ }, "bit pattern --help"), " to understand patterns better and ", (0, _react2.mdx)("inlineCode", {
7241
+ parentName: "td"
7242
+ }, "bit pattern <pattern>"), " to validate the pattern.")))), (0, _react2.mdx)("h3", null, "local-only unset"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
7243
+ parentName: "p"
7244
+ }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
7245
+ parentName: "p"
7246
+ }, "local-only unset <component-pattern>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
7247
+ parentName: "p"
7248
+ }, "Description"), ": remove a component from local-only"), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
7249
+ parentName: "table"
7250
+ }, (0, _react2.mdx)("tr", {
7251
+ parentName: "thead"
7252
+ }, (0, _react2.mdx)("th", {
7253
+ parentName: "tr",
7254
+ "align": null
7255
+ }, (0, _react2.mdx)("strong", {
7256
+ parentName: "th"
7257
+ }, "Arg")), (0, _react2.mdx)("th", {
7258
+ parentName: "tr",
7259
+ "align": "center"
7260
+ }, (0, _react2.mdx)("strong", {
7261
+ parentName: "th"
7262
+ }, "Description")))), (0, _react2.mdx)("tbody", {
7263
+ parentName: "table"
7264
+ }, (0, _react2.mdx)("tr", {
7265
+ parentName: "tbody"
7266
+ }, (0, _react2.mdx)("td", {
7267
+ parentName: "tr",
7268
+ "align": null
7269
+ }, (0, _react2.mdx)("inlineCode", {
7270
+ parentName: "td"
7271
+ }, "component-pattern")), (0, _react2.mdx)("td", {
7272
+ parentName: "tr",
7273
+ "align": "center"
7274
+ }, "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 '$' prefix to filter by states/attributes, e.g. '$deprecated', '$modified' or '$env:teambit.react/react'. use ", (0, _react2.mdx)("inlineCode", {
7275
+ parentName: "td"
7276
+ }, "bit pattern --help"), " to understand patterns better and ", (0, _react2.mdx)("inlineCode", {
7277
+ parentName: "td"
7278
+ }, "bit pattern <pattern>"), " to validate the pattern.")))), (0, _react2.mdx)("h3", null, "local-only list"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
7279
+ parentName: "p"
7280
+ }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
7281
+ parentName: "p"
7282
+ }, "local-only list")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
7283
+ parentName: "p"
7284
+ }, "Description"), ": list all local-only components"), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "log"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
7203
7285
  parentName: "p"
7204
7286
  }, "Description"), ": show components(s) version history"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
7205
7287
  parentName: "p"
@@ -8172,7 +8254,7 @@ function MDXContent(_ref) {
8172
8254
  "href": "https://github.com/sindresorhus/multimatch"
8173
8255
  }, "https://github.com/sindresorhus/multimatch"), ")."), (0, _react2.mdx)("p", null, "to filter by a state or attribute, prefix the pattern with \"$\". e.g. '$deprecated', '$modified'.", (0, _react2.mdx)("br", {
8174
8256
  parentName: "p"
8175
- }), "\n", "list of supported states: ", "[new, modified, deprecated, deleted, snappedOnMain, softTagged, codeModified]", ".", (0, _react2.mdx)("br", {
8257
+ }), "\n", "list of supported states: ", "[new, modified, deprecated, deleted, snappedOnMain, softTagged, codeModified, localOnly]", ".", (0, _react2.mdx)("br", {
8176
8258
  parentName: "p"
8177
8259
  }), "\n", "to filter by multi-params state/attribute, separate the params with \":\", e.g. '$env:teambit.react/react'.", (0, _react2.mdx)("br", {
8178
8260
  parentName: "p"