@teambit/harmony.content.cli-reference 2.0.180 → 2.0.182

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.
Files changed (9) hide show
  1. package/cli-reference.docs.mdx +1 -1
  2. package/cli-reference.json +48 -13
  3. package/cli-reference.mdx +53 -9
  4. package/dist/cli-reference.docs.mdx +1 -1
  5. package/dist/cli-reference.json +48 -13
  6. package/dist/cli-reference.mdx.js +235 -15
  7. package/dist/cli-reference.mdx.js.map +1 -1
  8. package/dist/{preview-1708466611462.js → preview-1709003857850.js} +2 -2
  9. package/package.json +2 -2
package/cli-reference.docs.mdx CHANGED
@@ -1,5 +1,5 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.6.63'
2
+ description: 'Bit command synopses. Bit version: 1.6.67'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
5
5
 
package/cli-reference.json CHANGED
@@ -18,6 +18,11 @@
18
18
  "standalone",
19
19
  "do not nest component store within .git directory and do not write config data inside package.json"
20
20
  ],
21
+ [
22
+ "",
23
+ "no-package-json",
24
+ "do not generate package.json"
25
+ ],
21
26
  [
22
27
  "r",
23
28
  "reset",
@@ -63,11 +68,6 @@
63
68
  "force",
64
69
  "force workspace initialization without clearing local objects"
65
70
  ],
66
- [
67
- "",
68
- "harmony",
69
- "DEPRECATED. no need for this flag. Harmony is the default now"
70
- ],
71
71
  [
72
72
  "I",
73
73
  "interactive",
@@ -2958,7 +2958,7 @@
2958
2958
  ]
2959
2959
  ],
2960
2960
  "description": "snap components from a bare-scope",
2961
- "extendedDescription": "this command should be running from a new bare scope, it first imports the components it needs and then processes the snap.\nthe input data is a stringified JSON of an array of the following object.\n{\n componentId: string; // ids always have scope, so it's safe to parse them from string\n dependencies?: string[]; // dependencies to update their versions, e.g. [teambit/compiler@1.0.0, teambit/tester@1.0.0]\n aspects?: Record<string,any> // e.g. { \"teambit.react/react\": {}, \"teambit.envs/envs\": { \"env\": \"teambit.react/react\" } }\n message?: string; // tag-message.\n files?: Array<{path: string, content: string}>; // replace content of specified source-files. the content is base64 encoded.\n isNew?: boolean; // if it's new, it'll be generated from the given files. otherwise, it'll be fetched from the scope and updated.\n mainFile?: string; // relevant when isNew is true. default to \"index.ts\".\n newDependencies?: Array<{ // new dependencies (components and packages) to add.\n id: string; // component-id or package-name. e.g. \"teambit.react/react\" or \"lodash\".\n version?: string; // version of the package. e.g. \"2.0.3\". for packages, it is mandatory.\n isComponent?: boolean; // default true. if false, it's a package dependency\n type?: 'runtime' | 'dev' | 'peer'; // default \"runtime\".\n }>;\n}\nan example of the final data: '[{\"componentId\":\"ci.remote2/comp-b\",\"message\": \"first snap\"}]'\n",
2961
+ "extendedDescription": "this command should be running from a new bare scope, it first imports the components it needs and then processes the snap.\nthe input data is a stringified JSON of an array of the following object.\n{\n componentId: string; // ids always have scope, so it's safe to parse them from string\n dependencies?: string[]; // dependencies component-ids to update their versions, e.g. [teambit.compilation/compiler@1.0.0, teambit.defender/tester@1.0.0]\n aspects?: Record<string,any> // e.g. { \"teambit.react/react\": {}, \"teambit.envs/envs\": { \"env\": \"teambit.react/react\" } }\n message?: string; // tag-message.\n files?: Array<{path: string, content: string}>; // replace content of specified source-files. the content is base64 encoded.\n isNew?: boolean; // if it's new, it'll be generated from the given files. otherwise, it'll be fetched from the scope and updated.\n mainFile?: string; // relevant when isNew is true. default to \"index.ts\".\n newDependencies?: Array<{ // new dependencies (components and packages) to add.\n id: string; // component-id or package-name. e.g. \"teambit.react/react\" or \"lodash\".\n version?: string; // version of the package. e.g. \"2.0.3\". for packages, it is mandatory.\n isComponent?: boolean; // default true. if false, it's a package dependency\n type?: 'runtime' | 'dev' | 'peer'; // default \"runtime\".\n }>;\n removeDependencies?: string[]; // component-id (for components) or package-name (for packages) to remove from the dependencies.\n}\nan example of the final data: '[{\"componentId\":\"ci.remote2/comp-b\",\"message\": \"first snap\"}]'\n",
2962
2962
  "group": "ungrouped",
