@teambit/harmony.content.cli-reference 1.95.140 → 1.95.142

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.
@@ -362,6 +362,11 @@
362
362
  "j",
363
363
  "json",
364
364
  "json format"
365
+ ],
366
+ [
367
+ "g",
368
+ "graph",
369
+ "generate graph image (arrows color: {\"parent\":\"green\",\"unrelated\":\"red\",\"squashed\":\"blue\"})"
365
370
  ]
366
371
  ],
367
372
  "description": "cat version-history object by component-id",
@@ -1844,81 +1849,6 @@
1844
1849
  }
1845
1850
  ]
1846
1851
  },
1847
- {
1848
- "name": "checkout <to> [component-pattern]",
1849
- "alias": "U",
1850
- "options": [
1851
- [
1852
- "i",
1853
- "interactive-merge",
1854
- "when a component is modified and the merge process found conflicts, display options to resolve them"
1855
- ],
1856
- [
1857
- "o",
1858
- "ours",
1859
- "in case of a conflict, override the used version with the current modification"
1860
- ],
1861
- [
1862
- "t",
1863
- "theirs",
1864
- "in case of a conflict, override the current modification with the specified version"
1865
- ],
1866
- [
1867
- "m",
1868
- "manual",
1869
- "in case of a conflict, leave the files with a conflict state to resolve them manually later"
1870
- ],
1871
- [
1872
- "r",
1873
- "reset",
1874
- "revert changes that were not snapped/tagged"
1875
- ],
1876
- [
1877
- "a",
1878
- "all",
1879
- "all components"
1880
- ],
1881
- [
1882
- "e",
1883
- "workspace-only",
1884
- "when on a lane, avoid introducing new components from the remote lane that do not exist locally"
1885
- ],
1886
- [
1887
- "v",
1888
- "verbose",
1889
- "showing verbose output for inspection"
1890
- ],
1891
- [
1892
- "",
1893
- "reset",
1894
- "DEPRECATED. run \"bit checkout reset\" instead"
1895
- ],
1896
- [
1897
- "",
1898
- "skip-npm-install",
1899
- "DEPRECATED. use \"--skip-dependency-installation\" instead"
1900
- ],
1901
- [
1902
- "x",
1903
- "skip-dependency-installation",
1904
- "do not install packages of the imported components"
1905
- ]
1906
- ],
1907
- "description": "switch between component versions or remove local changes",
1908
- "extendedDescription": "\n `bit checkout <version> [component-pattern]` => checkout the specified ids (or all components when --all is used) to the specified version\n `bit checkout head [component-pattern]` => checkout to the last snap/tag, omit [component-pattern] to checkout head for all\n `bit checkout latest [component-pattern]` => checkout to the latest satisfying semver tag, omit [component-pattern] to checkout latest for all\n `bit checkout reset [component-pattern]` => remove local modifications from the specified ids (or all components when --all is used)",
1909
- "group": "development",
1910
- "private": false,
1911
- "arguments": [
1912
- {
1913
- "name": "to",
1914
- "description": "permitted values: [head, latest, reset, specific-version]. 'head' - last snap/tag. 'latest' - semver latest tag. 'reset' - removes local changes"
1915
- },
1916
- {
1917
- "name": "component-pattern",
1918
- "description": "component name, component id, or component pattern. use component pattern to select multiple components.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
1919
- }
1920
- ]
1921
- },
1922
1852
  {
1923
1853
  "name": "import [component-patterns...]",
1924
1854
  "alias": "",
@@ -2046,6 +1976,81 @@
2046
1976
  "group": "ungrouped",
2047
1977
  "private": true
2048
1978
  },
