@teambit/harmony.content.cli-reference 2.0.627 → 2.0.629

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,4 +1,4 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.10.0'
2
+ description: 'Bit command synopses. Bit version: 1.10.2'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
@@ -1286,10 +1286,15 @@
1286
1286
  "show only component ids, unformatted"
1287
1287
  ],
1288
1288
  [
1289
- "s",
1290
- "scope",
1289
+ "l",
1290
+ "local-scope",
1291
1291
  "show only components stored in the local scope, including indirect dependencies"
1292
1292
  ],
1293
+ [
1294
+ "s",
1295
+ "scope <string>",
1296
+ "filter components by their scope name (e.g., teambit.workspace)"
1297
+ ],
1293
1298
  [
1294
1299
  "o",
1295
1300
  "outdated",
@@ -1308,7 +1313,7 @@
1308
1313
  [
1309
1314
  "n",
1310
1315
  "namespace <string>",
1311
- "show only components in the specified namespace/s e.g. '-n ui' or '*/ui'"
1316
+ "filter components by their namespace (a logical grouping within a scope, e.g., 'ui', '*/ui')"
1312
1317
  ]
1313
1318
  ],
1314
1319
  "description": "list components on a workspace or a remote scope (with flag).",
@@ -3172,10 +3177,6 @@
3172
3177
  {
3173
3178
  "name": "component-pattern",
3174
3179
  "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."
3175
- },
3176
- {
3177
- "name": "component-version",
3178
- "description": "the version to untag (semver for tags. hash for snaps)"
3179
3180
  }
3180
3181
  ]
3181
3182
  },
package/cli-reference.mdx CHANGED
@@ -1472,11 +1472,12 @@ this command does the following:
1472
1472
  | **Option** | **Option alias** | **Description** |
1473
1473
  | ---------------------- | :--------------: | --------------------------------------------------------------------------------------------- |
1474
1474
  | `--ids` | `-i` | show only component ids, unformatted |
1475
- | `--scope` | `-s` | show only components stored in the local scope, including indirect dependencies |
1475
+ | `--local-scope` | `-l` | show only components stored in the local scope, including indirect dependencies |
1476
+ | `--scope <string>` | `-s` | filter components by their scope name (e.g., teambit.workspace) |
1476
1477
  | `--outdated` | `-o` | highlight outdated components, in comparison with their latest remote version (if one exists) |
1477
1478
  | `--include-deleted` | `-d` | EXPERIMENTAL. show also deleted components |
1478
1479
  | `--json` | `-j` | show the output in JSON format |
1479
- | `--namespace <string>` | `-n` | show only components in the specified namespace/s e.g. '-n ui' or '\*/ui' |
1480
+ | `--namespace <string>` | `-n` | filter components by their namespace (a logical grouping within a scope, e.g., 'ui', '\*/ui') |
1480
1481
 
1481
1482
  ---
1482
1483
 
@@ -1830,7 +1831,6 @@ https://bit.dev/components/tags#undoing-a-tag
1830
1831
  | **Arg** | **Description** |
1831
1832
  | ------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