2963
2963
  "private": true
2964
2964
  },
@@ -3022,7 +3022,7 @@
3022
3022
  ]
3023
3023
  ],
3024
3024
  "description": "switch between component versions or remove local changes",
3025
- "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 (use --latest if you only want semver tags), 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)\nwhen on a lane, \"checkout head\" only checks out components on this lane. to update main components, run \"bit lane merge main\"",
3025
+ "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 (use --latest if you only want semver tags), 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). also, if a component dir is deleted from the filesystem, it'll be restored\nwhen on a lane, \"checkout head\" only checks out components on this lane. to update main components, run \"bit lane merge main\"",
3026
3026
  "group": "development",
3027
3027
  "private": false,
3028
3028
  "arguments": [
@@ -3067,7 +3067,7 @@
3067
3067
  ]
3068
3068
  },
3069
3069
  {
3070
- "name": "stash [sub-command]",
3070
+ "name": "stash <sub-command>",
3071
3071
  "alias": "",
3072
3072
  "options": [
3073
3073
  [
@@ -3081,14 +3081,14 @@
3081
3081
  "message to be attached to the stashed components"
3082
3082
  ]
3083
3083
  ],
3084
- "description": "EXPERIMENTAL (more like a POC). stash modified components",
3084
+ "description": "EXPERIMENTAL. stash modified components",
3085
3085
  "extendedDescription": "",
3086
3086
  "group": "development",
3087
- "private": true,
3087
+ "private": false,
3088
3088
  "commands": [
3089
3089
  {
3090
3090
  "name": "save",
3091
- "alias": "",
3091
+ "alias": "s",
3092
3092
  "options": [
3093
3093
  [
3094
3094
  "p",
@@ -3107,10 +3107,40 @@
3107
3107
  "private": false
3108
3108
  },
3109
3109
  {
3110
- "name": "load",
3110
+ "name": "load [stash-id]",
3111
+ "alias": "pop",
3112
+ "options": [
3113
+ [
3114
+ "",
3115
+ "auto-merge-resolve <merge-strategy>",
3116
+ "in case of merge conflict, resolve according to the provided strategy: [ours, theirs, manual]"
3117
+ ],
3118
+ [
3119
+ "",
3120
+ "manual",
3121
+ "same as \"--auto-merge-resolve manual\". in case of merge conflict, write the files with the conflict markers"
3122
+ ],
3123
+ [
3124
+ "",
3125
+ "force-ours",
3126
+ "do not merge, preserve local files as is"
3127
+ ],
3128
+ [
3129
+ "",
3130
+ "force-theirs",
3131
+ "do not merge, just overwrite with incoming files"
3132
+ ]
3133
+ ],
3134
+ "description": "apply the changes according to the stash. if no stash-id provided, it loads the latest stash",
3135
+ "extendedDescription": "",
3136
+ "group": "development",
3137
+ "private": false
3138
+ },
3139
+ {
3140
+ "name": "list",
3111
3141
  "alias": "",
3112
3142
  "options": [],
3113
- "description": "load latest stash, checkout components and delete stash",
3143
+ "description": "list stash",
3114
3144
  "extendedDescription": "",
3115
3145
  "group": "development",
3116
3146
  "private": false
@@ -3253,6 +3283,11 @@
3253
3283
  "full-hash",
3254
3284
  "show full hash of the snap (default to the first 9 characters for --one-line/--parents flags)"
3255
3285
  ],
3286
+ [
3287
+ "m",
3288
+ "full-message",
3289
+ "show full message of the snap (default to the first line for --one-line/--parents flags)"
3290
+ ],
3256
3291
  [
3257
3292
  "j",
3258
3293
  "json",
package/cli-reference.mdx CHANGED
@@ -280,7 +280,7 @@ with no args, only workspace's capsules are deleted
280
280
  `bit checkout <version> [component-pattern]` => checkout the specified ids (or all components when --all is used) to the specified version
281
281
  `bit checkout head [component-pattern]` => checkout to the last snap/tag (use --latest if you only want semver tags), omit [component-pattern] to checkout head for all
282
282
  `bit checkout latest [component-pattern]` => checkout to the latest satisfying semver tag, omit [component-pattern] to checkout latest for all
283
- `bit checkout reset [component-pattern]` => remove local modifications from the specified ids (or all components when --all is used)
283
+ `bit checkout reset [component-pattern]` => remove local modifications from the specified ids (or all components when --all is used). also, if a component dir is deleted from the filesystem, it'll be restored
284
284
  when on a lane, "checkout head" only checks out components on this lane. to update main components, run "bit lane merge main"
285
285
 
286
286
  `bit checkout <to> [component-pattern]`
@@ -937,6 +937,7 @@ https://bit.dev/workspace/creating-workspaces#initialize-a-workspace-on-an-exist
937
937
  | `--bare [name]` | `-b` | initialize an empty bit bare scope |
938
938
  | `--shared <groupname>` | `-s` | add group write permissions to a scope properly |
939
939
  | `--standalone` | `-T` | do not nest component store within .git directory and do not write config data inside package.json |
940
+ | `--no-package-json` | | do not generate package.json |
940
941
  | `--reset` | `-r` | write missing or damaged Bit files |
941
942
  | `--reset-new` | | reset .bitmap file as if the components were newly added and remove all model data (objects) |
942
943
  | `--reset-lane-new` | | same as reset-new, but it only resets components belong to lanes. main components are left intact |
@@ -946,7 +947,6 @@ https://bit.dev/workspace/creating-workspaces#initialize-a-workspace-on-an-exist
946
947
  | `--default-scope <default-scope>` | | set the default scope for components in the workspace |
947
948
  | `--package-manager <package-manager>` | `-p` | set the package manager (npm or yarn) to be used in the workspace |
948
949
  | `--force` | `-f` | force workspace initialization without clearing local objects |
949
- | `--harmony` | | DEPRECATED. no need for this flag. Harmony is the default now |
950
950
  | `--interactive` | `-I` | EXPERIMENTAL. start an interactive process |
951
951
 
952
952
  ---
@@ -1302,13 +1302,14 @@ also, checkout the workspace components according to the restored lane state
1302
1302
  | ------- | :----------------------------: |
1303
1303
  | `id` | component-id or component-name |
1304
1304
 
1305
- | **Option** | **Option alias** | **Description** |
1306
- | ------------- | :--------------: | --------------------------------------------------------------------------------------------- |
1307
- | `--remote` | `-r` | show log of a remote component |
1308
- | `--parents` | | show parents and lanes data |
1309
- | `--one-line` | `-o` | show each log entry in one line |
1310
- | `--full-hash` | `-f` | show full hash of the snap (default to the first 9 characters for --one-line/--parents flags) |
1311
- | `--json` | `-j` | json format |
1305
+ | **Option** | **Option alias** | **Description** |
1306
+ | ---------------- | :--------------: | --------------------------------------------------------------------------------------------- |
1307
+ | `--remote` | `-r` | show log of a remote component |
1308
+ | `--parents` | | show parents and lanes data |
1309
+ | `--one-line` | `-o` | show each log entry in one line |
1310
+ | `--full-hash` | `-f` | show full hash of the snap (default to the first 9 characters for --one-line/--parents flags) |
1311
+ | `--full-message` | `-m` | show full message of the snap (default to the first line for --one-line/--parents flags) |
1312
+ | `--json` | `-j` | json format |
1312
1313
 
1313
1314
  ---
1314
1315
 
@@ -1860,6 +1861,49 @@ optionally, provide [pattern] to limit the fork to specific components
1860
1861
 
1861
1862
  ---
1862
1863
 
1864
+ ## stash
1865
+
1866
+ **Description**: EXPERIMENTAL. stash modified components
1867
+
1868
+ `bit stash <sub-command>`
1869
+
1870
+ ### stash save
1871
+
1872
+ **Usage**: `stash save`
1873
+
1874
+ **Description**: stash modified components
1875
+
1876
+ | **Option** | **Option alias** | **Description** |
1877
+ | -------------------- | :--------------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1878
+ | `--pattern` | `-p` | component name, component id, or component pattern. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
1879
+ | `--message <string>` | `-m` | message to be attached to the stashed components |
1880
+
1881
+ ### stash load
1882
+
1883
+ **Usage**: `stash load [stash-id]`
1884
+
1885
+ **Description**: apply the changes according to the stash. if no stash-id provided, it loads the latest stash
1886
+
1887
+ | **Option** | **Option alias** | **Description** |
1888
+ | --------------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------- |
1889
+ | `--auto-merge-resolve <merge-strategy>` | | in case of merge conflict, resolve according to the provided strategy: [ours, theirs, manual] |
1890
+ | `--manual` | | same as "--auto-merge-resolve manual". in case of merge conflict, write the files with the conflict markers |
1891
+ | `--force-ours` | | do not merge, preserve local files as is |
1892
+ | `--force-theirs` | | do not merge, just overwrite with incoming files |
1893
+
1894
+ ### stash list
1895
+
1896
+ **Usage**: `stash list`
1897
+
1898
+ **Description**: list stash
1899
+
1900
+ | **Option** | **Option alias** | **Description** |
1901
+ | -------------------- | :--------------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1902
+ | `--pattern` | `-p` | component name, component id, or component pattern. 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 `bit pattern --help` to understand patterns better and `bit pattern <pattern>` to validate the pattern. |
1903
+ | `--message <string>` | `-m` | message to be attached to the stashed components |
1904
+
1905
+ ---
1906
+
1863
1907
  ## status
1864
1908
 
1865
1909
  **Alias**: `s`
package/dist/cli-reference.docs.mdx CHANGED
@@ -1,5 +1,5 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.6.63'
2
+ description: 'Bit command synopses. Bit version: 1.6.67'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
5
5
 
package/dist/cli-reference.json CHANGED
@@ -18,6 +18,11 @@
18
18
  "standalone",
19
19
  "do not nest component store within .git directory and do not write config data inside package.json"
20
20
  ],
21
+ [
22
+ "",
23
+ "no-package-json",
24
+ "do not generate package.json"
25
+ ],
21
26
  [
22
27
  "r",
23
28
  "reset",
@@ -63,11 +68,6 @@
63
68
  "force",
64
69
  "force workspace initialization without clearing local objects"
65
70
  ],
66
- [
67
- "",
68
- "harmony",
69
- "DEPRECATED. no need for this flag. Harmony is the default now"
70
- ],
71
71
  [
72
72
  "I",
73
73
  "interactive",
@@ -2958,7 +2958,7 @@
2958
2958
  ]
2959
2959
  ],
2960
2960
  "description": "snap components from a bare-scope",
2961
- "extendedDescription": "this command should be running from a new bare scope, it first imports the components it needs and then processes the snap.\nthe input data is a stringified JSON of an array of the following object.\n{\n componentId: string; // ids always have scope, so it's safe to parse them from string\n dependencies?: string[]; // dependencies to update their versions, e.g. [teambit/compiler@1.0.0, teambit/tester@1.0.0]\n aspects?: Record<string,any> // e.g. { \"teambit.react/react\": {}, \"teambit.envs/envs\": { \"env\": \"teambit.react/react\" } }\n message?: string; // tag-message.\n files?: Array<{path: string, content: string}>; // replace content of specified source-files. the content is base64 encoded.\n isNew?: boolean; // if it's new, it'll be generated from the given files. otherwise, it'll be fetched from the scope and updated.\n mainFile?: string; // relevant when isNew is true. default to \"index.ts\".\n newDependencies?: Array<{ // new dependencies (components and packages) to add.\n id: string; // component-id or package-name. e.g. \"teambit.react/react\" or \"lodash\".\n version?: string; // version of the package. e.g. \"2.0.3\". for packages, it is mandatory.\n isComponent?: boolean; // default true. if false, it's a package dependency\n type?: 'runtime' | 'dev' | 'peer'; // default \"runtime\".\n }>;\n}\nan example of the final data: '[{\"componentId\":\"ci.remote2/comp-b\",\"message\": \"first snap\"}]'\n",
2961
+ "extendedDescription": "this command should be running from a new bare scope, it first imports the components it needs and then processes the snap.\nthe input data is a stringified JSON of an array of the following object.\n{\n componentId: string; // ids always have scope, so it's safe to parse them from string\n dependencies?: string[]; // dependencies component-ids to update their versions, e.g. [teambit.compilation/compiler@1.0.0, teambit.defender/tester@1.0.0]\n aspects?: Record<string,any> // e.g. { \"teambit.react/react\": {}, \"teambit.envs/envs\": { \"env\": \"teambit.react/react\" } }\n message?: string; // tag-message.\n files?: Array<{path: string, content: string}>; // replace content of specified source-files. the content is base64 encoded.\n isNew?: boolean; // if it's new, it'll be generated from the given files. otherwise, it'll be fetched from the scope and updated.\n mainFile?: string; // relevant when isNew is true. default to \"index.ts\".\n newDependencies?: Array<{ // new dependencies (components and packages) to add.\n id: string; // component-id or package-name. e.g. \"teambit.react/react\" or \"lodash\".\n version?: string; // version of the package. e.g. \"2.0.3\". for packages, it is mandatory.\n isComponent?: boolean; // default true. if false, it's a package dependency\n type?: 'runtime' | 'dev' | 'peer'; // default \"runtime\".\n }>;\n removeDependencies?: string[]; // component-id (for components) or package-name (for packages) to remove from the dependencies.\n}\nan example of the final data: '[{\"componentId\":\"ci.remote2/comp-b\",\"message\": \"first snap\"}]'\n",
2962
2962
  "group": "ungrouped",
2963
2963
  "private": true
2964
2964
  },
@@ -3022,7 +3022,7 @@
3022
3022
  ]
3023
3023
  ],
