@teambit/harmony.content.cli-reference 2.0.916 → 2.0.917

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.
@@ -1,4 +1,4 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.13.51'
2
+ description: 'Bit command synopses. Bit version: 1.13.52'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
@@ -3817,13 +3817,13 @@
3817
3817
  "return the lane history in json format"
3818
3818
  ]
3819
3819
  ],
3820
- "description": "EXPERIMENTAL. show lane history, default to the current lane",
3820
+ "description": "show lane history, default to the current lane",
3821
3821
  "extendedDescription": "list from the oldest to the newest history items",
3822
3822
  "group": "ungrouped",
3823
3823
  "private": false
3824
3824
  },
3825
3825
  {
3826
- "name": "history-diff <from-history-id> <to-history-id>",
3826
+ "name": "history-diff [history-id] [to-history-id]",
3827
3827
  "alias": "",
3828
3828
  "options": [
3829
3829
  [
@@ -3837,8 +3837,8 @@
3837
3837
  "show lane-diff for components conforming to the specified component-pattern only\ncomponent-pattern format: 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 '$' 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."
3838
3838
  ]
3839
3839
  ],
3840
- "description": "EXPERIMENTAL. show diff between two lane-history ids",
3841
- "extendedDescription": "run \"bit lane history\" to find these history-ids",
3840
+ "description": "show diff between lane-history entries",
3841
+ "extendedDescription": "with no arguments - diff the latest history entry against its predecessor\nwith one argument - diff the given history entry against its predecessor\nwith two arguments - diff between two specific history entries (first=from, second=to), useful for comparing any two points in history\nrun \"bit lane history\" to find history-ids",
3842
3842
  "group": "ungrouped",
3843
3843
  "private": false
3844
3844
  },
@@ -3852,7 +3852,7 @@
3852
3852
  "do not install dependencies of the checked out components"
3853
3853
  ]
3854
3854
  ],
3855
- "description": "EXPERIMENTAL. checkout to a previous history of the current lane. see also \"bit lane revert\"",
3855
+ "description": "checkout to a previous history of the current lane. see also \"bit lane revert\"",
3856
3856
  "extendedDescription": "",
3857
3857
  "group": "ungrouped",
3858
3858
  "private": false,
@@ -3883,7 +3883,7 @@
3883
3883
  "return the revert result in json format"
3884
3884
  ]
3885
3885
  ],
3886
- "description": "EXPERIMENTAL. revert to a previous history of the current lane. see also \"bit lane checkout\"",
3886
+ "description": "revert to a previous history of the current lane. see also \"bit lane checkout\"",
3887
3887
  "extendedDescription": "revert is similar to \"lane checkout\", but it keeps the versions and only change the files.\nchoose one or the other based on your needs.\nif you want to continue working on this lane and needs the changes from the history to be the head, then use \"lane revert\".\nif you want to fork the lane from a certain point in history, use \"lane checkout\" and create a new lane from it.",
3888
3888
  "group": "ungrouped",
3889
3889
  "private": false,
package/cli-reference.mdx CHANGED
@@ -1406,7 +1406,7 @@ workspace, but also mark it as deleted from the lane, so it won't be merged late
1406
1406
 
1407
1407
  **Usage**: `lane history [lane-name]`
1408
1408
 
1409
- **Description**: EXPERIMENTAL. show lane history, default to the current lane
1409
+ **Description**: show lane history, default to the current lane
1410
1410
  list from the oldest to the newest history items
1411
1411
 
1412
1412
  | **Option** | **Option alias** | **Description** |
@@ -1416,10 +1416,13 @@ list from the oldest to the newest history items
1416
1416
 
1417
1417
  ### lane history-diff
1418
1418
 
1419
- **Usage**: `lane history-diff <from-history-id> <to-history-id>`
1419
+ **Usage**: `lane history-diff [history-id] [to-history-id]`
1420
1420
 
1421
- **Description**: EXPERIMENTAL. show diff between two lane-history ids
1422
- run "bit lane history" to find these history-ids
1421
+ **Description**: show diff between lane-history entries
1422
+ with no arguments - diff the latest history entry against its predecessor
1423
+ with one argument - diff the given history entry against its predecessor
1424
+ with two arguments - diff between two specific history entries (first=from, second=to), useful for comparing any two points in history
1425
+ run "bit lane history" to find history-ids
1423
1426
 
1424
1427
  | **Option** | **Option alias** | **Description** |
1425
1428
  | ------------------------------- | :--------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -1430,7 +1433,7 @@ run "bit lane history" to find these history-ids
1430
1433
 