1979
+ {
1980
+ "name": "checkout <to> [component-pattern]",
1981
+ "alias": "U",
1982
+ "options": [
1983
+ [
1984
+ "i",
1985
+ "interactive-merge",
1986
+ "when a component is modified and the merge process found conflicts, display options to resolve them"
1987
+ ],
1988
+ [
1989
+ "o",
1990
+ "ours",
1991
+ "in case of a conflict, override the used version with the current modification"
1992
+ ],
1993
+ [
1994
+ "t",
1995
+ "theirs",
1996
+ "in case of a conflict, override the current modification with the specified version"
1997
+ ],
1998
+ [
1999
+ "m",
2000
+ "manual",
2001
+ "in case of a conflict, leave the files with a conflict state to resolve them manually later"
2002
+ ],
2003
+ [
2004
+ "r",
2005
+ "reset",
2006
+ "revert changes that were not snapped/tagged"
2007
+ ],
2008
+ [
2009
+ "a",
2010
+ "all",
2011
+ "all components"
2012
+ ],
2013
+ [
2014
+ "e",
2015
+ "workspace-only",
2016
+ "when on a lane, avoid introducing new components from the remote lane that do not exist locally"
2017
+ ],
2018
+ [
2019
+ "v",
2020
+ "verbose",
2021
+ "showing verbose output for inspection"
2022
+ ],
2023
+ [
2024
+ "",
2025
+ "reset",
2026
+ "DEPRECATED. run \"bit checkout reset\" instead"
2027
+ ],
2028
+ [
2029
+ "",
2030
+ "skip-npm-install",
2031
+ "DEPRECATED. use \"--skip-dependency-installation\" instead"
2032
+ ],
2033
+ [
2034
+ "x",
2035
+ "skip-dependency-installation",
2036
+ "do not install packages of the imported components"
2037
+ ]
2038
+ ],
2039
+ "description": "switch between component versions or remove local changes",
2040
+ "extendedDescription": "\n `bit checkout <version> [component-pattern]` => checkout the specified ids (or all components when --all is used) to the specified version\n `bit checkout head [component-pattern]` => checkout to the last snap/tag, omit [component-pattern] to checkout head for all\n `bit checkout latest [component-pattern]` => checkout to the latest satisfying semver tag, omit [component-pattern] to checkout latest for all\n `bit checkout reset [component-pattern]` => remove local modifications from the specified ids (or all components when --all is used)",
2041
+ "group": "development",
2042
+ "private": false,
2043
+ "arguments": [
2044
+ {
2045
+ "name": "to",
2046
+ "description": "permitted values: [head, latest, reset, specific-version]. 'head' - last snap/tag. 'latest' - semver latest tag. 'reset' - removes local changes"
2047
+ },
2048
+ {
2049
+ "name": "component-pattern",
2050
+ "description": "component name, component id, or component pattern. use component pattern to select multiple components.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
2051
+ }
2052
+ ]
2053
+ },
2049
2054
  {
2050
2055
  "name": "remove <component-pattern>",
2051
2056
  "alias": "rm",
@@ -2097,7 +2102,7 @@
2097
2102
  ]
2098
2103
  ],
2099
2104
  "description": "remove component(s) from the workspace, or a remote scope",
2100
- "extendedDescription": "",
2105
+ "extendedDescription": "to remove components from your local workspace only, use \"bit remove\" (with no flags).\n\nto remove a component from the remote scope, use \"bit remove --delete\", to mark the components as deleted.\nonce tagged/snapped and exported, the remote scope will be updated and it'll be marked as deleted there as well.\nin case this is running on a lane, it'll mark the component as deleted on the lane only, which tells bit not to merge them. the main will not be affected.\n",
2101
2106
  "group": "collaborate",
2102
2107
  "private": false,
2103
2108
  "remoteOp": true,
package/cli-reference.mdx CHANGED
@@ -1153,7 +1153,12 @@ for example: "http://localhost:3000", "file:///tmp/local-scope"
1153
1153
  ## remove
1154
1154
 
1155
1155
  **Alias**: `rm`
1156
- **Description**: remove component(s) from the workspace, or a remote scope
1156
+ **Description**: remove component(s) from the workspace, or a remote scope
1157
+ to remove components from your local workspace only, use "bit remove" (with no flags).
1158
+
1159
+ to remove a component from the remote scope, use "bit remove --delete", to mark the components as deleted.
1160
+ once tagged/snapped and exported, the remote scope will be updated and it'll be marked as deleted there as well.
1161
+ in case this is running on a lane, it'll mark the component as deleted on the lane only, which tells bit not to merge them. the main will not be affected.
1157
1162
 
1158
1163
  `bit remove <component-pattern>`
1159
1164
 
@@ -362,6 +362,11 @@
362
362
  "j",
363
363
  "json",
364
364
  "json format"
365
+ ],
366
+ [
367
+ "g",
368
+ "graph",
369
+ "generate graph image (arrows color: {\"parent\":\"green\",\"unrelated\":\"red\",\"squashed\":\"blue\"})"
365
370
  ]