1832
1833
  | `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. |
1833
- | `component-version` | the version to untag (semver for tags. hash for snaps) |
1834
1834
 
1835
1835
  | **Option** | **Option alias** | **Description** |
1836
1836
  | ------------------ | :--------------: | --------------------------------------------------------------------------------------------------------------- |
@@ -1,4 +1,4 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.10.0'
2
+ description: 'Bit command synopses. Bit version: 1.10.2'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
@@ -1286,10 +1286,15 @@
1286
1286
  "show only component ids, unformatted"
1287
1287
  ],
1288
1288
  [
1289
- "s",
1290
- "scope",
1289
+ "l",
1290
+ "local-scope",
1291
1291
  "show only components stored in the local scope, including indirect dependencies"
1292
1292
  ],
1293
+ [
1294
+ "s",
1295
+ "scope <string>",
1296
+ "filter components by their scope name (e.g., teambit.workspace)"
1297
+ ],
1293
1298
  [
1294
1299
  "o",
1295
1300
  "outdated",
@@ -1308,7 +1313,7 @@
1308
1313
  [
1309
1314
  "n",
1310
1315
  "namespace <string>",
1311
- "show only components in the specified namespace/s e.g. '-n ui' or '*/ui'"
1316
+ "filter components by their namespace (a logical grouping within a scope, e.g., 'ui', '*/ui')"
1312
1317
  ]
1313
1318
  ],
1314
1319
  "description": "list components on a workspace or a remote scope (with flag).",
@@ -3172,10 +3177,6 @@
3172
3177
  {
3173
3178
  "name": "component-pattern",
3174
3179
  "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."
3175
- },
3176
- {
3177
- "name": "component-version",
3178
- "description": "the version to untag (semver for tags. hash for snaps)"
3179
3180
  }
3180
3181
  ]
3181
3182
  },
@@ -7950,12 +7950,12 @@ function MDXContent(_ref) {
7950
7950
  "align": null
7951
7951
  }, (0, _react2.mdx)("inlineCode", {
7952
7952
  parentName: "td"
7953
- }, "--scope")), (0, _react2.mdx)("td", {
7953
+ }, "--local-scope")), (0, _react2.mdx)("td", {
7954
7954
  parentName: "tr",
7955
7955
  "align": "center"
7956
7956
  }, (0, _react2.mdx)("inlineCode", {
7957
7957
  parentName: "td"
7958
- }, "-s")), (0, _react2.mdx)("td", {
7958
+ }, "-l")), (0, _react2.mdx)("td", {
7959
7959
  parentName: "tr",
7960
7960
  "align": null
7961
7961
  }, "show only components stored in the local scope, including indirect dependencies")), (0, _react2.mdx)("tr", {
@@ -7965,6 +7965,21 @@ function MDXContent(_ref) {
7965
7965
  "align": null
7966
7966
  }, (0, _react2.mdx)("inlineCode", {
7967
7967
  parentName: "td"
7968
+ }, "--scope <string>")), (0, _react2.mdx)("td", {
7969
+ parentName: "tr",
7970
+ "align": "center"
7971
+ }, (0, _react2.mdx)("inlineCode", {
7972
+ parentName: "td"
7973
+ }, "-s")), (0, _react2.mdx)("td", {
7974
+ parentName: "tr",
7975
+ "align": null
7976
+ }, "filter components by their scope name (e.g., teambit.workspace)")), (0, _react2.mdx)("tr", {
7977
+ parentName: "tbody"
7978
+ }, (0, _react2.mdx)("td", {
7979
+ parentName: "tr",
7980
+ "align": null
7981
+ }, (0, _react2.mdx)("inlineCode", {
7982
+ parentName: "td"
7968
7983
  }, "--outdated")), (0, _react2.mdx)("td", {
7969
7984
  parentName: "tr",
7970
7985
  "align": "center"
@@ -8018,7 +8033,7 @@ function MDXContent(_ref) {
8018
8033
  }, "-n")), (0, _react2.mdx)("td", {
8019
8034
  parentName: "tr",
8020
8035
  "align": null
8021
- }, "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", {
8036
+ }, "filter components by their namespace (a logical grouping within a scope, e.g., 'ui', '", "*", "/ui')")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "local-only"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
8022
8037
  parentName: "p"
8023
8038
  }, "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", {
8024
8039
  parentName: "p"
@@ -9658,17 +9673,7 @@ function MDXContent(_ref) {
9658
9673
  parentName: "td"
9659
9674
  }, "bit pattern --help"), " to understand patterns better and ", (0, _react2.mdx)("inlineCode", {
9660
9675
  parentName: "td"
9661
- }, "bit pattern <pattern>"), " to validate the pattern.")), (0, _react2.mdx)("tr", {
9662
- parentName: "tbody"
9663
- }, (0, _react2.mdx)("td", {
9664
- parentName: "tr",
9665
- "align": null
9666
- }, (0, _react2.mdx)("inlineCode", {
9667
- parentName: "td"
9668
- }, "component-version")), (0, _react2.mdx)("td", {
9669
- parentName: "tr",
9670
- "align": "center"
9671
- }, "the version to untag (semver for tags. hash for snaps)")))), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
9676
+ }, "bit pattern <pattern>"), " to validate the pattern.")))), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
9672
9677
  parentName: "table"
9673
9678
  }, (0, _react2.mdx)("tr", {
9674
9679
  parentName: "thead"