1431
1434
  **Usage**: `lane checkout <history-id>`
1432
1435
 
1433
- **Description**: EXPERIMENTAL. checkout to a previous history of the current lane. see also "bit lane revert"
1436
+ **Description**: checkout to a previous history of the current lane. see also "bit lane revert"
1434
1437
 
1435
1438
  | **Arg** | **Description** |
1436
1439
  | ------------ | :-------------------------------------------------------------------: |
@@ -1444,7 +1447,7 @@ run "bit lane history" to find these history-ids
1444
1447
 
1445
1448
  **Usage**: `lane revert <history-id>`
1446
1449
 
1447
- **Description**: EXPERIMENTAL. revert to a previous history of the current lane. see also "bit lane checkout"
1450
+ **Description**: revert to a previous history of the current lane. see also "bit lane checkout"
1448
1451
  revert is similar to "lane checkout", but it keeps the versions and only change the files.
1449
1452
  choose one or the other based on your needs.
1450
1453
  if you want to continue working on this lane and needs the changes from the history to be the head, then use "lane revert".
@@ -1,4 +1,4 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.13.51'
2
+ description: 'Bit command synopses. Bit version: 1.13.52'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
@@ -3817,13 +3817,13 @@
3817
3817
  "return the lane history in json format"
3818
3818
  ]
3819
3819
  ],
3820
- "description": "EXPERIMENTAL. show lane history, default to the current lane",
3820
+ "description": "show lane history, default to the current lane",
3821
3821
  "extendedDescription": "list from the oldest to the newest history items",
3822
3822
  "group": "ungrouped",
3823
3823
  "private": false
3824
3824
  },
3825
3825
  {
3826
- "name": "history-diff <from-history-id> <to-history-id>",
3826
+ "name": "history-diff [history-id] [to-history-id]",
3827
3827
  "alias": "",
3828
3828
  "options": [
3829
3829
  [
@@ -3837,8 +3837,8 @@
3837
3837
  "show lane-diff for components conforming to the specified component-pattern only\ncomponent-pattern format: 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 '$' 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."
3838
3838
  ]
3839
3839
  ],
3840
- "description": "EXPERIMENTAL. show diff between two lane-history ids",
3841
- "extendedDescription": "run \"bit lane history\" to find these history-ids",
3840
+ "description": "show diff between lane-history entries",
3841
+ "extendedDescription": "with no arguments - diff the latest history entry against its predecessor\nwith one argument - diff the given history entry against its predecessor\nwith two arguments - diff between two specific history entries (first=from, second=to), useful for comparing any two points in history\nrun \"bit lane history\" to find history-ids",
3842
3842
  "group": "ungrouped",
3843
3843
  "private": false
3844
3844
  },
@@ -3852,7 +3852,7 @@
3852
3852
  "do not install dependencies of the checked out components"
3853
3853
  ]
3854
3854
  ],
3855
- "description": "EXPERIMENTAL. checkout to a previous history of the current lane. see also \"bit lane revert\"",
3855
+ "description": "checkout to a previous history of the current lane. see also \"bit lane revert\"",
3856
3856
  "extendedDescription": "",
3857
3857
  "group": "ungrouped",
3858
3858
  "private": false,
@@ -3883,7 +3883,7 @@
3883
3883
  "return the revert result in json format"
3884
3884
  ]
3885
3885
  ],
3886
- "description": "EXPERIMENTAL. revert to a previous history of the current lane. see also \"bit lane checkout\"",
3886
+ "description": "revert to a previous history of the current lane. see also \"bit lane checkout\"",
3887
3887
  "extendedDescription": "revert is similar to \"lane checkout\", but it keeps the versions and only change the files.\nchoose one or the other based on your needs.\nif you want to continue working on this lane and needs the changes from the history to be the head, then use \"lane revert\".\nif you want to fork the lane from a certain point in history, use \"lane checkout\" and create a new lane from it.",
3888
3888
  "group": "ungrouped",
3889
3889
  "private": false,
