@teambit/harmony.content.cli-reference 2.0.292 → 2.0.294

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 +81 -71
  3. package/cli-reference.mdx +4 -2
  4. package/dist/cli-reference.docs.mdx +1 -1
  5. package/dist/cli-reference.json +81 -71
  6. package/dist/cli-reference.mdx.js +51 -23
  7. package/dist/cli-reference.mdx.js.map +1 -1
  8. package/dist/{preview-1716780212160.js → preview-1716953036801.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.177'
2
+ description: 'Bit command synopses. Bit version: 1.6.180'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
5
5
 
package/cli-reference.json CHANGED
@@ -1,75 +1,4 @@
1
1
  [
2
- {
3
- "name": "init [path]",
4
- "alias": "",
5
- "options": [
6
- [
7
- "b",
8
- "bare [name]",
9
- "initialize an empty bit bare scope"
10
- ],
11
- [
12
- "s",
13
- "shared <groupname>",
14
- "add group write permissions to a scope properly"
15
- ],
16
- [
17
- "T",
18
- "standalone",
19
- "do not nest component store within .git directory and do not write config data inside package.json"
20
- ],
21
- [
22
- "",
23
- "no-package-json",
24
- "do not generate package.json"
25
- ],
26
- [
27
- "r",
28
- "reset",
29
- "write missing or damaged Bit files"
30
- ],
31
- [
32
- "",
33
- "reset-new",
34
- "reset .bitmap file as if the components were newly added and remove all model data (objects)"
35
- ],
36
- [
37
- "",
38
- "reset-lane-new",
39
- "same as reset-new, but it only resets components belong to lanes. main components are left intact"
40
- ],
41
- [
42
- "",
43
- "reset-hard",
44
- "delete all Bit files and directories, including Bit configuration, tracking and model data. Useful for re-starting workspace from scratch"
45
- ],
46
- [
47
- "",
48
- "reset-scope",
49
- "removes local scope (.bit or .git/bit). tags/snaps that have not been exported will be lost. workspace is left intact"
50
- ],
51
- [
52
- "d",
53
- "default-directory <default-directory>",
54
- "set the default directory pattern to import/create components into"
55
- ],
56
- [
57
- "",
58
- "default-scope <default-scope>",
59
- "set the default scope for components in the workspace"
60
- ],
61
- [
62
- "f",
63
- "force",
64
- "force workspace initialization without clearing local objects"
65
- ]
66
- ],
67
- "description": "create or reinitialize an empty workspace",
68
- "extendedDescription": "if the current directory is already a workspace, it validates that bit files are correct and rewrite them if needed.",
69
- "group": "start",
70
- "private": false,
71
- "skipWorkspace": true
72
- },
73
2
  {
74
3
  "name": "config",
75
4
  "alias": "",
@@ -439,6 +368,82 @@
439
368
  "group": "general",
440
369
  "private": false
441
370
  },
371
+ {
372
+ "name": "init [path]",
373
+ "alias": "",
374
+ "options": [
375
+ [
376
+ "n",
377
+ "name <workspace-name>",
378
+ "name of the workspace"
379
+ ],
380
+ [
381
+ "T",
382
+ "standalone",
383
+ "do not nest component store within .git directory and do not write config data inside package.json"
384
+ ],
385
+ [
386
+ "",
387
+ "no-package-json",
388
+ "do not generate package.json"
389
+ ],
390
+ [
391
+ "r",
392
+ "reset",
393
+ "write missing or damaged Bit files"
394
+ ],
395
+ [
396
+ "",
397
+ "reset-new",
398
+ "reset .bitmap file as if the components were newly added and remove all model data (objects)"
399
+ ],
400
+ [
401
+ "",
402
+ "reset-lane-new",
403
+ "same as reset-new, but it only resets components belong to lanes. main components are left intact"
404
+ ],
405
+ [
406
+ "",
407
+ "reset-hard",
408
+ "delete all Bit files and directories, including Bit configuration, tracking and model data. Useful for re-starting workspace from scratch"
409
+ ],
410
+ [
411
+ "",
412
+ "reset-scope",
413
+ "removes local scope (.bit or .git/bit). tags/snaps that have not been exported will be lost. workspace is left intact"
414
+ ],
415
+ [
416
+ "d",
417
+ "default-directory <default-directory>",
418
+ "set the default directory pattern to import/create components into"
419
+ ],
420
+ [
421
+ "",
422
+ "default-scope <default-scope>",
423
+ "set the default scope for components in the workspace"
424
+ ],
425
+ [
426
+ "f",
427
+ "force",
428
+ "force workspace initialization without clearing local objects"
429
+ ],
430
+ [
431
+ "b",
432
+ "bare [name]",
433
+ "initialize an empty bit bare scope"
434
+ ],
435
+ [
436
+ "s",
437
+ "shared <groupname>",
438
+ "add group write permissions to a scope properly"
439
+ ]
440
+ ],
441
+ "description": "create or reinitialize an empty workspace",
442
+ "extendedDescription": "if the current directory is already a workspace, it validates that bit files are correct and rewrite them if needed.",
443
+ "group": "start",
444
+ "private": false,
445
+ "skipWorkspace": true
446
+ },
442
447
  {
443
448
  "name": "globals",
444
449
  "alias": "",
@@ -2343,6 +2348,11 @@
2343
2348
  "dependencies",
2344
2349
  "import all dependencies (bit components only) of imported components and write them to the workspace"
2345
2350
  ],
2351
+ [
2352
+ "",
2353
+ "dependencies-head",
2354
+ "same as --dependencies, except it imports the dependencies with their head version"
2355
+ ],
2346
2356
  [
2347
2357
  "",
2348
2358
  "dependents",
package/cli-reference.mdx CHANGED
@@ -924,6 +924,7 @@ bit export => export all staged snaps/tags of components to their remote scope.
924
924
  | `--skip-write-config-files` | | do not write config files (such as eslint, tsconfig, prettier, etc...) |
925
925
  | `--merge [strategy]` | `-m` | merge local changes with the imported version. strategy should be "theirs", "ours" or "manual" |
926
926
  | `--dependencies` | | import all dependencies (bit components only) of imported components and write them to the workspace |
927
+ | `--dependencies-head` | | same as --dependencies, except it imports the dependencies with their head version |
927
928
  | `--dependents` | | import components found while traversing from the imported components upwards to the workspace components |
928
929
  | `--dependents-via <string>` | | same as --dependents except the traversal must go through the specified component. to specify multiple components, wrap with quotes and separate by a comma |
929
930
  | `--dependents-all` | | same as --dependents except not prompting for selecting paths but rather selecting all paths and showing final confirmation before importing |
@@ -947,8 +948,7 @@ if the current directory is already a workspace, it validates that bit files are
947
948
 
948
949
  | **Option** | **Option alias** | **Description** |
949
950
  | ----------------------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------------- |
950
- | `--bare [name]` | `-b` | initialize an empty bit bare scope |
951
- | `--shared <groupname>` | `-s` | add group write permissions to a scope properly |
951
+ | `--name <workspace-name>` | `-n` | name of the workspace |
952
952
  | `--standalone` | `-T` | do not nest component store within .git directory and do not write config data inside package.json |
953
953
  | `--no-package-json` | | do not generate package.json |
954
954
  | `--reset` | `-r` | write missing or damaged Bit files |
@@ -959,6 +959,8 @@ if the current directory is already a workspace, it validates that bit files are
959
959
  | `--default-directory <default-directory>` | `-d` | set the default directory pattern to import/create components into |
960
960
  | `--default-scope <default-scope>` | | set the default scope for components in the workspace |
961
961
  | `--force` | `-f` | force workspace initialization without clearing local objects |
962
+ | `--bare [name]` | `-b` | initialize an empty bit bare scope |
963
+ | `--shared <groupname>` | `-s` | add group write permissions to a scope properly |
962
964
 
963
965
  ---
964
966
 
package/dist/cli-reference.docs.mdx CHANGED
@@ -1,5 +1,5 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.6.177'
2
+ description: 'Bit command synopses. Bit version: 1.6.180'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
5
5
 
package/dist/cli-reference.json CHANGED
@@ -1,75 +1,4 @@
1
1
  [
2
- {
3
- "name": "init [path]",
4
- "alias": "",
5
- "options": [
6
- [
7
- "b",
8
- "bare [name]",
9
- "initialize an empty bit bare scope"
10
- ],
11
- [
12
- "s",
13
- "shared <groupname>",
14
- "add group write permissions to a scope properly"
15
- ],
16
- [
17
- "T",
18
- "standalone",
19
- "do not nest component store within .git directory and do not write config data inside package.json"
20
- ],
21
- [
22
- "",
23
- "no-package-json",
24
- "do not generate package.json"
25
- ],
26
- [
27
- "r",
28
- "reset",
29
- "write missing or damaged Bit files"
30
- ],
31
- [
32
- "",
33
- "reset-new",
34
- "reset .bitmap file as if the components were newly added and remove all model data (objects)"
35
- ],
36
- [
37
- "",
38
- "reset-lane-new",
39
- "same as reset-new, but it only resets components belong to lanes. main components are left intact"
40
- ],
41
- [
42
- "",
43
- "reset-hard",
44
- "delete all Bit files and directories, including Bit configuration, tracking and model data. Useful for re-starting workspace from scratch"
45
- ],
46
- [
47
- "",
48
- "reset-scope",
49
- "removes local scope (.bit or .git/bit). tags/snaps that have not been exported will be lost. workspace is left intact"
50
- ],
51
- [
52
- "d",
53
- "default-directory <default-directory>",
54
- "set the default directory pattern to import/create components into"
55
- ],
56
- [
57
- "",
58
- "default-scope <default-scope>",
59
- "set the default scope for components in the workspace"
60
- ],
61
- [
62
- "f",
63
- "force",
64
- "force workspace initialization without clearing local objects"
65
- ]
66
- ],
67
- "description": "create or reinitialize an empty workspace",
68
- "extendedDescription": "if the current directory is already a workspace, it validates that bit files are correct and rewrite them if needed.",
69
- "group": "start",
70
- "private": false,
71
- "skipWorkspace": true
72
- },
73
2
  {
74
3
  "name": "config",
75
4
  "alias": "",
@@ -439,6 +368,82 @@
439
368
  "group": "general",
440
369
  "private": false
441
370
  },
371
+ {
372
+ "name": "init [path]",
373
+ "alias": "",
374
+ "options": [
375
+ [
376
+ "n",
377
+ "name <workspace-name>",
378
+ "name of the workspace"
379
+ ],
380
+ [
381
+ "T",
382
+ "standalone",
383
+ "do not nest component store within .git directory and do not write config data inside package.json"
384
+ ],
385
+ [
386
+ "",
387
+ "no-package-json",
388
+ "do not generate package.json"
389
+ ],
390
+ [
391
+ "r",
392
+ "reset",
393
+ "write missing or damaged Bit files"
394
+ ],
395
+ [
396
+ "",
397
+ "reset-new",
398
+ "reset .bitmap file as if the components were newly added and remove all model data (objects)"
399
+ ],
400
+ [
401
+ "",
402
+ "reset-lane-new",
403
+ "same as reset-new, but it only resets components belong to lanes. main components are left intact"
404
+ ],
405
+ [
406
+ "",
407
+ "reset-hard",
408
+ "delete all Bit files and directories, including Bit configuration, tracking and model data. Useful for re-starting workspace from scratch"
409
+ ],
410
+ [
411
+ "",
412
+ "reset-scope",
413
+ "removes local scope (.bit or .git/bit). tags/snaps that have not been exported will be lost. workspace is left intact"
414
+ ],
415
+ [
416
+ "d",
417
+ "default-directory <default-directory>",
418
+ "set the default directory pattern to import/create components into"
419
+ ],
420
+ [
421
+ "",
422
+ "default-scope <default-scope>",
423
+ "set the default scope for components in the workspace"
424
+ ],
425
+ [
426
+ "f",
427
+ "force",
428
+ "force workspace initialization without clearing local objects"
429
+ ],
430
+ [
431
+ "b",
432
+ "bare [name]",
433
+ "initialize an empty bit bare scope"
434
+ ],
435
+ [
436
+ "s",
437
+ "shared <groupname>",
438
+ "add group write permissions to a scope properly"
439
+ ]
440
+ ],
441
+ "description": "create or reinitialize an empty workspace",
442
+ "extendedDescription": "if the current directory is already a workspace, it validates that bit files are correct and rewrite them if needed.",
443
+ "group": "start",
444
+ "private": false,
445
+ "skipWorkspace": true
446
+ },
442
447
  {
443
448
  "name": "globals",
444
449
  "alias": "",
@@ -2343,6 +2348,11 @@
2343
2348
  "dependencies",
2344
2349
  "import all dependencies (bit components only) of imported components and write them to the workspace"
2345
2350
  ],
2351
+ [
2352
+ "",
2353
+ "dependencies-head",
2354
+ "same as --dependencies, except it imports the dependencies with their head version"
2355
+ ],
2346
2356
  [
2347
2357
  "",
2348
2358
  "dependents",
package/dist/cli-reference.mdx.js CHANGED
@@ -7,10 +7,10 @@ exports["default"] = MDXContent;
7
7
  var _react = _interopRequireDefault(require("react"));
8
8
  var _react2 = require("@mdx-js/react");
9
9
  var _excluded = ["components"]; // @ts-nocheck
10
- function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
11
- function _extends() { _extends = Object.assign ? Object.assign.bind() : function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
12
- function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
13
- function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } } return target; }
10
+ function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
11
+ function _extends() { return _extends = Object.assign ? Object.assign.bind() : function (n) { for (var e = 1; e < arguments.length; e++) { var t = arguments[e]; for (var r in t) ({}).hasOwnProperty.call(t, r) && (n[r] = t[r]); } return n; }, _extends.apply(null, arguments); }
12
+ function _objectWithoutProperties(e, t) { if (null == e) return {}; var o, r, i = _objectWithoutPropertiesLoose(e, t); if (Object.getOwnPropertySymbols) { var n = Object.getOwnPropertySymbols(e); for (r = 0; r < n.length; r++) o = n[r], t.indexOf(o) >= 0 || {}.propertyIsEnumerable.call(e, o) && (i[o] = e[o]); } return i; }
13
+ function _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t = {}; for (var n in r) if ({}.hasOwnProperty.call(r, n)) { if (e.indexOf(n) >= 0) continue; t[n] = r[n]; } return t; }
14
14
  /* @jsxRuntime classic */
15
15
  /* @jsx mdx */
16
16
 
@@ -4555,6 +4555,19 @@ function MDXContent(_ref) {
4555
4555
  "align": null
4556
4556
  }, (0, _react2.mdx)("inlineCode", {
4557
4557
  parentName: "td"
4558
+ }, "--dependencies-head")), (0, _react2.mdx)("td", {
4559
+ parentName: "tr",
4560
+ "align": "center"
4561
+ }), (0, _react2.mdx)("td", {
4562
+ parentName: "tr",
4563
+ "align": null
4564
+ }, "same as --dependencies, except it imports the dependencies with their head version")), (0, _react2.mdx)("tr", {
4565
+ parentName: "tbody"
4566
+ }, (0, _react2.mdx)("td", {
4567
+ parentName: "tr",
4568
+ "align": null
4569
+ }, (0, _react2.mdx)("inlineCode", {
4570
+ parentName: "td"
4558
4571
  }, "--dependents")), (0, _react2.mdx)("td", {
4559
4572
  parentName: "tr",
4560
4573
  "align": "center"
@@ -4725,30 +4738,15 @@ function MDXContent(_ref) {
4725
4738
  "align": null
4726
4739
  }, (0, _react2.mdx)("inlineCode", {
4727
4740
  parentName: "td"
4728
- }, "--bare [name]")), (0, _react2.mdx)("td", {
4741
+ }, "--name <workspace-name>")), (0, _react2.mdx)("td", {
4729
4742
  parentName: "tr",
4730
4743
  "align": "center"
4731
4744
  }, (0, _react2.mdx)("inlineCode", {
4732
4745
  parentName: "td"
4733
- }, "-b")), (0, _react2.mdx)("td", {
4734
- parentName: "tr",
4735
- "align": null
4736
- }, "initialize an empty bit bare scope")), (0, _react2.mdx)("tr", {
4737
- parentName: "tbody"
4738
- }, (0, _react2.mdx)("td", {
4739
- parentName: "tr",
4740
- "align": null
4741
- }, (0, _react2.mdx)("inlineCode", {
4742
- parentName: "td"
4743
- }, "--shared <groupname>")), (0, _react2.mdx)("td", {
4744
- parentName: "tr",
4745
- "align": "center"
4746
- }, (0, _react2.mdx)("inlineCode", {
4747
- parentName: "td"
4748
- }, "-s")), (0, _react2.mdx)("td", {
4746
+ }, "-n")), (0, _react2.mdx)("td", {
4749
4747
  parentName: "tr",
4750
4748
  "align": null
4751
- }, "add group write permissions to a scope properly")), (0, _react2.mdx)("tr", {
4749
+ }, "name of the workspace")), (0, _react2.mdx)("tr", {
4752
4750
  parentName: "tbody"
4753
4751
  }, (0, _react2.mdx)("td", {
4754
4752
  parentName: "tr",
@@ -4886,7 +4884,37 @@ function MDXContent(_ref) {
4886
4884
  }, "-f")), (0, _react2.mdx)("td", {
4887
4885
  parentName: "tr",
4888
4886
  "align": null
4889
- }, "force workspace initialization without clearing local objects")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "install"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
4887
+ }, "force workspace initialization without clearing local objects")), (0, _react2.mdx)("tr", {
4888
+ parentName: "tbody"
4889
+ }, (0, _react2.mdx)("td", {
4890
+ parentName: "tr",
4891
+ "align": null
4892
+ }, (0, _react2.mdx)("inlineCode", {
4893
+ parentName: "td"
4894
+ }, "--bare [name]")), (0, _react2.mdx)("td", {
4895
+ parentName: "tr",
4896
+ "align": "center"
4897
+ }, (0, _react2.mdx)("inlineCode", {
4898
+ parentName: "td"
4899
+ }, "-b")), (0, _react2.mdx)("td", {
4900
+ parentName: "tr",
4901
+ "align": null
4902
+ }, "initialize an empty bit bare scope")), (0, _react2.mdx)("tr", {
4903
+ parentName: "tbody"
4904
+ }, (0, _react2.mdx)("td", {
4905
+ parentName: "tr",
4906
+ "align": null
4907
+ }, (0, _react2.mdx)("inlineCode", {
4908
+ parentName: "td"
4909
+ }, "--shared <groupname>")), (0, _react2.mdx)("td", {
4910
+ parentName: "tr",
4911
+ "align": "center"
4912
+ }, (0, _react2.mdx)("inlineCode", {
4913
+ parentName: "td"
4914
+ }, "-s")), (0, _react2.mdx)("td", {
4915
+ parentName: "tr",
4916
+ "align": null
4917
+ }, "add group write permissions to a scope properly")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "install"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
4890
4918
  parentName: "p"
4891
4919
  }, "Alias"), ": ", (0, _react2.mdx)("inlineCode", {
4892
4920
  parentName: "p"