@teambit/harmony.content.cli-reference 2.0.131 → 2.0.132

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.
Files changed (9) hide show
  1. package/cli-reference.docs.mdx +1 -1
  2. package/cli-reference.json +39 -3
  3. package/cli-reference.mdx +9 -8
  4. package/dist/cli-reference.docs.mdx +1 -1
  5. package/dist/cli-reference.json +39 -3
  6. package/dist/cli-reference.mdx.js +52 -12
  7. package/dist/cli-reference.mdx.js.map +1 -1
  8. package/dist/{preview-1704358107276.js → preview-1704425059407.js} +2 -2
  9. package/package.json +2 -2
package/cli-reference.docs.mdx CHANGED
@@ -1,5 +1,5 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.6.16'
2
+ description: 'Bit command synopses. Bit version: 1.6.17'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
5
5
 
package/cli-reference.json CHANGED
@@ -3336,7 +3336,7 @@
3336
3336
  ]
3337
3337
  },
3338
3338
  {
3339
- "name": "diff [values...]",
3339
+ "name": "diff [component-pattern] [version] [to-version]",
3340
3340
  "alias": "",
3341
3341
  "options": [
3342
3342
  [
@@ -3351,9 +3351,45 @@
3351
3351
  ]
3352
3352
  ],
3353
3353
  "description": "show the diff between the components' current source files and config, and their latest snapshot or tag",
3354
- "extendedDescription": "bit diff => compare all modified components to their model version\nbit diff [ids...] => compare the specified components against their modified states\nbit diff [id] [version] => compare component's current files and configs to the specified version of the component\nbit diff [id] [version] [to_version] => compare component's files and configs between the specified version and the to_version provided\nyou can use a pattern for multiple ids, such as bit diff \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
3354
+ "extendedDescription": "",
3355
3355
  "group": "development",
3356
- "private": false
3356
+ "private": false,
3357
+ "arguments": [
3358
+ {
3359
+ "name": "component-pattern",
3360
+ "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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern."
3361
+ },
3362
+ {
3363
+ "name": "version",
3364
+ "description": "specific version to compare against"
3365
+ },
3366
+ {
3367
+ "name": "to-version",
3368
+ "description": "specific version to compare to"
3369
+ }
3370
+ ],
3371
+ "examples": [
3372
+ {
3373
+ "cmd": "diff",
3374
+ "description": "show diff for all modified components"
3375
+ },
3376
+ {
3377
+ "cmd": "diff foo",
3378
+ "description": "show diff for a component \"foo\""
3379
+ },
3380
+ {
3381
+ "cmd": "diff foo 0.0.1",
3382
+ "description": "show diff for a component \"foo\" from the current state to version 0.0.1"
3383
+ },
3384
+ {
3385
+ "cmd": "diff foo 0.0.1 0.0.2",
3386
+ "description": "show diff for a component \"foo\" from version 0.0.1 to version 0.0.2"
3387
+ },
3388
+ {
3389
+ "cmd": "diff '$codeModified' ",
3390
+ "description": "show diff only for components with modified files. ignore config changes"
3391
+ }
3392
+ ]
3357
3393
  },