366
371
  ],
367
372
  "description": "cat version-history object by component-id",
@@ -1844,81 +1849,6 @@
1844
1849
  }
1845
1850
  ]
1846
1851
  },
1847
- {
1848
- "name": "checkout <to> [component-pattern]",
1849
- "alias": "U",
1850
- "options": [
1851
- [
1852
- "i",
1853
- "interactive-merge",
1854
- "when a component is modified and the merge process found conflicts, display options to resolve them"
1855
- ],
1856
- [
1857
- "o",
1858
- "ours",
1859
- "in case of a conflict, override the used version with the current modification"
1860
- ],
1861
- [
1862
- "t",
1863
- "theirs",
1864
- "in case of a conflict, override the current modification with the specified version"
1865
- ],
1866
- [
1867
- "m",
1868
- "manual",
1869
- "in case of a conflict, leave the files with a conflict state to resolve them manually later"
1870
- ],
1871
- [
1872
- "r",
1873
- "reset",
1874
- "revert changes that were not snapped/tagged"
1875
- ],
1876
- [
1877
- "a",
1878
- "all",
1879
- "all components"
1880
- ],
1881
- [
1882
- "e",
1883
- "workspace-only",
1884
- "when on a lane, avoid introducing new components from the remote lane that do not exist locally"
1885
- ],
1886
- [
1887
- "v",
1888
- "verbose",
1889
- "showing verbose output for inspection"
1890
- ],
1891
- [
1892
- "",
1893
- "reset",
1894
- "DEPRECATED. run \"bit checkout reset\" instead"
1895
- ],
1896
- [
1897
- "",
1898
- "skip-npm-install",
1899
- "DEPRECATED. use \"--skip-dependency-installation\" instead"
1900
- ],
1901
- [
1902
- "x",
1903
- "skip-dependency-installation",
1904
- "do not install packages of the imported components"
1905
- ]
1906
- ],
1907
- "description": "switch between component versions or remove local changes",
1908
- "extendedDescription": "\n `bit checkout <version> [component-pattern]` => checkout the specified ids (or all components when --all is used) to the specified version\n `bit checkout head [component-pattern]` => checkout to the last snap/tag, omit [component-pattern] to checkout head for all\n `bit checkout latest [component-pattern]` => checkout to the latest satisfying semver tag, omit [component-pattern] to checkout latest for all\n `bit checkout reset [component-pattern]` => remove local modifications from the specified ids (or all components when --all is used)",
1909
- "group": "development",
1910
- "private": false,
1911
- "arguments": [
1912
- {
1913
- "name": "to",
1914
- "description": "permitted values: [head, latest, reset, specific-version]. 'head' - last snap/tag. 'latest' - semver latest tag. 'reset' - removes local changes"
1915
- },
1916
- {
1917
- "name": "component-pattern",
1918
- "description": "component name, component id, or component pattern. use component pattern to select multiple components.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
1919
- }
1920
- ]
1921
- },
1922
1852
  {
1923
1853
  "name": "import [component-patterns...]",
1924
1854
  "alias": "",
@@ -2046,6 +1976,81 @@
2046
1976
  "group": "ungrouped",
2047
1977
  "private": true
2048
1978
  },
