@teambit/harmony.content.cli-reference 2.0.3 → 2.0.4

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,5 +1,5 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.0.2'
2
+ description: 'Bit command synopses. Bit version: 1.0.3'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
5
5
 
@@ -1921,6 +1921,11 @@
1921
1921
  "",
1922
1922
  "no-optional [noOptional]",
1923
1923
  "do not install optional dependencies (works with pnpm only)"
1924
+ ],
1925
+ [
1926
+ "",
1927
+ "lockfile-only",
1928
+ "dependencies are not written to node_modules. Only the lockfile is updated"
1924
1929
  ]
1925
1930
  ],
1926
1931
  "description": "installs workspace dependencies",
@@ -2471,7 +2476,7 @@
2471
2476
  [
2472
2477
  "b",
2473
2478
  "build",
2474
- "not needed for now. run the pipeline build and complete the tag"
2479
+ "locally run the build pipeline (i.e. not via rippleCI) and complete the tag"
2475
2480
  ],
2476
2481
  [
2477
2482
  "a",
@@ -2522,7 +2527,7 @@
2522
2527
  "snap message describing the latest changes - will appear in component history log"
2523
2528
  ],
2524
2529
  [
2525
- "",
2530
+ "u",
2526
2531
  "unmodified",
2527
2532
  "include unmodified components (by default, only new and modified components are snapped)"
2528
2533
  ],
@@ -2534,7 +2539,7 @@
2534
2539
  [
2535
2540
  "b",
2536
2541
  "build",
2537
- "not needed for now. run the build pipeline locally in case the feature-flag build-on-ci is enabled"
2542
+ "locally run the build pipeline (i.e. not via rippleCI) and complete the snap"
2538
2543
  ],
2539
2544
  [
2540
2545
  "",
@@ -2940,65 +2945,6 @@
2940
2945
  }
2941
2946
  ]
2942
2947
  },