@@ -2947,7 +2947,7 @@ function _createMdxContent(props) {
2947
2947
  }), "\n", (0, _jsxRuntime.jsxs)(_components.p, {
2948
2948
  children: [(0, _jsxRuntime.jsx)(_components.strong, {
2949
2949
  children: "Description"
2950
- }), ": EXPERIMENTAL. show lane history, default to the current lane", (0, _jsxRuntime.jsx)(_components.br, {}), "\n", "list from the oldest to the newest history items"]
2950
+ }), ": show lane history, default to the current lane", (0, _jsxRuntime.jsx)(_components.br, {}), "\n", "list from the oldest to the newest history items"]
2951
2951
  }), "\n", (0, _jsxRuntime.jsxs)(_components.p, {
2952
2952
  children: ["| ", (0, _jsxRuntime.jsx)(_components.strong, {
2953
2953
  children: "Option"
@@ -2968,12 +2968,12 @@ function _createMdxContent(props) {
2968
2968
  children: [(0, _jsxRuntime.jsx)(_components.strong, {
2969
2969
  children: "Usage"
2970
2970
  }), ": ", (0, _jsxRuntime.jsx)(_components.code, {
2971
- children: "lane history-diff <from-history-id> <to-history-id>"
2971
+ children: "lane history-diff [history-id] [to-history-id]"
2972
2972
  })]
2973
2973
  }), "\n", (0, _jsxRuntime.jsxs)(_components.p, {
2974
2974
  children: [(0, _jsxRuntime.jsx)(_components.strong, {
2975
2975
  children: "Description"
2976
- }), ": EXPERIMENTAL. show diff between two lane-history ids", (0, _jsxRuntime.jsx)(_components.br, {}), "\n", "run \"bit lane history\" to find these history-ids"]
2976
+ }), ": show diff between lane-history entries", (0, _jsxRuntime.jsx)(_components.br, {}), "\n", "with no arguments - diff the latest history entry against its predecessor", (0, _jsxRuntime.jsx)(_components.br, {}), "\n", "with one argument - diff the given history entry against its predecessor", (0, _jsxRuntime.jsx)(_components.br, {}), "\n", "with two arguments - diff between two specific history entries (first=from, second=to), useful for comparing any two points in history", (0, _jsxRuntime.jsx)(_components.br, {}), "\n", "run \"bit lane history\" to find history-ids"]
2977
2977
  }), "\n", (0, _jsxRuntime.jsxs)(_components.p, {
2978
2978
  children: ["| ", (0, _jsxRuntime.jsx)(_components.strong, {
2979
2979
  children: "Option"
@@ -3003,7 +3003,7 @@ function _createMdxContent(props) {
3003
3003
  }), "\n", (0, _jsxRuntime.jsxs)(_components.p, {
3004
3004
  children: [(0, _jsxRuntime.jsx)(_components.strong, {
3005
3005
  children: "Description"
3006
- }), ": EXPERIMENTAL. checkout to a previous history of the current lane. see also \"bit lane revert\""]
3006
+ }), ": checkout to a previous history of the current lane. see also \"bit lane revert\""]
3007
3007
  }), "\n", (0, _jsxRuntime.jsxs)(_components.p, {
3008
3008
  children: ["| ", (0, _jsxRuntime.jsx)(_components.strong, {
3009
3009
  children: "Arg"
@@ -3035,7 +3035,7 @@ function _createMdxContent(props) {
3035
3035
  }), "\n", (0, _jsxRuntime.jsxs)(_components.p, {
3036
3036
  children: [(0, _jsxRuntime.jsx)(_components.strong, {
3037
3037
  children: "Description"
3038
- }), ": EXPERIMENTAL. revert to a previous history of the current lane. see also \"bit lane checkout\"", (0, _jsxRuntime.jsx)(_components.br, {}), "\n", "revert is similar to \"lane checkout\", but it keeps the versions and only change the files.", (0, _jsxRuntime.jsx)(_components.br, {}), "\n", "choose one or the other based on your needs.", (0, _jsxRuntime.jsx)(_components.br, {}), "\n", "if you want to continue working on this lane and needs the changes from the history to be the head, then use \"lane revert\".", (0, _jsxRuntime.jsx)(_components.br, {}), "\n", "if you want to fork the lane from a certain point in history, use \"lane checkout\" and create a new lane from it."]
3038
+ }), ": revert to a previous history of the current lane. see also \"bit lane checkout\"", (0, _jsxRuntime.jsx)(_components.br, {}), "\n", "revert is similar to \"lane checkout\", but it keeps the versions and only change the files.", (0, _jsxRuntime.jsx)(_components.br, {}), "\n", "choose one or the other based on your needs.", (0, _jsxRuntime.jsx)(_components.br, {}), "\n", "if you want to continue working on this lane and needs the changes from the history to be the head, then use \"lane revert\".", (0, _jsxRuntime.jsx)(_components.br, {}), "\n", "if you want to fork the lane from a certain point in history, use \"lane checkout\" and create a new lane from it."]
3039
3039
  }), "\n", (0, _jsxRuntime.jsxs)(_components.p, {
3040
3040
  children: ["| ", (0, _jsxRuntime.jsx)(_components.strong, {
3041
3041
  children: "Arg"