1979
+ {
1980
+ "name": "checkout <to> [component-pattern]",
1981
+ "alias": "U",
1982
+ "options": [
1983
+ [
1984
+ "i",
1985
+ "interactive-merge",
1986
+ "when a component is modified and the merge process found conflicts, display options to resolve them"
1987
+ ],
1988
+ [
1989
+ "o",
1990
+ "ours",
1991
+ "in case of a conflict, override the used version with the current modification"
1992
+ ],
1993
+ [
1994
+ "t",
1995
+ "theirs",
1996
+ "in case of a conflict, override the current modification with the specified version"
1997
+ ],
1998
+ [
1999
+ "m",
2000
+ "manual",
2001
+ "in case of a conflict, leave the files with a conflict state to resolve them manually later"
2002
+ ],
2003
+ [
2004
+ "r",
2005
+ "reset",
2006
+ "revert changes that were not snapped/tagged"
2007
+ ],
2008
+ [
2009
+ "a",
2010
+ "all",
2011
+ "all components"
2012
+ ],
2013
+ [
2014
+ "e",
2015
+ "workspace-only",
2016
+ "when on a lane, avoid introducing new components from the remote lane that do not exist locally"
2017
+ ],
2018
+ [
2019
+ "v",
2020
+ "verbose",
2021
+ "showing verbose output for inspection"
2022
+ ],
2023
+ [
2024
+ "",
2025
+ "reset",
2026
+ "DEPRECATED. run \"bit checkout reset\" instead"
2027
+ ],
2028
+ [
2029
+ "",
2030
+ "skip-npm-install",
2031
+ "DEPRECATED. use \"--skip-dependency-installation\" instead"
2032
+ ],
2033
+ [
2034
+ "x",
2035
+ "skip-dependency-installation",
2036
+ "do not install packages of the imported components"
2037
+ ]
2038
+ ],
2039
+ "description": "switch between component versions or remove local changes",
2040
+ "extendedDescription": "\n `bit checkout <version> [component-pattern]` => checkout the specified ids (or all components when --all is used) to the specified version\n `bit checkout head [component-pattern]` => checkout to the last snap/tag, omit [component-pattern] to checkout head for all\n `bit checkout latest [component-pattern]` => checkout to the latest satisfying semver tag, omit [component-pattern] to checkout latest for all\n `bit checkout reset [component-pattern]` => remove local modifications from the specified ids (or all components when --all is used)",
2041
+ "group": "development",
2042
+ "private": false,
2043
+ "arguments": [
2044
+ {
2045
+ "name": "to",
2046
+ "description": "permitted values: [head, latest, reset, specific-version]. 'head' - last snap/tag. 'latest' - semver latest tag. 'reset' - removes local changes"
2047
+ },
2048
+ {
2049
+ "name": "component-pattern",
2050
+ "description": "component name, component id, or component pattern. use component pattern to select multiple components.\nuse comma to separate patterns and \"!\" to exclude. e.g. \"ui/**, !ui/button\"\nwrap the pattern with quotes"
2051
+ }
2052
+ ]
2053
+ },
2049
2054
  {
2050
2055
  "name": "remove <component-pattern>",
2051
2056
  "alias": "rm",
@@ -2097,7 +2102,7 @@
2097
2102
  ]
2098
2103
  ],
2099
2104
  "description": "remove component(s) from the workspace, or a remote scope",
2100
- "extendedDescription": "",
2105
+ "extendedDescription": "to remove components from your local workspace only, use \"bit remove\" (with no flags).\n\nto remove a component from the remote scope, use \"bit remove --delete\", to mark the components as deleted.\nonce tagged/snapped and exported, the remote scope will be updated and it'll be marked as deleted there as well.\nin case this is running on a lane, it'll mark the component as deleted on the lane only, which tells bit not to merge them. the main will not be affected.\n",
2101
2106
  "group": "collaborate",
2102
2107
  "private": false,
2103
2108
  "remoteOp": true,
@@ -5353,7 +5353,13 @@ function MDXContent(_ref) {
5353
5353
  parentName: "p"
5354
5354
  }), "\n", (0, _react2.mdx)("strong", {
5355
5355
  parentName: "p"
5356
- }, "Description"), ": remove component(s) from the workspace, or a remote scope"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
5356
+ }, "Description"), ": remove component(s) from the workspace, or a remote scope", (0, _react2.mdx)("br", {
5357
+ parentName: "p"
5358
+ }), "\n", "to remove components from your local workspace only, use \"bit remove\" (with no flags)."), (0, _react2.mdx)("p", null, "to remove a component from the remote scope, use \"bit remove --delete\", to mark the components as deleted.", (0, _react2.mdx)("br", {
5359
+ parentName: "p"
5360
+ }), "\n", "once tagged/snapped and exported, the remote scope will be updated and it'll be marked as deleted there as well.", (0, _react2.mdx)("br", {
5361
+ parentName: "p"
5362
+ }), "\n", "in case this is running on a lane, it'll mark the component as deleted on the lane only, which tells bit not to merge them. the main will not be affected."), (0, _react2.mdx)("p", null, (0, _react2.mdx)("inlineCode", {
5357
5363
  parentName: "p"
5358
5364
  }, "bit remove <component-pattern>")), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
5359
5365
  parentName: "table"