@teambit/harmony.content.cli-reference 1.95.46 → 1.95.49

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.
@@ -1938,6 +1938,11 @@
1938
1938
  "snapped",
1939
1939
  "EXPERIMENTAL. tag components that their head is a snap (not a tag)"
1940
1940
  ],
1941
+ [
1942
+ "",
1943
+ "unmerged",
1944
+ "EXPERIMENTAL. complete a merge process by tagging the unmerged components"
1945
+ ],
1941
1946
  [
1942
1947
  "",
1943
1948
  "skip-tests",
@@ -2041,6 +2046,11 @@
2041
2046
  "unmodified",
2042
2047
  "include unmodified components (by default, only new and modified components are snapped)"
2043
2048
  ],
2049
+ [
2050
+ "",
2051
+ "unmerged",
2052
+ "EXPERIMENTAL. complete a merge process by snapping the unmerged components"
2053
+ ],
2044
2054
  [
2045
2055
  "",
2046
2056
  "build",
@@ -2262,6 +2272,11 @@
2262
2272
  "",
2263
2273
  "skip-watch",
2264
2274
  "avoid running the watch process that compiles components in the background"
2275
+ ],
2276
+ [
2277
+ "",
2278
+ "ssr",
2279
+ "run app in server side rendering mode."
2265
2280
  ]
2266
2281
  ],
2267
2282
  "description": "run an app (independent of bit's dev server)",
@@ -2313,6 +2328,42 @@
2313
2328
  "extendedDescription": "",
2314
2329
  "group": "apps",
2315
2330
  "private": false
2331
+ },
2332
+ {
2333
+ "name": "run <app-name>",
2334
+ "alias": "c",
2335
+ "options": [
2336
+ [
2337
+ "d",
2338
+ "dev",
2339
+ "start the application in dev mode."
2340
+ ],
2341
+ [
2342
+ "v",
2343
+ "verbose",
2344
+ "showing verbose output for inspection and prints stack trace"
2345
+ ],
2346
+ [
2347
+ "",
2348
+ "skip-watch",
2349
+ "avoid running the watch process that compiles components in the background"
2350
+ ],
2351
+ [
2352
+ "",
2353
+ "ssr",
2354
+ "run app in server side rendering mode."
2355
+ ]
2356
+ ],
2357
+ "description": "run an app (independent of bit's dev server)",
2358
+ "extendedDescription": "",
2359
+ "group": "apps",
2360
+ "private": false,
2361
+ "arguments": [
2362
+ {
2363
+ "name": "app-name",
2364
+ "description": "the app's name is registered by the app (run 'bit app list' to list the names of the available apps)"
2365
+ }
2366
+ ]
2316
2367
  }
2317
2368
  ]
2318
2369
  },
@@ -2857,7 +2908,7 @@
2857
2908
  ]
2858
2909
  },
2859
2910
  {
2860
- "name": "merge <lane>",
2911
+ "name": "merge <lane> [pattern]",
2861
2912
  "alias": "",
2862
2913
  "options": [
2863
2914
  [
@@ -2882,8 +2933,8 @@
2882
2933
  ],
2883
2934
  [
2884
2935
  "",
2885
- "existing",
2886
- "checkout only components in a lane that exist in the workspace"
2936
+ "workspace",
2937
+ "merge only components in a lane that exist in the workspace"
2887
2938
  ],
2888
2939
  [
2889
2940
  "",
@@ -2910,22 +2961,27 @@
2910
2961
  "squash",
2911
2962
  "EXPERIMENTAL. squash multiple snaps. keep the last one only"
2912
2963
  ],
2913
- [
2914
- "",
2915
- "pattern <component-pattern>",
2916
- "EXPERIMENTAL. partially merge the lane with the specified component-pattern"
2917
- ],
2918
2964
  [
2919
2965
  "",
2920
2966
  "include-deps",
2921
- "EXPERIMENTAL. relevant for \"--pattern\" and \"--existing\". merge also dependencies of the given components"
2967
+ "EXPERIMENTAL. relevant for \"--pattern\" and \"--workspace\". merge also dependencies of the given components"
2922
2968
  ]
2923
2969
  ],
2924
2970
  "description": "merge a local or a remote lane",
2925
2971
  "extendedDescription": "",
2926
2972
  "group": "ungrouped",
2927
2973
  "private": true,
2928
- "remoteOp": true
2974
+ "remoteOp": true,
2975
+ "arguments": [
2976
+ {
2977
+ "name": "lane",
2978
+ "description": "lane-name to merge to the current lane"
2979
+ },
2980
+ {
2981
+ "name": "pattern",
2982
+ "description": "EXPERIMENTAL. partially merge the lane with the specified component-pattern"
2983
+ }
2984
+ ]
2929
2985
  },
