@teambit/harmony.content.cli-reference 1.95.149 → 1.95.151

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.
@@ -1256,25 +1256,6 @@
1256
1256
  "group": "development",
1257
1257
  "private": false
1258
1258
  },
1259
- {
1260
- "name": "move <current-component-dir> <new-component-dir>",
1261
- "alias": "mv",
1262
- "options": [],
1263
- "description": "move a component to a different filesystem path",
1264
- "extendedDescription": "move files or directories of component(s)\n https://bit.dev/docs/workspace/moving-components",
1265
- "group": "development",
1266
- "private": false,
1267
- "arguments": [
1268
- {
1269
- "name": "current-component-dir",
1270
- "description": "the current relative path (in the workspace) to the component directory"
1271
- },
1272
- {
1273
- "name": "new-component-dir",
1274
- "description": "the new relative path (in the workspace) to the component directory"
1275
- }
1276
- ]
1277
- },
1278
1259
  {
1279
1260
  "name": "add [path...]",
1280
1261
  "alias": "a",
@@ -1315,21 +1296,6 @@
1315
1296
  "group": "development",
1316
1297
  "private": false
1317
1298
  },
1318
- {
1319
- "name": "server",
1320
- "alias": "",
1321
- "options": [
1322
- [
1323
- "p",
1324
- "port [port]",
1325
- "port to run the server on"
1326
- ]
1327
- ],
1328
- "description": "EXPERIMENTAL. communicate with bit cli program via http requests",
1329
- "extendedDescription": "",
1330
- "group": "general",
1331
- "private": false
1332
- },
1333
1299
  {
1334
1300
  "name": "create <template-name> <component-names...>",
1335
1301
  "alias": "",
@@ -1516,6 +1482,11 @@
1516
1482
  "",
1517
1483
  "skip-tests",
1518
1484
  "skip running component tests during tag process"
1485
+ ],
1486
+ [
1487
+ "",
1488
+ "fail-fast",
1489
+ "stop pipeline execution on the first failed task (by default a task is skipped only when its dependent failed)"
1519
1490
  ]
1520
1491
  ],
1521
1492
  "description": "run set of tasks for build",
@@ -1565,42 +1536,6 @@
1565
1536
  }
1566
1537
  ]
1567
1538
  },
1568
- {
1569
- "name": "compile [component-names...]",
1570
- "alias": "",
1571
- "options": [
1572
- [
1573
- "c",
1574
- "changed",
1575
- "compile only new and modified components"
1576
- ],
1577
- [
1578
- "v",
1579
- "verbose",
1580
- "show more data, such as, dist paths"
1581
- ],
1582
- [
1583
- "j",
1584
- "json",
1585
- "return the compile results in json format"
1586
- ],
1587
- [
1588
- "d",
1589
- "delete-dist-dir",
1590
- "delete existing dist folder before writing new compiled files"
1591
- ]
1592
- ],
1593
- "description": "compile components in the workspace",
1594
- "extendedDescription": "",
1595
- "group": "development",
1596
- "private": false,
1597
- "arguments": [
1598
- {
1599
- "name": "component-names...",
1600
- "description": "a list of component names or component IDs (defaults to all components)"
1601
- }
1602
- ]
1603
- },
1604
1539
  {
1605
1540
  "name": "run <app-name>",
1606
1541
  "alias": "c",
@@ -1729,6 +1664,42 @@
1729
1664
  "group": "development",
1730
1665
  "private": true
1731
1666
  },
1667
+ {
1668
+ "name": "compile [component-names...]",
1669
+ "alias": "",
1670
+ "options": [
1671
+ [
1672
+ "c",
1673
+ "changed",
1674
+ "compile only new and modified components"
1675
+ ],
1676
+ [
1677
+ "v",
1678
+ "verbose",
1679
+ "show more data, such as, dist paths"
1680
+ ],
1681
+ [
1682
+ "j",
1683
+ "json",
1684
+ "return the compile results in json format"
1685
+ ],
1686
+ [
1687
+ "d",
1688
+ "delete-dist-dir",
1689
+ "delete existing dist folder before writing new compiled files"
1690
+ ]
1691
+ ],
1692
+ "description": "compile components in the workspace",
1693
+ "extendedDescription": "",
1694
+ "group": "development",
1695
+ "private": false,
1696
+ "arguments": [
1697
+ {
1698
+ "name": "component-names...",
1699
+ "description": "a list of component names or component IDs (defaults to all components)"
1700
+ }
1701
+ ]
1702
+ },
1732
1703
  {
1733
1704
  "name": "install [packages...]",
1734
1705
  "alias": "in",
@@ -1865,6 +1836,25 @@
1865
1836
  }
