@teambit/harmony.content.cli-reference 2.0.1062 → 2.0.1064

package/cli-reference.docs.mdx

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

package/cli-reference.json

@@ -1031,7 +1031,7 @@
       ]
     ],
     "description": "test and validate component patterns",
-    "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/** AND $env:teambit.react/react'.\n",
+    "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, internal, 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/** AND $env:teambit.react/react'.\n",
     "group": "info-analysis",
     "private": false,
     "remoteOp": true,
@@ -6014,6 +6014,39 @@
       }
     ]
   },
+  {
+    "name": "internalize [component-pattern]",
+    "alias": "",
+    "options": [
+      [
+        "r",
+        "revert",
+        "remove the internal mark from the matching components"
+      ],
+      [
+        "l",
+        "list",
+        "list the components currently marked as internal"
+      ],
+      [
+        "j",
+        "json",
+        "return the output as json (the internal components with --list, otherwise the affected component-ids)"
+      ]
+    ],
+    "description": "mark components as internal to hide them by default in the UI",
+    "extendedDescription": "marks components as internal locally, then after snap/tag and export they become internal in the remote scope.\nunlike \"bit local-only\", internal components are still versioned and exported - they are only hidden by default in the UI (workspace, scope and Bit Cloud).\nuse --revert to remove the internal mark, or --list to show the components currently marked as internal.",
+    "group": "collaborate",
+    "private": false,
+    "remoteOp": true,
+    "skipWorkspace": true,
+    "arguments": [
+      {
+        "name": "component-pattern",
+        "description": "component name, component id, component pattern, or relative directory path. 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."
+      }
+    ]
+  },
   {
     "name": "generate-preview [component-pattern]",
     "alias": "",

package/cli-reference.mdx

@@ -1252,6 +1252,27 @@ automatically imports components, compiles components, links to node_modules, an
 
 ---
 
+## internalize
+
+**Description**: mark components as internal to hide them by default in the UI  
+marks components as internal locally, then after snap/tag and export they become internal in the remote scope.  
+unlike "bit local-only", internal components are still versioned and exported - they are only hidden by default in the UI (workspace, scope and Bit Cloud).  
+use --revert to remove the internal mark, or --list to show the components currently marked as internal.
+
+`bit internalize [component-pattern]`
+
+| **Arg**             |                                                                                                                                                                                                                             **Description**                                                                                                                                                                                                                              |
+| ------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
+| `component-pattern` | component name, component id, component pattern, or relative directory path. 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. |
+
+| **Option** | **Option alias** | **Description**                                                                                       |
+| ---------- | :--------------: | ----------------------------------------------------------------------------------------------------- |
+| `--revert` |       `-r`       | remove the internal mark from the matching components                                                 |
+| `--list`   |       `-l`       | list the components currently marked as internal                                                      |
+| `--json`   |       `-j`       | return the output as json (the internal components with --list, otherwise the affected component-ids) |
+
+---
+
 ## lane
 
 **Alias**: `l`  
@@ -1991,7 +2012,7 @@ to exclude, use '!'. e.g. 'ui/**, !ui/button'
 the matching algorithm is from multimatch (@see https://github.com/sindresorhus/multimatch).
 
 to filter by a state or attribute, prefix the pattern with "$". e.g. '$deprecated', '$modified'.  
-list of supported states: [new, modified, deprecated, deleted, snappedOnMain, softTagged, codeModified, localOnly].  
+list of supported states: [new, modified, deprecated, deleted, internal, snappedOnMain, softTagged, codeModified, localOnly].  
 to filter by multi-params state/attribute, separate the params with ":", e.g. '$env:teambit.react/react'.  
 list of supported multi-params states: [env].  
 to match a state and another criteria, use " AND " keyword. e.g. '$modified AND teambit.workspace/\*\* AND $env:teambit.react/react'.

package/dist/cli-reference.docs.mdx

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

package/dist/cli-reference.json

@@ -1031,7 +1031,7 @@
             ]
         ],
         "description": "test and validate component patterns",
-        "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/** AND $env:teambit.react/react'.\n",
+        "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, internal, 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/** AND $env:teambit.react/react'.\n",
         "group": "info-analysis",
         "private": false,
         "remoteOp": true,
@@ -6014,6 +6014,39 @@
             }
         ]
     },
+    {
+        "name": "internalize [component-pattern]",
+        "alias": "",
+        "options": [
+            [
+                "r",
+                "revert",
+                "remove the internal mark from the matching components"
+            ],
+            [
+                "l",
+                "list",
+                "list the components currently marked as internal"
+            ],
+            [
+                "j",
+                "json",
+                "return the output as json (the internal components with --list, otherwise the affected component-ids)"
+            ]
+        ],
+        "description": "mark components as internal to hide them by default in the UI",
+        "extendedDescription": "marks components as internal locally, then after snap/tag and export they become internal in the remote scope.\nunlike \"bit local-only\", internal components are still versioned and exported - they are only hidden by default in the UI (workspace, scope and Bit Cloud).\nuse --revert to remove the internal mark, or --list to show the components currently marked as internal.",
+        "group": "collaborate",
+        "private": false,
+        "remoteOp": true,
+        "skipWorkspace": true,
+        "arguments": [
+            {
+                "name": "component-pattern",
+                "description": "component name, component id, component pattern, or relative directory path. 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."
+            }
+        ]
+    },
     {
         "name": "generate-preview [component-pattern]",
         "alias": "",