2943
- {
2944
- "name": "log <id>",
2945
- "alias": "",
2946
- "options": [
2947
- [
2948
- "r",
2949
- "remote",
2950
- "show log of a remote component"
2951
- ],
2952
- [
2953
- "",
2954
- "parents",
2955
- "show parents and lanes data"
2956
- ],
2957
- [
2958
- "o",
2959
- "one-line",
2960
- "show each log entry in one line"
2961
- ],
2962
- [
2963
- "j",
2964
- "json",
2965
- "json format"
2966
- ]
2967
- ],
2968
- "description": "show components(s) version history",
2969
- "extendedDescription": "",
2970
- "group": "info",
2971
- "private": false,
2972
- "remoteOp": true,
2973
- "skipWorkspace": true,
2974
- "arguments": [
2975
- {
2976
- "name": "id",
2977
- "description": "component-id or component-name"
2978
- }
2979
- ]
2980
- },
2981
- {
2982
- "name": "log-file <filepath>",
2983
- "alias": "",
2984
- "options": [
2985
- [
2986
- "o",
2987
- "one-line",
2988
- "show each log entry in one line"
2989
- ]
2990
- ],
2991
- "description": "EXPERIMENTAL. show file history",
2992
- "extendedDescription": "",
2993
- "group": "info",
2994
- "private": false,
2995
- "arguments": [
2996
- {
2997
- "name": "filepath",
2998
- "description": "file path relative to the workspace"
2999
- }
3000
- ]
3001
- },
3002
2948
  {
3003
2949
  "name": "test [component-pattern]",
3004
2950
  "alias": "at",
@@ -3016,6 +2962,11 @@
3016
2962
  [
3017
2963
  "a",
3018
2964
  "all",
2965
+ "DEPRECATED. (use --unmodified)"
2966
+ ],
2967
+ [
2968
+ "u",
2969
+ "unmodified",
3019
2970
  "test all components, not only new and modified"
3020
2971
  ],
3021
2972
  [
@@ -3070,6 +3021,65 @@
3070
3021
  "group": "development",
3071
3022
  "private": false
3072
3023
  },
3024
+ {
3025
+ "name": "log <id>",
3026
+ "alias": "",
3027
+ "options": [
3028
+ [
3029
+ "r",
3030
+ "remote",
3031
+ "show log of a remote component"
3032
+ ],
3033
+ [
3034
+ "",
3035
+ "parents",
3036
+ "show parents and lanes data"
3037
+ ],
3038
+ [
3039
+ "o",
3040
+ "one-line",
3041
+ "show each log entry in one line"
3042
+ ],
3043
+ [
3044
+ "j",
3045
+ "json",
3046
+ "json format"
3047
+ ]
3048
+ ],
3049
+ "description": "show components(s) version history",
3050
+ "extendedDescription": "",
3051
+ "group": "info",
3052
+ "private": false,
3053
+ "remoteOp": true,
3054
+ "skipWorkspace": true,
3055
+ "arguments": [
3056
+ {
3057
+ "name": "id",
3058
+ "description": "component-id or component-name"
3059
+ }
3060
+ ]
3061
+ },
3062
+ {
3063
+ "name": "log-file <filepath>",
3064
+ "alias": "",
3065
+ "options": [
3066
+ [
3067
+ "o",
3068
+ "one-line",
3069
+ "show each log entry in one line"
3070
+ ]
3071
+ ],
3072
+ "description": "EXPERIMENTAL. show file history",
3073
+ "extendedDescription": "",
3074
+ "group": "info",
3075
+ "private": false,
3076
+ "arguments": [
3077
+ {
3078
+ "name": "filepath",
3079
+ "description": "file path relative to the workspace"
3080
+ }
3081
+ ]
3082
+ },
3073
3083
  {
3074
3084
  "name": "merge [ids...]",
3075
3085
  "alias": "",
package/cli-reference.mdx CHANGED
@@ -955,6 +955,7 @@ when no package is specified, all workspace dependencies are installed and all w
955
955
  | `--add-missing-peers` | | install all missing peer dependencies |
956
956
  | `--recurring-install` | | automatically run install again if there are non loaded old envs in your workspace |
957
957
  | `--no-optional [noOptional]` | | do not install optional dependencies (works with pnpm only) |
958
+ | `--lockfile-only` | | dependencies are not written to node_modules. Only the lockfile is updated |
958
959
 
959
960
  ---
960
961
 
@@ -1751,9 +1752,9 @@ as a result of this change
1751
1752
  | **Option** | **Option alias** | **Description** |
1752
1753
  | -------------------------- | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1753
1754
  | `--message <message>` | `-m` | snap message describing the latest changes - will appear in component history log |
1754
- | `--unmodified` | | include unmodified components (by default, only new and modified components are snapped) |
1755
+ | `--unmodified` | `-u` | include unmodified components (by default, only new and modified components are snapped) |
1755
1756
  | `--unmerged` | | complete a merge process by snapping the unmerged components |
1756
- | `--build` | `-b` | not needed for now. run the build pipeline locally in case the feature-flag build-on-ci is enabled |
1757
+ | `--build` | `-b` | locally run the build pipeline (i.e. not via rippleCI) and complete the snap |
1757
1758
  | `--editor [editor]` | | open an editor to write a snap message per component. optionally specify the editor-name (defaults to vim). |
1758
1759
  | `--skip-tests` | | skip running component tests during snap process |
1759
1760
  | `--skip-auto-snap` | | skip auto snapping dependents |
@@ -1859,7 +1860,7 @@ if patterns are entered, you can specify a version per pattern using "@" sign, e
1859
1860
  | `--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, MultipleEnvs, MissingLinksFromNodeModulesToSrc, CircularDependencies, DuplicateComponentAndPackage, MergeConfigHasConflict, NonLoadedEnv, ExternalEnvWithoutVersion, RemovedDependencies] to ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify "\*". |
1860
1861
  | `--ignore-newest-version` | `-I` | allow tagging even when the component has newer versions e.g. for hotfixes (default = false) |
1861
1862
  | `--fail-fast` | | stop pipeline execution on the first failed task (by default a task is skipped only when its dependency failed) |
1862
- | `--build` | `-b` | not needed for now. run the pipeline build and complete the tag |
1863
+ | `--build` | `-b` | locally run the build pipeline (i.e. not via rippleCI) and complete the tag |
1863
1864
  | `--all [version]` | `-a` | DEPRECATED (not needed anymore, it is the default now). tag all new and modified components |
1864
1865
  | `--scope [version]` | `-s` | DEPRECATED (use "--unmodified" instead). tag all components of the local scope |
1865
1866
  | `--force` | `-f` | DEPRECATED (use "--skip-tests", "--ignore-build-errors" or "--unmodified" instead). force-tag even if tests are failing and even when component has not changed |
@@ -1896,7 +1897,8 @@ list components templates when inside bit-workspace (for bit-create), otherwise,
1896
1897
  | ---------------------- | :--------------: | --------------------------------------------------------------------------------------- |
1897
1898
  | `--watch` | `-w` | start the tester in watch mode. |
1898
1899
  | `--debug` | `-d` | start the tester in debug mode. |
1899
- | `--all` | `-a` | test all components, not only new and modified |
1900
+ | `--all` | `-a` | DEPRECATED. (use --unmodified) |
1901
+ | `--unmodified` | `-u` | test all components, not only new and modified |
1900
1902
  | `--junit <filepath>` | | write tests results as JUnit XML format into the specified file path |
1901
1903
  | `--coverage` | | show code coverage data |
1902
1904
  | `--env <id>` | `-e` | test only components assigned the given env |
@@ -1,5 +1,5 @@
1
1
  ---
2
- description: 'Bit command synopses. Bit version: 1.0.2'
2
+ description: 'Bit command synopses. Bit version: 1.0.3'
3
3
  labels: ['cli', 'mdx', 'docs']
4
4
  ---
5
5
 
@@ -1921,6 +1921,11 @@
1921
1921
  "",
1922
1922
  "no-optional [noOptional]",
1923
1923
  "do not install optional dependencies (works with pnpm only)"
1924
+ ],
1925
+ [
1926
+ "",
1927
+ "lockfile-only",
1928
+ "dependencies are not written to node_modules. Only the lockfile is updated"
1924
1929
  ]
1925
1930
  ],
1926
1931
  "description": "installs workspace dependencies",
@@ -2471,7 +2476,7 @@
2471
2476
  [
2472
2477
  "b",
2473
2478
  "build",
2474
- "not needed for now. run the pipeline build and complete the tag"
2479
+ "locally run the build pipeline (i.e. not via rippleCI) and complete the tag"
2475
2480
  ],
2476
2481
  [
2477
2482
  "a",
@@ -2522,7 +2527,7 @@
2522
2527
  "snap message describing the latest changes - will appear in component history log"
2523
2528
  ],
2524
2529
  [
2525
- "",
2530
+ "u",
2526
2531
  "unmodified",
2527
2532
  "include unmodified components (by default, only new and modified components are snapped)"
2528
2533
  ],
@@ -2534,7 +2539,7 @@
2534
2539
  [
2535
2540
  "b",
2536
2541
  "build",
2537
- "not needed for now. run the build pipeline locally in case the feature-flag build-on-ci is enabled"
2542
+ "locally run the build pipeline (i.e. not via rippleCI) and complete the snap"
2538
2543
  ],
2539
2544
  [
2540
2545
  "",
@@ -2940,65 +2945,6 @@
2940
2945
  }
2941
2946
  ]
2942
2947
  },
2943
- {
2944
- "name": "log <id>",
2945
- "alias": "",
2946
- "options": [
2947
- [
2948
- "r",
2949
- "remote",
2950
- "show log of a remote component"
2951
- ],
2952
- [
2953
- "",
2954
- "parents",
2955
- "show parents and lanes data"
2956
- ],
2957
- [
2958
- "o",
2959
- "one-line",
2960
- "show each log entry in one line"
2961
- ],
2962
- [
2963
- "j",
2964
- "json",
2965
- "json format"
2966
- ]
2967
- ],
2968
- "description": "show components(s) version history",
2969
- "extendedDescription": "",
2970
- "group": "info",
2971
- "private": false,
2972
- "remoteOp": true,
2973
- "skipWorkspace": true,
2974
- "arguments": [
2975
- {
2976
- "name": "id",
2977
- "description": "component-id or component-name"
2978
- }
2979
- ]
2980
- },
2981
- {
2982
- "name": "log-file <filepath>",
2983
- "alias": "",
2984
- "options": [
2985
- [
2986
- "o",
2987
- "one-line",
2988
- "show each log entry in one line"
2989
- ]
2990
- ],
2991
- "description": "EXPERIMENTAL. show file history",
2992
- "extendedDescription": "",
2993
- "group": "info",
2994
- "private": false,
2995
- "arguments": [
2996
- {
2997
- "name": "filepath",
2998
- "description": "file path relative to the workspace"
2999
- }
3000
- ]
3001
- },
3002
2948
  {
3003
2949
  "name": "test [component-pattern]",
3004
2950
  "alias": "at",
@@ -3016,6 +2962,11 @@
3016
2962
  [
3017
2963
  "a",
3018
2964
  "all",
2965
+ "DEPRECATED. (use --unmodified)"
2966
+ ],
2967
+ [
2968
+ "u",
2969
+ "unmodified",
3019
2970
  "test all components, not only new and modified"
3020
2971
  ],
3021
2972
  [
@@ -3070,6 +3021,65 @@
3070
3021
  "group": "development",
3071
3022
  "private": false
3072
3023
  },
3024
+ {
3025
+ "name": "log <id>",
3026
+ "alias": "",
3027
+ "options": [
3028
+ [
3029
+ "r",
3030
+ "remote",
3031
+ "show log of a remote component"
3032
+ ],
3033
+ [
3034
+ "",
3035
+ "parents",
3036
+ "show parents and lanes data"
3037
+ ],
3038
+ [
3039
+ "o",
3040
+ "one-line",
3041
+ "show each log entry in one line"
3042
+ ],
3043
+ [
3044
+ "j",
3045
+ "json",
3046
+ "json format"
3047
+ ]
3048
+ ],
3049
+ "description": "show components(s) version history",
3050
+ "extendedDescription": "",
3051
+ "group": "info",
3052
+ "private": false,
3053
+ "remoteOp": true,
3054
+ "skipWorkspace": true,
3055
+ "arguments": [
3056
+ {
3057
+ "name": "id",
3058
+ "description": "component-id or component-name"
3059
+ }
3060
+ ]
3061
+ },
3062
+ {
3063
+ "name": "log-file <filepath>",
3064
+ "alias": "",
3065
+ "options": [
3066
+ [
3067
+ "o",
3068
+ "one-line",
3069
+ "show each log entry in one line"
3070
+ ]
3071
+ ],
3072
+ "description": "EXPERIMENTAL. show file history",
3073
+ "extendedDescription": "",
3074
+ "group": "info",
3075
+ "private": false,
3076
+ "arguments": [
3077
+ {
3078
+ "name": "filepath",
3079
+ "description": "file path relative to the workspace"
3080
+ }
3081
+ ]
3082
+ },
3073
3083
  {
3074
3084
  "name": "merge [ids...]",
3075
3085
  "alias": "",
@@ -4676,7 +4676,20 @@ function MDXContent(_ref) {
4676
4676
  }), (0, _react2.mdx)("td", {
4677
4677
  parentName: "tr",
4678
4678
  "align": null
4679
- }, "do not install optional dependencies (works with pnpm only)")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "lane"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
4679
+ }, "do not install optional dependencies (works with pnpm only)")), (0, _react2.mdx)("tr", {
4680
+ parentName: "tbody"
4681
+ }, (0, _react2.mdx)("td", {
4682
+ parentName: "tr",
4683
+ "align": null
4684
+ }, (0, _react2.mdx)("inlineCode", {
4685
+ parentName: "td"
4686
+ }, "--lockfile-only")), (0, _react2.mdx)("td", {
4687
+ parentName: "tr",
4688
+ "align": "center"
4689
+ }), (0, _react2.mdx)("td", {
4690
+ parentName: "tr",
4691
+ "align": null
4692
+ }, "dependencies are not written to node_modules. Only the lockfile is updated")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "lane"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
4680
4693
  parentName: "p"
4681
4694
  }, "Alias"), ": ", (0, _react2.mdx)("inlineCode", {
4682
4695
  parentName: "p"
@@ -8579,7 +8592,9 @@ function MDXContent(_ref) {
8579
8592
  }, "--unmodified")), (0, _react2.mdx)("td", {
8580
8593
  parentName: "tr",
8581
8594
  "align": "center"
8582
- }), (0, _react2.mdx)("td", {
8595
+ }, (0, _react2.mdx)("inlineCode", {
8596
+ parentName: "td"
8597
+ }, "-u")), (0, _react2.mdx)("td", {
8583
8598
  parentName: "tr",
8584
8599
  "align": null
8585
8600
  }, "include unmodified components (by default, only new and modified components are snapped)")), (0, _react2.mdx)("tr", {
@@ -8610,7 +8625,7 @@ function MDXContent(_ref) {
8610
8625
  }, "-b")), (0, _react2.mdx)("td", {
8611
8626
  parentName: "tr",
8612
8627
  "align": null
8613
- }, "not needed for now. run the build pipeline locally in case the feature-flag build-on-ci is enabled")), (0, _react2.mdx)("tr", {
8628
+ }, "locally run the build pipeline (i.e. not via rippleCI) and complete the snap")), (0, _react2.mdx)("tr", {
8614
8629
  parentName: "tbody"
8615
8630
  }, (0, _react2.mdx)("td", {
8616
8631
  parentName: "tr",
@@ -9410,7 +9425,7 @@ function MDXContent(_ref) {
9410
9425
  }, "-b")), (0, _react2.mdx)("td", {
9411
9426
  parentName: "tr",
9412
9427
  "align": null
9413
- }, "not needed for now. run the pipeline build and complete the tag")), (0, _react2.mdx)("tr", {
9428
+ }, "locally run the build pipeline (i.e. not via rippleCI) and complete the tag")), (0, _react2.mdx)("tr", {
9414
9429
  parentName: "tbody"
9415
9430
  }, (0, _react2.mdx)("td", {
9416
9431
  parentName: "tr",
@@ -9627,6 +9642,21 @@ function MDXContent(_ref) {
9627
9642
  }, "-a")), (0, _react2.mdx)("td", {
9628
9643
  parentName: "tr",
9629
9644
  "align": null
9645
+ }, "DEPRECATED. (use --unmodified)")), (0, _react2.mdx)("tr", {
9646
+ parentName: "tbody"
9647
+ }, (0, _react2.mdx)("td", {
9648
+ parentName: "tr",
9649
+ "align": null
9650
+ }, (0, _react2.mdx)("inlineCode", {
9651
+ parentName: "td"
9652
+ }, "--unmodified")), (0, _react2.mdx)("td", {
9653
+ parentName: "tr",
9654
+ "align": "center"
9655
+ }, (0, _react2.mdx)("inlineCode", {
9656
+ parentName: "td"
9657
+ }, "-u")), (0, _react2.mdx)("td", {
9658
+ parentName: "tr",
9659
+ "align": null
9630
9660
  }, "test all components, not only new and modified")), (0, _react2.mdx)("tr", {
9631
9661
  parentName: "tbody"
9632
9662
  }, (0, _react2.mdx)("td", {