1866
1837
  ]
1867
1838
  },
1839
+ {
1840
+ "name": "move <current-component-dir> <new-component-dir>",
1841
+ "alias": "mv",
1842
+ "options": [],
1843
+ "description": "move a component to a different filesystem path",
1844
+ "extendedDescription": "move files or directories of component(s)\n https://bit.dev/docs/workspace/moving-components",
1845
+ "group": "development",
1846
+ "private": false,
1847
+ "arguments": [
1848
+ {
1849
+ "name": "current-component-dir",
1850
+ "description": "the current relative path (in the workspace) to the component directory"
1851
+ },
1852
+ {
1853
+ "name": "new-component-dir",
1854
+ "description": "the new relative path (in the workspace) to the component directory"
1855
+ }
1856
+ ]
1857
+ },
1868
1858
  {
1869
1859
  "name": "import [component-patterns...]",
1870
1860
  "alias": "",
@@ -2065,71 +2055,6 @@
2065
2055
  "group": "collaborate",
2066
2056
  "private": false
2067
2057
  },
2068
- {
2069
- "name": "checkout <to> [component-pattern]",
2070
- "alias": "U",
2071
- "options": [
2072
- [
2073
- "i",
2074
- "interactive-merge",
2075
- "when a component is modified and the merge process found conflicts, display options to resolve them"
2076
- ],
2077
- [
2078
- "o",
2079
- "ours",
2080
- "in case of a conflict, override the used version with the current modification"
2081
- ],
2082
- [
2083
- "t",
2084
- "theirs",
2085
- "in case of a conflict, override the current modification with the specified version"
2086
- ],
2087
- [
2088
- "m",
2089
- "manual",
2090
- "in case of a conflict, leave the files with a conflict state to resolve them manually later"
2091
- ],
2092
- [
2093
- "r",
2094
- "reset",
2095
- "revert changes that were not snapped/tagged"
2096
- ],
2097
- [
2098
- "a",
2099
- "all",
2100
- "all components"
2101
- ],
2102
- [
2103
- "e",
2104
- "workspace-only",
2105
- "when on a lane, avoid introducing new components from the remote lane that do not exist locally"
2106
- ],
2107
- [
2108
- "v",
2109
- "verbose",
2110
- "showing verbose output for inspection"
2111
- ],
2112
- [
2113
- "x",
2114
- "skip-dependency-installation",
2115
- "do not install packages of the imported components"
2116
- ]
2117
- ],
2118
- "description": "switch between component versions or remove local changes",
2119
- "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)",
2120
- "group": "development",
2121
- "private": false,
2122
- "arguments": [
2123
- {
2124
- "name": "to",
2125
- "description": "permitted values: [head, latest, reset, specific-version]. 'head' - last snap/tag. 'latest' - semver latest tag. 'reset' - removes local changes"
2126
- },
2127
- {
2128
- "name": "component-pattern",
2129
- "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"
2130
- }
2131
- ]
2132
- },
2133
2058
  {
2134
2059
  "name": "resume-export <export-id> <remotes...>",
2135
2060
  "alias": "",
@@ -2326,6 +2251,11 @@
2326
2251
  "ignore-newest-version",
2327
2252
  "ignore existing of newer versions (default = false)"
2328
2253
  ],
2254
+ [
2255
+ "",
2256
+ "fail-fast",
2257
+ "stop pipeline execution on the first failed task (by default a task is skipped only when its dependent failed)"
2258
+ ],
2329
2259
  [
2330
2260
  "b",
2331
2261
  "build",
@@ -2429,6 +2359,11 @@
2429
2359
  "all",
2430
2360
  "DEPRECATED (not needed anymore, it is the default now). snap all new and modified components"
2431
2361
  ],
2362
+ [
2363
+ "",
2364
+ "fail-fast",
2365
+ "stop pipeline execution on the first failed task (by default a task is skipped only when its dependent failed)"
2366
+ ],
2432
2367
  [
2433
2368
  "f",
2434
2369
  "force",
@@ -2627,6 +2562,137 @@
2627
2562
  "group": "ungrouped",
2628
2563
  "private": true
2629
2564
  },
