@teambit/harmony.content.cli-reference 2.0.973 → 2.0.975

package/cli-reference.docs.mdx

@@ -1,4 +1,4 @@
 ---
-description: 'Bit command synopses. Bit version: 1.13.110'
+description: 'Bit command synopses. Bit version: 1.13.112'
 labels: ['cli', 'mdx', 'docs']
 ---

package/cli-reference.json

@@ -2701,6 +2701,11 @@
         "",
         "force-theirs",
         "do not merge, just overwrite with incoming files"
+      ],
+      [
+        "",
+        "include-new-from-scope",
+        "relevant for 'bit checkout head'. import components from the defaultScope that don't exist in the workspace"
       ]
     ],
     "description": "switch between component versions or remove local changes",
@@ -3520,6 +3525,43 @@
     "group": "advanced",
     "private": true
   },
+  {
+    "name": "schema <pattern>",
+    "alias": "",
+    "options": [
+      [
+        "r",
+        "remote",
+        "fetch schema from remote scope (works for components not in workspace)"
+      ],
+      [
+        "j",
+        "json",
+        "return the component schema in json format"
+      ]
+    ],
+    "description": "display component API schema and type definitions",
+    "extendedDescription": "extracts and displays the public API structure of components including types, functions, classes, and interfaces.\nshows detailed type information, function signatures, and JSDoc documentation for exported elements.\nuseful for understanding component interfaces and generating documentation.\n\nyou can use a `<pattern>` for multiple component ids, such as `bit schema \"org.scope/utils/**\"`.\nuse 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'.\nalways wrap the pattern with single quotes to avoid collision with shell commands.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.\n",
+    "group": "info-analysis",
+    "private": false,
+    "commands": [
+      {
+        "name": "diff <component> <base-version> <compare-version>",
+        "alias": "",
+        "options": [
+          [
+            "j",
+            "json",
+            "return the API diff in json format"
+          ]
+        ],
+        "description": "show API changes between two versions of a component",
+        "extendedDescription": "compares the public API schema between two versions of a component.\nshows added, removed, and modified exports with semantic impact analysis.\n\nexamples:\n  bit schema diff my-component 0.0.1 0.0.2",
+        "group": "info-analysis",
+        "private": false
+      }
+    ]
+  },
   {
     "name": "test [component-pattern]",
     "alias": "at",
@@ -5227,26 +5269,6 @@
       }
     ]
   },
-  {
-    "name": "schema <pattern>",
-    "alias": "",
-    "options": [
-      [
-        "r",
-        "remote",
-        "fetch schema from remote scope (works for components not in workspace)"
-      ],
-      [
-        "j",
-        "json",
-        "return the component schema in json format"
-      ]
-    ],
-    "description": "display component API schema and type definitions",
-    "extendedDescription": "extracts and displays the public API structure of components including types, functions, classes, and interfaces.\nshows detailed type information, function signatures, and JSDoc documentation for exported elements.\nuseful for understanding component interfaces and generating documentation.\n\nyou can use a `<pattern>` for multiple component ids, such as `bit schema \"org.scope/utils/**\"`.\nuse 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'.\nalways wrap the pattern with single quotes to avoid collision with shell commands.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.\n",
-    "group": "info-analysis",
-    "private": false
-  },
   {
     "name": "log <id>",
     "alias": "",

package/cli-reference.mdx

@@ -359,6 +359,7 @@ the `<to>` argument accepts these values:
 | `--skip-dependency-installation`        |       `-x`       | do not auto-install dependencies of the imported components                                                                              |
 | `--force-ours`                          |                  | do not merge, preserve local files as is                                                                                                 |
 | `--force-theirs`                        |                  | do not merge, just overwrite with incoming files                                                                                         |
+| `--include-new-from-scope`              |                  | relevant for 'bit checkout head'. import components from the defaultScope that don't exist in the workspace                              |
 
 ---
 
@@ -2262,6 +2263,21 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
 
 `bit schema <pattern>`
 
+### schema diff
+
+**Usage**: `schema diff <component> <base-version> <compare-version>`
+
+**Description**: show API changes between two versions of a component  
+compares the public API schema between two versions of a component.  
+shows added, removed, and modified exports with semantic impact analysis.
+
+examples:  
+ bit schema diff my-component 0.0.1 0.0.2
+
+| **Option** | **Option alias** | **Description**                    |
+| ---------- | :--------------: | ---------------------------------- |
+| `--json`   |       `-j`       | return the API diff in json format |
+
 | **Option** | **Option alias** | **Description**                                                        |
 | ---------- | :--------------: | ---------------------------------------------------------------------- |
 | `--remote` |       `-r`       | fetch schema from remote scope (works for components not in workspace) |

package/dist/cli-reference.docs.mdx

@@ -1,4 +1,4 @@
 ---
-description: 'Bit command synopses. Bit version: 1.13.110'
+description: 'Bit command synopses. Bit version: 1.13.112'
 labels: ['cli', 'mdx', 'docs']
 ---

package/dist/cli-reference.json

@@ -2701,6 +2701,11 @@
                 "",
                 "force-theirs",
                 "do not merge, just overwrite with incoming files"
+            ],
+            [
+                "",
+                "include-new-from-scope",
+                "relevant for 'bit checkout head'. import components from the defaultScope that don't exist in the workspace"
             ]
         ],
         "description": "switch between component versions or remove local changes",
@@ -3520,6 +3525,43 @@
         "group": "advanced",
         "private": true
     },
