@teambit/harmony.content.cli-reference 2.0.1095 → 2.0.1096
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.
- package/cli-reference.docs.mdx +1 -1
- package/cli-reference.json +28 -10
- package/cli-reference.mdx +20 -14
- package/dist/cli-reference.docs.mdx +1 -1
- package/dist/cli-reference.json +28 -10
- package/dist/cli-reference.mdx.js +1 -1
- package/dist/cli-reference.mdx.js.map +1 -1
- package/dist/{preview-1782223655861.js → preview-1782229355525.js} +2 -2
- package/package.json +2 -2
package/cli-reference.docs.mdx
CHANGED
package/cli-reference.json
CHANGED
|
@@ -1682,13 +1682,13 @@
|
|
|
1682
1682
|
]
|
|
1683
1683
|
},
|
|
1684
1684
|
{
|
|
1685
|
-
"name": "deprecate <component-
|
|
1685
|
+
"name": "deprecate <component-pattern>",
|
|
1686
1686
|
"alias": "d",
|
|
1687
1687
|
"options": [
|
|
1688
1688
|
[
|
|
1689
1689
|
"",
|
|
1690
1690
|
"new-id <string>",
|
|
1691
|
-
"if replaced by another component, enter the new component id. alternatively use \"bit rename --deprecate\" to do this automatically"
|
|
1691
|
+
"if replaced by another component, enter the new component id. alternatively use \"bit rename --deprecate\" to do this automatically. only valid when the pattern matches a single component"
|
|
1692
1692
|
],
|
|
1693
1693
|
[
|
|
1694
1694
|
"",
|
|
@@ -1696,29 +1696,47 @@
|
|
|
1696
1696
|
"enter a Semver range to deprecate specific versions. see https://www.npmjs.com/package/semver#ranges for the range syntax"
|
|
1697
1697
|
]
|
|
1698
1698
|
],
|
|
1699
|
-
"description": "mark
|
|
1700
|
-
"extendedDescription": "marks
|
|
1699
|
+
"description": "mark components as deprecated to discourage their use",
|
|
1700
|
+
"extendedDescription": "marks components as deprecated locally, then after snap/tag and export they become deprecated in the remote scope.\nthe pattern can match multiple components, so several can be deprecated at once.\noptionally specify a replacement component (single component only) or deprecate only specific version ranges.\ndeprecated components remain available but display warnings when installed or imported.",
|
|
1701
1701
|
"group": "collaborate",
|
|
1702
1702
|
"private": false,
|
|
1703
1703
|
"remoteOp": true,
|
|
1704
1704
|
"skipWorkspace": true,
|
|
1705
1705
|
"arguments": [
|
|
1706
1706
|
{
|
|
1707
|
-
"name": "component-
|
|
1708
|
-
"description": "component name or component
|
|
1707
|
+
"name": "component-pattern",
|
|
1708
|
+
"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."
|
|
1709
|
+
}
|
|
1710
|
+
],
|
|
1711
|
+
"examples": [
|
|
1712
|
+
{
|
|
1713
|
+
"cmd": "deprecate \"ui/**\"",
|
|
1714
|
+
"description": "deprecate all components whose id starts with \"ui/\""
|
|
1709
1715
|
}
|
|
1710
1716
|
]
|
|
1711
1717
|
},
|
|
1712
1718
|
{
|
|
1713
|
-
"name": "undeprecate <
|
|
1719
|
+
"name": "undeprecate <component-pattern>",
|
|
1714
1720
|
"alias": "",
|
|
1715
1721
|
"options": [],
|
|
1716
|
-
"description": "remove the deprecation status from
|
|
1717
|
-
"extendedDescription": "reverses the deprecation of
|
|
1722
|
+
"description": "remove the deprecation status from components",
|
|
1723
|
+
"extendedDescription": "reverses the deprecation of components, removing warnings and allowing normal use again.\nthe pattern can match multiple components, so several can be undeprecated at once.",
|
|
1718
1724
|
"group": "collaborate",
|
|
1719
1725
|
"private": false,
|
|
1720
1726
|
"remoteOp": true,
|
|
1721
|
-
"skipWorkspace": true
|
|
1727
|
+
"skipWorkspace": true,
|
|
1728
|
+
"arguments": [
|
|
1729
|
+
{
|
|
1730
|
+
"name": "component-pattern",
|
|
1731
|
+
"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."
|
|
1732
|
+
}
|
|
1733
|
+
],
|
|
1734
|
+
"examples": [
|
|
1735
|
+
{
|
|
1736
|
+
"cmd": "undeprecate '$deprecated'",
|
|
1737
|
+
"description": "undeprecate all currently-deprecated components"
|
|
1738
|
+
}
|
|
1739
|
+
]
|
|
1722
1740
|
},
|
|
1723
1741
|
{
|
|
1724
1742
|
"name": "git <sub-command>",
|
package/cli-reference.mdx
CHANGED
|
@@ -627,21 +627,22 @@ shows both direct and transitive dependents organized by their origin (workspace
|
|
|
627
627
|
## deprecate
|
|
628
628
|
|
|
629
629
|
**Alias**: `d`
|
|
630
|
-
**Description**: mark
|
|
631
|
-
marks
|
|
632
|
-
|
|
630
|
+
**Description**: mark components as deprecated to discourage their use
|
|
631
|
+
marks components as deprecated locally, then after snap/tag and export they become deprecated in the remote scope.
|
|
632
|
+
the pattern can match multiple components, so several can be deprecated at once.
|
|
633
|
+
optionally specify a replacement component (single component only) or deprecate only specific version ranges.
|
|
633
634
|
deprecated components remain available but display warnings when installed or imported.
|
|
634
635
|
|
|
635
|
-
`bit deprecate <component-
|
|
636
|
+
`bit deprecate <component-pattern>`
|
|
636
637
|
|
|
637
|
-
| **Arg**
|
|
638
|
-
|
|
|
639
|
-
| `component-
|
|
638
|
+
| **Arg** | **Description** |
|
|
639
|
+
| ------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
640
|
+
| `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. |
|
|
640
641
|
|
|
641
|
-
| **Option** | **Option alias** | **Description**
|
|
642
|
-
| ------------------- | :--------------: |
|
|
643
|
-
| `--new-id <string>` | | if replaced by another component, enter the new component id. alternatively use "bit rename --deprecate" to do this automatically |
|
|
644
|
-
| `--range <string>` | | enter a Semver range to deprecate specific versions. see https://www.npmjs.com/package/semver#ranges for the range syntax
|
|
642
|
+
| **Option** | **Option alias** | **Description** |
|
|
643
|
+
| ------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
644
|
+
| `--new-id <string>` | | if replaced by another component, enter the new component id. alternatively use "bit rename --deprecate" to do this automatically. only valid when the pattern matches a single component |
|
|
645
|
+
| `--range <string>` | | enter a Semver range to deprecate specific versions. see https://www.npmjs.com/package/semver#ranges for the range syntax |
|
|
645
646
|
|
|
646
647
|
---
|
|
647
648
|
|
|
@@ -2812,10 +2813,15 @@ supports watch mode, coverage reporting, and debug mode for development workflow
|
|
|
2812
2813
|
|
|
2813
2814
|
## undeprecate
|
|
2814
2815
|
|
|
2815
|
-
**Description**: remove the deprecation status from
|
|
2816
|
-
reverses the deprecation of
|
|
2816
|
+
**Description**: remove the deprecation status from components
|
|
2817
|
+
reverses the deprecation of components, removing warnings and allowing normal use again.
|
|
2818
|
+
the pattern can match multiple components, so several can be undeprecated at once.
|
|
2819
|
+
|
|
2820
|
+
`bit undeprecate <component-pattern>`
|
|
2817
2821
|
|
|
2818
|
-
|
|
2822
|
+
| **Arg** | **Description** |
|
|
2823
|
+
| ------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
|
2824
|
+
| `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. |
|
|
2819
2825
|
|
|
2820
2826
|
---
|
|
2821
2827
|
|
package/dist/cli-reference.json
CHANGED
|
@@ -1682,13 +1682,13 @@
|
|
|
1682
1682
|
]
|
|
1683
1683
|
},
|
|
1684
1684
|
{
|
|
1685
|
-
"name": "deprecate <component-
|
|
1685
|
+
"name": "deprecate <component-pattern>",
|
|
1686
1686
|
"alias": "d",
|
|
1687
1687
|
"options": [
|
|
1688
1688
|
[
|
|
1689
1689
|
"",
|
|
1690
1690
|
"new-id <string>",
|
|
1691
|
-
"if replaced by another component, enter the new component id. alternatively use \"bit rename --deprecate\" to do this automatically"
|
|
1691
|
+
"if replaced by another component, enter the new component id. alternatively use \"bit rename --deprecate\" to do this automatically. only valid when the pattern matches a single component"
|
|
1692
1692
|
],
|
|
1693
1693
|
[
|
|
1694
1694
|
"",
|
|
@@ -1696,29 +1696,47 @@
|
|
|
1696
1696
|
"enter a Semver range to deprecate specific versions. see https://www.npmjs.com/package/semver#ranges for the range syntax"
|
|
1697
1697
|
]
|
|
1698
1698
|
],
|
|
1699
|
-
"description": "mark
|
|
1700
|
-
"extendedDescription": "marks
|
|
1699
|
+
"description": "mark components as deprecated to discourage their use",
|
|
1700
|
+
"extendedDescription": "marks components as deprecated locally, then after snap/tag and export they become deprecated in the remote scope.\nthe pattern can match multiple components, so several can be deprecated at once.\noptionally specify a replacement component (single component only) or deprecate only specific version ranges.\ndeprecated components remain available but display warnings when installed or imported.",
|
|
1701
1701
|
"group": "collaborate",
|
|
1702
1702
|
"private": false,
|
|
1703
1703
|
"remoteOp": true,
|
|
1704
1704
|
"skipWorkspace": true,
|
|
1705
1705
|
"arguments": [
|
|
1706
1706
|
{
|
|
1707
|
-
"name": "component-
|
|
1708
|
-
"description": "component name or component
|
|
1707
|
+
"name": "component-pattern",
|
|
1708
|
+
"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."
|
|
1709
|
+
}
|
|
1710
|
+
],
|
|
1711
|
+
"examples": [
|
|
1712
|
+
{
|
|
1713
|
+
"cmd": "deprecate \"ui/**\"",
|
|
1714
|
+
"description": "deprecate all components whose id starts with \"ui/\""
|
|
1709
1715
|
}
|
|
1710
1716
|
]
|
|
1711
1717
|
},
|
|
1712
1718
|
{
|
|
1713
|
-
"name": "undeprecate <
|
|
1719
|
+
"name": "undeprecate <component-pattern>",
|
|
1714
1720
|
"alias": "",
|
|
1715
1721
|
"options": [],
|
|
1716
|
-
"description": "remove the deprecation status from
|
|
1717
|
-
"extendedDescription": "reverses the deprecation of
|
|
1722
|
+
"description": "remove the deprecation status from components",
|
|
1723
|
+
"extendedDescription": "reverses the deprecation of components, removing warnings and allowing normal use again.\nthe pattern can match multiple components, so several can be undeprecated at once.",
|
|
1718
1724
|
"group": "collaborate",
|
|
1719
1725
|
"private": false,
|
|
1720
1726
|
"remoteOp": true,
|
|
1721
|
-
"skipWorkspace": true
|
|
1727
|
+
"skipWorkspace": true,
|
|
1728
|
+
"arguments": [
|
|
1729
|
+
{
|
|
1730
|
+
"name": "component-pattern",
|
|
1731
|
+
"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."
|
|
1732
|
+
}
|
|
1733
|
+
],
|
|
1734
|
+
"examples": [
|
|
1735
|
+
{
|
|
1736
|
+
"cmd": "undeprecate '$deprecated'",
|
|
1737
|
+
"description": "undeprecate all currently-deprecated components"
|
|
1738
|
+
}
|
|
1739
|
+
]
|
|
1722
1740
|
},
|
|
1723
1741
|
{
|
|
1724
1742
|
"name": "git <sub-command>",
|