3024
3024
  "description": "switch between component versions or remove local changes",
3025
- "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 (use --latest if you only want semver tags), 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)\nwhen on a lane, \"checkout head\" only checks out components on this lane. to update main components, run \"bit lane merge main\"",
3025
+ "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 (use --latest if you only want semver tags), 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). also, if a component dir is deleted from the filesystem, it'll be restored\nwhen on a lane, \"checkout head\" only checks out components on this lane. to update main components, run \"bit lane merge main\"",
3026
3026
  "group": "development",
3027
3027
  "private": false,
3028
3028
  "arguments": [
@@ -3067,7 +3067,7 @@
3067
3067
  ]
3068
3068
  },
3069
3069
  {
3070
- "name": "stash [sub-command]",
3070
+ "name": "stash <sub-command>",
3071
3071
  "alias": "",
3072
3072
  "options": [
3073
3073
  [
@@ -3081,14 +3081,14 @@
3081
3081
  "message to be attached to the stashed components"
3082
3082
  ]
3083
3083
  ],
3084
- "description": "EXPERIMENTAL (more like a POC). stash modified components",
3084
+ "description": "EXPERIMENTAL. stash modified components",
3085
3085
  "extendedDescription": "",
3086
3086
  "group": "development",
3087
- "private": true,
3087
+ "private": false,
3088
3088
  "commands": [
3089
3089
  {
3090
3090
  "name": "save",
3091
- "alias": "",
3091
+ "alias": "s",
3092
3092
  "options": [
3093
3093
  [
3094
3094
  "p",
@@ -3107,10 +3107,40 @@
3107
3107
  "private": false
3108
3108
  },
3109
3109
  {
3110
- "name": "load",
3110
+ "name": "load [stash-id]",
3111
+ "alias": "pop",
3112
+ "options": [
3113
+ [
3114
+ "",
3115
+ "auto-merge-resolve <merge-strategy>",
3116
+ "in case of merge conflict, resolve according to the provided strategy: [ours, theirs, manual]"
3117
+ ],
3118
+ [
3119
+ "",
3120
+ "manual",
3121
+ "same as \"--auto-merge-resolve manual\". in case of merge conflict, write the files with the conflict markers"
3122
+ ],
3123
+ [
3124
+ "",
3125
+ "force-ours",
3126
+ "do not merge, preserve local files as is"
3127
+ ],
3128
+ [
3129
+ "",
3130
+ "force-theirs",
3131
+ "do not merge, just overwrite with incoming files"
3132
+ ]
3133
+ ],
3134
+ "description": "apply the changes according to the stash. if no stash-id provided, it loads the latest stash",
3135
+ "extendedDescription": "",
3136
+ "group": "development",
3137
+ "private": false
3138
+ },
3139
+ {
3140
+ "name": "list",
3111
3141
  "alias": "",
3112
3142
  "options": [],
3113
- "description": "load latest stash, checkout components and delete stash",
3143
+ "description": "list stash",
3114
3144
  "extendedDescription": "",
3115
3145
  "group": "development",
3116
3146
  "private": false
@@ -3253,6 +3283,11 @@
3253
3283
  "full-hash",
3254
3284
  "show full hash of the snap (default to the first 9 characters for --one-line/--parents flags)"
3255
3285
  ],
3286
+ [
3287
+ "m",
3288
+ "full-message",
3289
+ "show full message of the snap (default to the first line for --one-line/--parents flags)"
3290
+ ],
3256
3291
  [
3257
3292
  "j",
3258
3293
  "json",