2565
+ {
2566
+ "name": "checkout <to> [component-pattern]",
2567
+ "alias": "U",
2568
+ "options": [
2569
+ [
2570
+ "i",
2571
+ "interactive-merge",
2572
+ "when a component is modified and the merge process found conflicts, display options to resolve them"
2573
+ ],
2574
+ [
2575
+ "o",
2576
+ "ours",
2577
+ "in case of a conflict, override the used version with the current modification"
2578
+ ],
2579
+ [
2580
+ "t",
2581
+ "theirs",
2582
+ "in case of a conflict, override the current modification with the specified version"
2583
+ ],
2584
+ [
2585
+ "m",
2586
+ "manual",
2587
+ "in case of a conflict, leave the files with a conflict state to resolve them manually later"
2588
+ ],
2589
+ [
2590
+ "r",
2591
+ "reset",
2592
+ "revert changes that were not snapped/tagged"
2593
+ ],
2594
+ [
2595
+ "a",
2596
+ "all",
2597
+ "all components"
2598
+ ],
2599
+ [
2600
+ "e",
2601
+ "workspace-only",
2602
+ "when on a lane, avoid introducing new components from the remote lane that do not exist locally"
2603
+ ],
2604
+ [
2605
+ "v",
2606
+ "verbose",
2607
+ "showing verbose output for inspection"
2608
+ ],
2609
+ [
2610
+ "x",
2611
+ "skip-dependency-installation",
2612
+ "do not install packages of the imported components"
2613
+ ]
2614
+ ],
2615
+ "description": "switch between component versions or remove local changes",
2616
+ "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)",
2617
+ "group": "development",
2618
+ "private": false,
2619
+ "arguments": [
2620
+ {
2621
+ "name": "to",
2622
+ "description": "permitted values: [head, latest, reset, specific-version]. 'head' - last snap/tag. 'latest' - semver latest tag. 'reset' - removes local changes"
2623
+ },
2624
+ {
2625
+ "name": "component-pattern",
2626
+ "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"
2627
+ }
2628
+ ]
2629
+ },
2630
+ {
2631
+ "name": "stash [sub-command]",
2632
+ "alias": "",
2633
+ "options": [
2634
+ [
2635
+ "p",
2636
+ "pattern",
2637
+ "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"
2638
+ ],
2639
+ [
2640
+ "m",
2641
+ "message <string>",
2642
+ "message to be attached to the stashed components"
2643
+ ]
2644
+ ],
2645
+ "description": "EXPERIMENTAL (more like a POC). stash modified components",
2646
+ "extendedDescription": "",
2647
+ "group": "development",
2648
+ "private": true,
2649
+ "commands": [
2650
+ {
2651
+ "name": "save",
2652
+ "alias": "",
2653
+ "options": [
2654
+ [
2655
+ "p",
2656
+ "pattern",
2657
+ "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"
2658
+ ],
2659
+ [
2660
+ "m",
2661
+ "message <string>",
2662
+ "message to be attached to the stashed components"
2663
+ ]
2664
+ ],
2665
+ "description": "stash modified components",
2666
+ "extendedDescription": "",
2667
+ "group": "development",
2668
+ "private": false
2669
+ },
2670
+ {
2671
+ "name": "load",
2672
+ "alias": "",
2673
+ "options": [],
2674
+ "description": "load latest stash, checkout components and delete stash",
2675
+ "extendedDescription": "",
2676
+ "group": "development",
2677
+ "private": false
2678
+ }
2679
+ ]
2680
+ },
2681
+ {
2682
+ "name": "server",
2683
+ "alias": "",
2684
+ "options": [
2685
+ [
2686
+ "p",
2687
+ "port [port]",
2688
+ "port to run the server on"
2689
+ ]
2690
+ ],
2691
+ "description": "EXPERIMENTAL. communicate with bit cli program via http requests",
2692
+ "extendedDescription": "",
2693
+ "group": "general",
2694
+ "private": false
2695
+ },
2630
2696
  {
2631
2697
  "name": "merge [ids...]",
2632
2698
  "alias": "",
@@ -2818,8 +2884,8 @@
2818
2884
  ],
2819
2885
  [
2820
2886
  "r",
2821
- "remote <string>",
2822
- "show remote lanes"
2887
+ "remote",
2888
+ "show the lane from remote"
2823
2889
  ]
2824
2890
  ],
2825
2891
  "description": "show lane details. if no lane specified, show the current lane",
@@ -3043,7 +3109,12 @@
3043
3109
  [
3044
3110
  "",
3045
3111
  "no-squash",
3046
- "EXPERIMENTAL. relevant for merging lanes into main, which by default squash."
3112
+ "relevant for merging lanes into main, which by default squash"
3113
+ ],
3114
+ [
3115
+ "",
3116
+ "squash",
3117
+ "EXPERIMENTAL. relevant for merging a lane into another lane, which by default does not squash"
3047
3118
  ],