2930
2986
  {
2931
2987
  "name": "remove <lanes...>",
@@ -2988,7 +3044,13 @@
2988
3044
  {
2989
3045
  "name": "diff [values...]",
2990
3046
  "alias": "",
2991
- "options": [],
3047
+ "options": [
3048
+ [
3049
+ "",
3050
+ "pattern <component-pattern>",
3051
+ "EXPERIMENTAL. show lane-diff for the specified component-pattern only"
3052
+ ]
3053
+ ],
2992
3054
  "description": "show diff between lanes",
2993
3055
  "extendedDescription": "bit lane diff => diff between the current lane and default lane. (only inside workspace).\nbit lane diff to => diff between the current lane (or default-lane when in scope) and \"to\" lane.\nbit lane diff from to => diff between \"from\" lane and \"to\" lane.",
2994
3056
  "group": "ungrouped",
package/cli-reference.mdx CHANGED
@@ -39,6 +39,19 @@ all flags support glob patterns and {PARENT} {FILE_NAME} annotations
39
39
  | ---------- | :--------------: | ---------------------------------------- |
40
40
  | `--json` | `-j` | return the component data in json format |
41
41
 
42
+ ### app run
43
+
44
+ **Usage**: `app run <app-name>`
45
+
46
+ **Description**: run an app (independent of bit's dev server)
47
+
48
+ | **Option** | **Option alias** | **Description** |
49
+ | -------------- | :--------------: | -------------------------------------------------------------------------- |
50
+ | `--dev` | `-d` | start the application in dev mode. |
51
+ | `--verbose` | `-v` | showing verbose output for inspection and prints stack trace |
52
+ | `--skip-watch` | | avoid running the watch process that compiles components in the background |
53
+ | `--ssr` | | run app in server side rendering mode. |
54
+
42
55
  ---
43
56
 
44
57
  ## artifacts
@@ -979,6 +992,7 @@ https://bit.dev/docs/components/tags#undoing-a-tag
979
992
  | `--dev` | `-d` | start the application in dev mode. |
980
993
  | `--verbose` | `-v` | showing verbose output for inspection and prints stack trace |
981
994
  | `--skip-watch` | | avoid running the watch process that compiles components in the background |
995
+ | `--ssr` | | run app in server side rendering mode. |
982
996
 
983
997
  ---
984
998
 
@@ -1143,6 +1157,7 @@ if patterns are entered, you can specify a version per pattern using "@" sign, e
1143
1157
  | `--major` | | syntactic sugar for "--increment major" |
1144
1158
  | `--pre-release [identifier]` | | syntactic sugar for "--increment prerelease" and `--prerelease-id <identifier>` |
1145
1159
  | `--snapped` | | EXPERIMENTAL. tag components that their head is a snap (not a tag) |
1160
+ | `--unmerged` | | EXPERIMENTAL. complete a merge process by tagging the unmerged components |
1146
1161
  | `--skip-tests` | | skip running component tests during tag process |
1147
1162
  | `--skip-auto-tag` | | skip auto tagging dependents |
1148
1163
  | `--soft` | | do not persist. only keep note of the changes to be made |
@@ -1938,6 +1938,11 @@
1938
1938
  "snapped",
1939
1939
  "EXPERIMENTAL. tag components that their head is a snap (not a tag)"
1940
1940
  ],
1941
+ [
1942
+ "",
1943
+ "unmerged",
1944
+ "EXPERIMENTAL. complete a merge process by tagging the unmerged components"
1945
+ ],
1941
1946
  [
1942
1947
  "",
1943
1948
  "skip-tests",
@@ -2041,6 +2046,11 @@
2041
2046
  "unmodified",
2042
2047
  "include unmodified components (by default, only new and modified components are snapped)"
2043
2048
  ],
2049
+ [
2050
+ "",
2051
+ "unmerged",
2052
+ "EXPERIMENTAL. complete a merge process by snapping the unmerged components"
2053
+ ],
2044
2054
  [
2045
2055
  "",
2046
2056
  "build",
@@ -2262,6 +2272,11 @@
2262
2272
  "",
2263
2273
  "skip-watch",
2264
2274
  "avoid running the watch process that compiles components in the background"
2275
+ ],
2276
+ [
2277
+ "",
2278
+ "ssr",
2279
+ "run app in server side rendering mode."
2265
2280
  ]
2266
2281
  ],
2267
2282
  "description": "run an app (independent of bit's dev server)",
@@ -2313,6 +2328,42 @@
2313
2328
  "extendedDescription": "",
2314
2329
  "group": "apps",
2315
2330
  "private": false
2331
+ },
2332
+ {
2333
+ "name": "run <app-name>",
2334
+ "alias": "c",
2335
+ "options": [
2336
+ [
2337
+ "d",
2338
+ "dev",
2339
+ "start the application in dev mode."
2340
+ ],
2341
+ [
2342
+ "v",
2343
+ "verbose",
2344
+ "showing verbose output for inspection and prints stack trace"
2345
+ ],
2346
+ [
2347
+ "",
2348
+ "skip-watch",
2349
+ "avoid running the watch process that compiles components in the background"
2350
+ ],
2351
+ [
2352
+ "",
2353
+ "ssr",
2354
+ "run app in server side rendering mode."
2355
+ ]
2356
+ ],
2357
+ "description": "run an app (independent of bit's dev server)",
2358
+ "extendedDescription": "",
2359
+ "group": "apps",
2360
+ "private": false,
2361
+ "arguments": [
2362
+ {
2363
+ "name": "app-name",
2364
+ "description": "the app's name is registered by the app (run 'bit app list' to list the names of the available apps)"
2365
+ }
2366
+ ]
2316
2367
  }