+    {
+        "name": "schema <pattern>",
+        "alias": "",
+        "options": [
+            [
+                "r",
+                "remote",
+                "fetch schema from remote scope (works for components not in workspace)"
+            ],
+            [
+                "j",
+                "json",
+                "return the component schema in json format"
+            ]
+        ],
+        "description": "display component API schema and type definitions",
+        "extendedDescription": "extracts and displays the public API structure of components including types, functions, classes, and interfaces.\nshows detailed type information, function signatures, and JSDoc documentation for exported elements.\nuseful for understanding component interfaces and generating documentation.\n\nyou can use a `<pattern>` for multiple component ids, such as `bit schema \"org.scope/utils/**\"`.\nuse 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'.\nalways wrap the pattern with single quotes to avoid collision with shell commands.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.\n",
+        "group": "info-analysis",
+        "private": false,
+        "commands": [
+            {
+                "name": "diff <component> <base-version> <compare-version>",
+                "alias": "",
+                "options": [
+                    [
+                        "j",
+                        "json",
+                        "return the API diff in json format"
+                    ]
+                ],
+                "description": "show API changes between two versions of a component",
+                "extendedDescription": "compares the public API schema between two versions of a component.\nshows added, removed, and modified exports with semantic impact analysis.\n\nexamples:\n  bit schema diff my-component 0.0.1 0.0.2",
+                "group": "info-analysis",
+                "private": false
+            }
+        ]
+    },
     {
         "name": "test [component-pattern]",
         "alias": "at",
@@ -5227,26 +5269,6 @@
             }
         ]
     },
-    {
-        "name": "schema <pattern>",
-        "alias": "",
-        "options": [
-            [
-                "r",
-                "remote",
-                "fetch schema from remote scope (works for components not in workspace)"
-            ],
-            [
-                "j",
-                "json",
-                "return the component schema in json format"
-            ]
-        ],
-        "description": "display component API schema and type definitions",
-        "extendedDescription": "extracts and displays the public API structure of components including types, functions, classes, and interfaces.\nshows detailed type information, function signatures, and JSDoc documentation for exported elements.\nuseful for understanding component interfaces and generating documentation.\n\nyou can use a `<pattern>` for multiple component ids, such as `bit schema \"org.scope/utils/**\"`.\nuse 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'.\nalways wrap the pattern with single quotes to avoid collision with shell commands.\nuse `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern.\n",
-        "group": "info-analysis",
-        "private": false
-    },
     {
         "name": "log <id>",
         "alias": "",

package/dist/cli-reference.mdx.js

@@ -797,7 +797,9 @@ function _createMdxContent(props) {
         children: "--force-ours"
       }), "                          |                  | do not merge, preserve local files as is                                                                                                 |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
         children: "--force-theirs"
-      }), "                        |                  | do not merge, just overwrite with incoming files                                                                                         |"]
+      }), "                        |                  | do not merge, just overwrite with incoming files                                                                                         |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
+        children: "--include-new-from-scope"
+      }), "              |                  | relevant for 'bit checkout head'. import components from the defaultScope that don't exist in the workspace                              |"]
     }), "\n", (0, _jsxRuntime.jsx)(_components.hr, {}), "\n", (0, _jsxRuntime.jsx)(_components.h2, {
       children: "ci"
     }), "\n", (0, _jsxRuntime.jsxs)(_components.p, {
@@ -4594,6 +4596,32 @@ function _createMdxContent(props) {
       children: (0, _jsxRuntime.jsx)(_components.code, {
         children: "bit schema <pattern>"
       })
+    }), "\n", (0, _jsxRuntime.jsx)(_components.h3, {
+      children: "schema diff"
+    }), "\n", (0, _jsxRuntime.jsxs)(_components.p, {
+      children: [(0, _jsxRuntime.jsx)(_components.strong, {
+        children: "Usage"
+      }), ": ", (0, _jsxRuntime.jsx)(_components.code, {
+        children: "schema diff <component> <base-version> <compare-version>"
+      })]
+    }), "\n", (0, _jsxRuntime.jsxs)(_components.p, {
+      children: [(0, _jsxRuntime.jsx)(_components.strong, {
+        children: "Description"
+      }), ": show API changes between two versions of a component", (0, _jsxRuntime.jsx)(_components.br, {}), "\n", "compares the public API schema between two versions of a component.", (0, _jsxRuntime.jsx)(_components.br, {}), "\n", "shows added, removed, and modified exports with semantic impact analysis."]
+    }), "\n", (0, _jsxRuntime.jsxs)(_components.p, {
+      children: ["examples:", (0, _jsxRuntime.jsx)(_components.br, {}), "\n", "bit schema diff my-component 0.0.1 0.0.2"]
+    }), "\n", (0, _jsxRuntime.jsxs)(_components.p, {
+      children: ["| ", (0, _jsxRuntime.jsx)(_components.strong, {
+        children: "Option"
+      }), " | ", (0, _jsxRuntime.jsx)(_components.strong, {
+        children: "Option alias"
+      }), " | ", (0, _jsxRuntime.jsx)(_components.strong, {
+        children: "Description"
+      }), "                    |\n| ---------- | :--------------: | ---------------------------------- |\n| ", (0, _jsxRuntime.jsx)(_components.code, {
+        children: "--json"
+      }), "   |       ", (0, _jsxRuntime.jsx)(_components.code, {
+        children: "-j"
+      }), "       | return the API diff in json format |"]
     }), "\n", (0, _jsxRuntime.jsxs)(_components.p, {
       children: ["| ", (0, _jsxRuntime.jsx)(_components.strong, {
         children: "Option"