3048
3119
  [
3049
3120
  "",
package/cli-reference.mdx CHANGED
@@ -154,6 +154,7 @@ and a package.tgz file generated by pkg aspect.
154
154
  | `--cache-packages-on-capsule-root` | | set the package-manager cache on the capsule root |
155
155
  | `--list-tasks <string>` | | list tasks of an env or a component-id for each one of the pipelines: build, tag and snap |
156
156
  | `--skip-tests` | | skip running component tests during tag process |
157
+ | `--fail-fast` | | stop pipeline execution on the first failed task (by default a task is skipped only when its dependent failed) |
157
158
 
158
159
  ---
159
160
 
@@ -789,10 +790,10 @@ when no package is specified, all workspace dependencies are installed and all w
789
790
 
790
791
  **Description**: show lane details. if no lane specified, show the current lane
791
792
 
792
- | **Option** | **Option alias** | **Description** |
793
- | ------------------- | :--------------: | ------------------------------------ |
794
- | `--json` | `-j` | show the lane details in json format |
795
- | `--remote <string>` | `-r` | show remote lanes |
793
+ | **Option** | **Option alias** | **Description** |
794
+ | ---------- | :--------------: | ------------------------------------ |
795
+ | `--json` | `-j` | show the lane details in json format |
796
+ | `--remote` | `-r` | show the lane from remote |
796
797
 
797
798
  ### lane create
798
799
 
@@ -898,7 +899,8 @@ it will snap-merge these components to complete the merge. use "no-snap" to opt-
898
899
  | `--build` | | in case of snap during the merge, run the build-pipeline (similar to bit snap --build) |
899
900
  | `--message <message>` | `-m` | override the default message for the auto snap |
900
901
  | `--keep-readme` | | skip deleting the lane readme component after merging |
901
- | `--no-squash` | | EXPERIMENTAL. relevant for merging lanes into main, which by default squash. |
902
+ | `--no-squash` | | relevant for merging lanes into main, which by default squash |
903
+ | `--squash` | | EXPERIMENTAL. relevant for merging a lane into another lane, which by default does not squash |
902
904
  | `--ignore-config-changes` | | allow merging when component are modified due to config changes (such as dependencies) only and not files |
903
905
  | `--verbose` | | show details of components that were not merged legitimately |
904
906
  | `--skip-dependency-installation` | `-x` | do not install packages of the imported components |
@@ -1365,6 +1367,7 @@ use `bit pattern --help` to understand patterns better and `bit pattern <pattern
1365
1367
  | `--force-deploy` | | run the deploy pipeline although the build failed |
1366
1368
  | `--ignore-issues [issues]` | `-i` | ignore component issues (shown in "bit status" as "issues found"), issues to ignore: [MissingPackagesDependenciesOnFs, MissingManuallyConfiguredPackages, MissingComponents, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, CustomModuleResolutionUsed, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies, DuplicateComponentAndPackage, MergeConfigHasConflict] to ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify "\*". |
1367
1369
  | `--all` | `-a` | DEPRECATED (not needed anymore, it is the default now). snap all new and modified components |
1370
+ | `--fail-fast` | | stop pipeline execution on the first failed task (by default a task is skipped only when its dependent failed) |
1368
1371
  | `--force` | `-f` | DEPRECATED (use "--skip-tests" or "--unmodified" instead). force-snap even if tests are failing and even when component has not changed |
1369
1372
 
1370
1373
  ---
@@ -1451,6 +1454,7 @@ if patterns are entered, you can specify a version per pattern using "@" sign, e
1451
1454
  | `--increment-by <number>` | | (default to 1) increment semver flag (patch/minor/major) by. e.g. incrementing patch by 2: 0.0.1 -> 0.0.3. |
1452
1455
  | `--ignore-issues [issues]` | `-i` | ignore component issues (shown in "bit status" as "issues found"), issues to ignore: [MissingPackagesDependenciesOnFs, MissingManuallyConfiguredPackages, MissingComponents, UntrackedDependencies, ResolveErrors, RelativeComponents, RelativeComponentsAuthored, ParseErrors, MissingDists, LegacyInsideHarmony, MissingDependenciesOnFs, ImportNonMainFiles, CustomModuleResolutionUsed, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies, DuplicateComponentAndPackage, MergeConfigHasConflict] to ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify "\*". |
1453
1456
  | `--ignore-newest-version` | `-I` | ignore existing of newer versions (default = false) |
1457
+ | `--fail-fast` | | stop pipeline execution on the first failed task (by default a task is skipped only when its dependent failed) |
1454
1458
  | `--build` | `-b` | EXPERIMENTAL. not needed for now. run the pipeline build and complete the tag |
1455
1459
  | `--all [version]` | `-a` | DEPRECATED (not needed anymore, it is the default now). tag all new and modified components |
1456
1460
  | `--scope [version]` | `-s` | DEPRECATED (use "--unmodified" instead). tag all components of the current scope |