2317
2368
  ]
2318
2369
  },
@@ -2857,7 +2908,7 @@
2857
2908
  ]
2858
2909
  },
2859
2910
  {
2860
- "name": "merge <lane>",
2911
+ "name": "merge <lane> [pattern]",
2861
2912
  "alias": "",
2862
2913
  "options": [
2863
2914
  [
@@ -2882,8 +2933,8 @@
2882
2933
  ],
2883
2934
  [
2884
2935
  "",
2885
- "existing",
2886
- "checkout only components in a lane that exist in the workspace"
2936
+ "workspace",
2937
+ "merge only components in a lane that exist in the workspace"
2887
2938
  ],
2888
2939
  [
2889
2940
  "",
@@ -2910,22 +2961,27 @@
2910
2961
  "squash",
2911
2962
  "EXPERIMENTAL. squash multiple snaps. keep the last one only"
2912
2963
  ],
2913
- [
2914
- "",
2915
- "pattern <component-pattern>",
2916
- "EXPERIMENTAL. partially merge the lane with the specified component-pattern"
2917
- ],
2918
2964
  [
2919
2965
  "",
2920
2966
  "include-deps",
2921
- "EXPERIMENTAL. relevant for \"--pattern\" and \"--existing\". merge also dependencies of the given components"
2967
+ "EXPERIMENTAL. relevant for \"--pattern\" and \"--workspace\". merge also dependencies of the given components"
2922
2968
  ]
2923
2969
  ],
2924
2970
  "description": "merge a local or a remote lane",
2925
2971
  "extendedDescription": "",
2926
2972
  "group": "ungrouped",
2927
2973
  "private": true,
2928
- "remoteOp": true
2974
+ "remoteOp": true,
2975
+ "arguments": [
2976
+ {
2977
+ "name": "lane",
2978
+ "description": "lane-name to merge to the current lane"
2979
+ },
2980
+ {
2981
+ "name": "pattern",
2982
+ "description": "EXPERIMENTAL. partially merge the lane with the specified component-pattern"
2983
+ }
2984
+ ]
2929
2985
  },