3358
3394
  {
3359
3395
  "name": "log <id>",
package/cli-reference.mdx CHANGED
@@ -602,14 +602,15 @@ this command marks the components as deleted, and after snap/tag and export they
602
602
 
603
603
  ## diff
604
604
 
605
- **Description**: show the diff between the components' current source files and config, and their latest snapshot or tag
606
- bit diff => compare all modified components to their model version
607
- bit diff [ids...] => compare the specified components against their modified states
608
- bit diff [id] [version] => compare component's current files and configs to the specified version of the component
609
- bit diff [id] [version] [to_version] => compare component's files and configs between the specified version and the to_version provided
610
- you can use a pattern for multiple ids, such as bit diff "utils/\*". (wrap the pattern with quotes to avoid collision with shell commands)
611
-
612
- `bit diff [values...]`
605
+ **Description**: show the diff between the components' current source files and config, and their latest snapshot or tag
606
+
607
+ `bit diff [component-pattern] [version] [to-version]`
608
+
609
+ | **Arg** | **Description** |
610
+ | ------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
611
+ | `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. |
612
+ | `version` | specific version to compare against |
613
+ | `to-version` | specific version to compare to |
613
614
 
614
615
  | **Option** | **Option alias** | **Description** |
615
616
  | ----------- | :--------------: | ------------------------------------------------------- |
package/dist/cli-reference.docs.mdx CHANGED
@@ -1,5 +1,5 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.6.16'
2
+ description: 'Bit command synopses. Bit version: 1.6.17'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
5
5
 
package/dist/cli-reference.json CHANGED
@@ -3336,7 +3336,7 @@
3336
3336
  ]
3337
3337
  },
3338
3338
  {
3339
- "name": "diff [values...]",
3339
+ "name": "diff [component-pattern] [version] [to-version]",
3340
3340
  "alias": "",
3341
3341
  "options": [
3342
3342
  [
@@ -3351,9 +3351,45 @@
3351
3351
  ]
3352
3352
  ],
3353
3353
  "description": "show the diff between the components' current source files and config, and their latest snapshot or tag",
3354
- "extendedDescription": "bit diff => compare all modified components to their model version\nbit diff [ids...] => compare the specified components against their modified states\nbit diff [id] [version] => compare component's current files and configs to the specified version of the component\nbit diff [id] [version] [to_version] => compare component's files and configs between the specified version and the to_version provided\nyou can use a pattern for multiple ids, such as bit diff \"utils/*\". (wrap the pattern with quotes to avoid collision with shell commands)",
3354
+ "extendedDescription": "",
3355
3355
  "group": "development",
3356
- "private": false
3356
+ "private": false,
3357
+ "arguments": [
3358
+ {
3359
+ "name": "component-pattern",
3360
+ "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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern."
3361
+ },
3362
+ {
3363
+ "name": "version",
3364
+ "description": "specific version to compare against"
3365
+ },
3366
+ {
3367
+ "name": "to-version",
3368
+ "description": "specific version to compare to"
3369
+ }
3370
+ ],
3371
+ "examples": [
3372
+ {
3373
+ "cmd": "diff",
3374
+ "description": "show diff for all modified components"
3375
+ },
3376
+ {
3377
+ "cmd": "diff foo",
3378
+ "description": "show diff for a component \"foo\""
3379
+ },
3380
+ {
3381
+ "cmd": "diff foo 0.0.1",
3382
+ "description": "show diff for a component \"foo\" from the current state to version 0.0.1"
3383
+ },
3384
+ {
3385
+ "cmd": "diff foo 0.0.1 0.0.2",
3386
+ "description": "show diff for a component \"foo\" from version 0.0.1 to version 0.0.2"
3387
+ },
3388
+ {
3389
+ "cmd": "diff '$codeModified' ",
3390
+ "description": "show diff only for components with modified files. ignore config changes"
3391
+ }
3392
+ ]
3357
3393
  },
3358
3394
  {
3359
3395
  "name": "log <id>",
package/dist/cli-reference.mdx.js CHANGED
@@ -2864,19 +2864,59 @@ function MDXContent(_ref) {
2864
2864
  "align": null
2865
2865
  }, "max display depth of the dependency graph")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "diff"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
2866
2866
  parentName: "p"
2867
- }, "Description"), ": show the diff between the components' current source files and config, and their latest snapshot or tag", (0, _react2.mdx)("br", {
2867
+ }, "Description"), ": show the diff between the components' current source files and config, and their latest snapshot or tag"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
2868
2868
  parentName: "p"
2869
- }), "\n", "bit diff => compare all modified components to their model version", (0, _react2.mdx)("br", {
2870
- parentName: "p"
2871
- }), "\n", "bit diff ", "[ids...]", " => compare the specified components against their modified states", (0, _react2.mdx)("br", {
2872
- parentName: "p"
2873
- }), "\n", "bit diff ", "[id][version]", " => compare component's current files and configs to the specified version of the component", (0, _react2.mdx)("br", {
2874
- parentName: "p"
2875
- }), "\n", "bit diff ", "[id][version]", " ", "[to_version]", " => compare component's files and configs between the specified version and the to_version provided", (0, _react2.mdx)("br", {
2876
- parentName: "p"
2877
- }), "\n", "you can use a pattern for multiple ids, such as bit diff \"utils/", "*", "\". (wrap the pattern with quotes to avoid collision with shell commands)"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
2878
- parentName: "p"
2879
- }, "bit diff [values...]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
2869
+ }, "bit diff [component-pattern] [version] [to-version]")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
2870
+ parentName: "table"
2871
+ }, (0, _react2.mdx)("tr", {
2872
+ parentName: "thead"
2873
+ }, (0, _react2.mdx)("th", {
2874
+ parentName: "tr",
2875
+ "align": null
2876
+ }, (0, _react2.mdx)("strong", {
2877
+ parentName: "th"
2878
+ }, "Arg")), (0, _react2.mdx)("th", {
2879
+ parentName: "tr",
2880
+ "align": "center"
2881
+ }, (0, _react2.mdx)("strong", {
2882
+ parentName: "th"
2883
+ }, "Description")))), (0, _react2.mdx)("tbody", {
2884
+ parentName: "table"
2885
+ }, (0, _react2.mdx)("tr", {
2886
+ parentName: "tbody"
2887
+ }, (0, _react2.mdx)("td", {
2888
+ parentName: "tr",
2889
+ "align": null
2890
+ }, (0, _react2.mdx)("inlineCode", {
2891
+ parentName: "td"
2892
+ }, "component-pattern")), (0, _react2.mdx)("td", {
2893
+ parentName: "tr",
2894
+ "align": "center"
2895
+ }, "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 ", (0, _react2.mdx)("inlineCode", {
2896
+ parentName: "td"
2897
+ }, "bit pattern --help"), " to understand patterns better and ", (0, _react2.mdx)("inlineCode", {
2898
+ parentName: "td"
2899
+ }, "bit pattern <pattern>"), " to validate the pattern.")), (0, _react2.mdx)("tr", {
2900
+ parentName: "tbody"
2901
+ }, (0, _react2.mdx)("td", {
2902
+ parentName: "tr",
2903
+ "align": null
2904
+ }, (0, _react2.mdx)("inlineCode", {
2905
+ parentName: "td"
2906
+ }, "version")), (0, _react2.mdx)("td", {
2907
+ parentName: "tr",
2908
+ "align": "center"
2909
+ }, "specific version to compare against")), (0, _react2.mdx)("tr", {
2910
+ parentName: "tbody"
2911
+ }, (0, _react2.mdx)("td", {
2912
+ parentName: "tr",
2913
+ "align": null
2914
+ }, (0, _react2.mdx)("inlineCode", {
2915
+ parentName: "td"
2916
+ }, "to-version")), (0, _react2.mdx)("td", {
2917
+ parentName: "tr",
2918
+ "align": "center"
2919
+ }, "specific version to compare to")))), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
2880
2920
  parentName: "table"
2881
2921
  }, (0, _react2.mdx)("tr", {
2882
2922
  parentName: "thead"