2930
2986
  {
2931
2987
  "name": "remove <lanes...>",
@@ -2988,7 +3044,13 @@
2988
3044
  {
2989
3045
  "name": "diff [values...]",
2990
3046
  "alias": "",
2991
- "options": [],
3047
+ "options": [
3048
+ [
3049
+ "",
3050
+ "pattern <component-pattern>",
3051
+ "EXPERIMENTAL. show lane-diff for the specified component-pattern only"
3052
+ ]
3053
+ ],
2992
3054
  "description": "show diff between lanes",
2993
3055
  "extendedDescription": "bit lane diff => diff between the current lane and default lane. (only inside workspace).\nbit lane diff to => diff between the current lane (or default-lane when in scope) and \"to\" lane.\nbit lane diff from to => diff between \"from\" lane and \"to\" lane.",
2994
3056
  "group": "ungrouped",
@@ -13,7 +13,7 @@ var _excluded = ["components"];
13
13
 
14
14
  function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
15
15
 
16
- 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); }
16
+ function _extends() { _extends = Object.assign || 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); }
17
17
 
18
18
  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; }
19
19
 
@@ -199,7 +199,90 @@ function MDXContent(_ref) {
199
199
  }, "-j")), (0, _react2.mdx)("td", {
200
200
  parentName: "tr",
201
201
  "align": null
202
- }, "return the component data in json format")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "artifacts"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
202
+ }, "return the component data in json format")))), (0, _react2.mdx)("h3", null, "app run"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
203
+ parentName: "p"
204
+ }, "Usage"), ": ", (0, _react2.mdx)("inlineCode", {
205
+ parentName: "p"
206
+ }, "app run <app-name>")), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
207
+ parentName: "p"
208
+ }, "Description"), ": run an app (independent of bit's dev server)"), (0, _react2.mdx)("table", null, (0, _react2.mdx)("thead", {
209
+ parentName: "table"
210
+ }, (0, _react2.mdx)("tr", {
211
+ parentName: "thead"
212
+ }, (0, _react2.mdx)("th", {
213
+ parentName: "tr",
214
+ "align": null
215
+ }, (0, _react2.mdx)("strong", {
216
+ parentName: "th"
217
+ }, "Option")), (0, _react2.mdx)("th", {
218
+ parentName: "tr",
219
+ "align": "center"
220
+ }, (0, _react2.mdx)("strong", {
221
+ parentName: "th"
222
+ }, "Option alias")), (0, _react2.mdx)("th", {
223
+ parentName: "tr",
224
+ "align": null
225
+ }, (0, _react2.mdx)("strong", {
226
+ parentName: "th"
227
+ }, "Description")))), (0, _react2.mdx)("tbody", {
228
+ parentName: "table"
229
+ }, (0, _react2.mdx)("tr", {
230
+ parentName: "tbody"
231
+ }, (0, _react2.mdx)("td", {
232
+ parentName: "tr",
233
+ "align": null
234
+ }, (0, _react2.mdx)("inlineCode", {
235
+ parentName: "td"
236
+ }, "--dev")), (0, _react2.mdx)("td", {
237
+ parentName: "tr",
238
+ "align": "center"
239
+ }, (0, _react2.mdx)("inlineCode", {
240
+ parentName: "td"
241
+ }, "-d")), (0, _react2.mdx)("td", {
242
+ parentName: "tr",
243
+ "align": null
244
+ }, "start the application in dev mode.")), (0, _react2.mdx)("tr", {
245
+ parentName: "tbody"
246
+ }, (0, _react2.mdx)("td", {
247
+ parentName: "tr",
248
+ "align": null
249
+ }, (0, _react2.mdx)("inlineCode", {
250
+ parentName: "td"
251
+ }, "--verbose")), (0, _react2.mdx)("td", {
252
+ parentName: "tr",
253
+ "align": "center"
254
+ }, (0, _react2.mdx)("inlineCode", {
255
+ parentName: "td"
256
+ }, "-v")), (0, _react2.mdx)("td", {
257
+ parentName: "tr",
258
+ "align": null
259
+ }, "showing verbose output for inspection and prints stack trace")), (0, _react2.mdx)("tr", {
260
+ parentName: "tbody"
261
+ }, (0, _react2.mdx)("td", {
262
+ parentName: "tr",
263
+ "align": null
264
+ }, (0, _react2.mdx)("inlineCode", {
265
+ parentName: "td"
266
+ }, "--skip-watch")), (0, _react2.mdx)("td", {
267
+ parentName: "tr",
268
+ "align": "center"
269
+ }), (0, _react2.mdx)("td", {
270
+ parentName: "tr",
271
+ "align": null
272
+ }, "avoid running the watch process that compiles components in the background")), (0, _react2.mdx)("tr", {
273
+ parentName: "tbody"
274
+ }, (0, _react2.mdx)("td", {
275
+ parentName: "tr",
276
+ "align": null
277
+ }, (0, _react2.mdx)("inlineCode", {
278
+ parentName: "td"
279
+ }, "--ssr")), (0, _react2.mdx)("td", {
280
+ parentName: "tr",
281
+ "align": "center"
282
+ }), (0, _react2.mdx)("td", {
283
+ parentName: "tr",
284
+ "align": null
285
+ }, "run app in server side rendering mode.")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "artifacts"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
203
286
  parentName: "p"
204
287
  }, "Workspace only"), ": yes", (0, _react2.mdx)("br", {
205
288
  parentName: "p"
@@ -4461,7 +4544,20 @@ function MDXContent(_ref) {
4461
4544
  }), (0, _react2.mdx)("td", {
4462
4545
  parentName: "tr",
4463
4546
  "align": null
4464
- }, "avoid running the watch process that compiles components in the background")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "schema"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
4547
+ }, "avoid running the watch process that compiles components in the background")), (0, _react2.mdx)("tr", {
4548
+ parentName: "tbody"
4549
+ }, (0, _react2.mdx)("td", {
4550
+ parentName: "tr",
4551
+ "align": null
4552
+ }, (0, _react2.mdx)("inlineCode", {
4553
+ parentName: "td"
4554
+ }, "--ssr")), (0, _react2.mdx)("td", {
4555
+ parentName: "tr",
4556
+ "align": "center"
4557
+ }), (0, _react2.mdx)("td", {
4558
+ parentName: "tr",
4559
+ "align": null
4560
+ }, "run app in server side rendering mode.")))), (0, _react2.mdx)("hr", null), (0, _react2.mdx)("h2", null, "schema"), (0, _react2.mdx)("p", null, (0, _react2.mdx)("strong", {
4465
4561
  parentName: "p"
4466
4562
  }, "Workspace only"), ": yes", (0, _react2.mdx)("br", {
4467
4563
  parentName: "p"
@@ -5119,6 +5215,19 @@ function MDXContent(_ref) {
5119
5215
  "align": null
5120
5216
  }, (0, _react2.mdx)("inlineCode", {
5121
5217
  parentName: "td"
5218
+ }, "--unmerged")), (0, _react2.mdx)("td", {
5219
+ parentName: "tr",
5220
+ "align": "center"
5221
+ }), (0, _react2.mdx)("td", {
5222
+ parentName: "tr",
5223
+ "align": null
5224
+ }, "EXPERIMENTAL. complete a merge process by tagging the unmerged components")), (0, _react2.mdx)("tr", {
5225
+ parentName: "tbody"
5226
+ }, (0, _react2.mdx)("td", {
5227
+ parentName: "tr",
5228
+ "align": null
5229
+ }, (0, _react2.mdx)("inlineCode", {
5230
+ parentName: "td"
5122
5231
  }, "--skip-tests")), (0, _react2.mdx)("td", {
5123
5232
  parentName: "tr",
5124
5233
  "align": "center"