@teambit/harmony.content.cli-reference 1.95.47 → 1.95.50

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.json +113 -30
  2. package/cli-reference.mdx +33 -6
  3. package/dist/cli-reference.json +113 -30
  4. package/dist/cli-reference.mdx.js +132 -20
  5. package/dist/cli-reference.mdx.js.map +1 -1
  6. package/package-tar/teambit-harmony.content.cli-reference-1.95.50.tgz +0 -0
  7. package/package.json +2 -2
  8. package/{preview-1659065375106.js → preview-1659670139925.js} +2 -2
  9. package/package-tar/teambit-harmony.content.cli-reference-1.95.47.tgz +0 -0
package/cli-reference.json CHANGED
@@ -223,26 +223,6 @@
223
223
  "group": "info",
224
224
  "private": false
225
225
  },
226
- {
227
- "name": "dependencies <component-name>",
228
- "alias": "",
229
- "options": [
230
- [
231
- "t",
232
- "tree",
233
- "render dependencies as a tree, similar to \"npm ls\""
234
- ],
235
- [
236
- "d",
237
- "debug",
238
- "show the immediate dependencies and how their version was determined"
239
- ]
240
- ],
241
- "description": "EXPERIMENTAL. show direct and indirect dependencies of the given component",
242
- "extendedDescription": "",
243
- "group": "info",
244
- "private": false
245
- },
246
226
  {
247
227
  "name": "_log <path> <args>",
248
228
  "alias": "",
@@ -859,6 +839,53 @@
859
839
  "group": "general",
860
840
  "private": false
861
841
  },
842
+ {
843
+ "name": "dependencies <sub-command>",
844
+ "alias": "deps",
845
+ "options": [],
846
+ "description": "manage dependencies",
847
+ "extendedDescription": "",
848
+ "group": "info",
849
+ "private": false,
850
+ "commands": [
851
+ {
852
+ "name": "get <component-name>",
853
+ "alias": "",
854
+ "options": [
855
+ [
856
+ "t",
857
+ "tree",
858
+ "EXPERIMENTAL. render dependencies as a tree, similar to \"npm ls\""
859
+ ]
860
+ ],
861
+ "description": "show direct and indirect dependencies of the given component",
862
+ "extendedDescription": "",
863
+ "group": "info",
864
+ "private": false,
865
+ "arguments": [
866
+ {
867
+ "name": "component-name",
868
+ "description": "component name or component id"
869
+ }
870
+ ]
871
+ },
872
+ {
873
+ "name": "debug <component-name>",
874
+ "alias": "",
875
+ "options": [],
876
+ "description": "show the immediate dependencies and how their versions were determined",
877
+ "extendedDescription": "",
878
+ "group": "info",
879
+ "private": false,
880
+ "arguments": [
881
+ {
882
+ "name": "component-name",
883
+ "description": "component name or component id"
884
+ }
885
+ ]
886
+ }
887
+ ]
888
+ },
862
889
  {
863
890
  "name": "show <component-name>",
864
891
  "alias": "",
@@ -1938,6 +1965,11 @@
1938
1965
  "snapped",
1939
1966
  "EXPERIMENTAL. tag components that their head is a snap (not a tag)"
1940
1967
  ],
1968
+ [
1969
+ "",
1970
+ "unmerged",
1971
+ "EXPERIMENTAL. complete a merge process by tagging the unmerged components"
1972
+ ],
1941
1973
  [
1942
1974
  "",
1943
1975
  "skip-tests",
@@ -2041,6 +2073,11 @@
2041
2073
  "unmodified",
2042
2074
  "include unmodified components (by default, only new and modified components are snapped)"
2043
2075
  ],
2076
+ [
2077
+ "",
2078
+ "unmerged",
2079
+ "EXPERIMENTAL. complete a merge process by snapping the unmerged components"
2080
+ ],
2044
2081
  [
2045
2082
  "",
2046
2083
  "build",
@@ -2262,6 +2299,11 @@
2262
2299
  "",
2263
2300
  "skip-watch",
2264
2301
  "avoid running the watch process that compiles components in the background"
2302
+ ],
2303
+ [
2304
+ "",
2305
+ "ssr",
2306
+ "run app in server side rendering mode."
2265
2307
  ]
2266
2308
  ],
2267
2309
  "description": "run an app (independent of bit's dev server)",
@@ -2313,6 +2355,42 @@
2313
2355
  "extendedDescription": "",
2314
2356
  "group": "apps",
2315
2357
  "private": false
2358
+ },
2359
+ {
2360
+ "name": "run <app-name>",
2361
+ "alias": "c",
2362
+ "options": [
2363
+ [
2364
+ "d",
2365
+ "dev",
2366
+ "start the application in dev mode."
2367
+ ],
2368
+ [
2369
+ "v",
2370
+ "verbose",
2371
+ "showing verbose output for inspection and prints stack trace"
2372
+ ],
2373
+ [
2374
+ "",
2375
+ "skip-watch",
2376
+ "avoid running the watch process that compiles components in the background"
2377
+ ],
2378
+ [
2379
+ "",
2380
+ "ssr",
2381
+ "run app in server side rendering mode."
2382
+ ]
2383
+ ],
2384
+ "description": "run an app (independent of bit's dev server)",
2385
+ "extendedDescription": "",
2386
+ "group": "apps",
2387
+ "private": false,
2388
+ "arguments": [
2389
+ {
2390
+ "name": "app-name",
2391
+ "description": "the app's name is registered by the app (run 'bit app list' to list the names of the available apps)"
2392
+ }
2393
+ ]
2316
2394
  }
2317
2395
  ]
2318
2396
  },
@@ -2857,7 +2935,7 @@
2857
2935
  ]
2858
2936
  },
2859
2937
  {
2860
- "name": "merge <lane>",
2938
+ "name": "merge <lane> [pattern]",
2861
2939
  "alias": "",
2862
2940
  "options": [
2863
2941
  [
@@ -2882,8 +2960,8 @@
2882
2960
  ],
2883
2961
  [
2884
2962
  "",
2885
- "existing",
2886
- "checkout only components in a lane that exist in the workspace"
2963
+ "workspace",
2964
+ "merge only components in a lane that exist in the workspace"
2887
2965
  ],
2888
2966
  [
2889
2967
  "",
@@ -2910,22 +2988,27 @@
2910
2988
  "squash",
2911
2989
  "EXPERIMENTAL. squash multiple snaps. keep the last one only"
2912
2990
  ],
2913
- [
2914
- "",
2915
- "pattern <component-pattern>",
2916
- "EXPERIMENTAL. partially merge the lane with the specified component-pattern"
2917
- ],
2918
2991
  [
2919
2992
  "",
2920
2993
  "include-deps",
2921
- "EXPERIMENTAL. relevant for \"--pattern\" and \"--existing\". merge also dependencies of the given components"
2994
+ "EXPERIMENTAL. relevant for \"--pattern\" and \"--workspace\". merge also dependencies of the given components"
2922
2995
  ]
2923
2996
  ],
2924
2997
  "description": "merge a local or a remote lane",
2925
2998
  "extendedDescription": "",
2926
2999
  "group": "ungrouped",
2927
3000
  "private": true,
2928
- "remoteOp": true
3001
+ "remoteOp": true,
3002
+ "arguments": [
3003
+ {
3004
+ "name": "lane",
3005
+ "description": "lane-name to merge to the current lane"
3006
+ },
3007
+ {
3008
+ "name": "pattern",
3009
+ "description": "EXPERIMENTAL. partially merge the lane with the specified component-pattern"
3010
+ }
3011
+ ]
2929
3012
  },
2930
3013
  {
2931
3014
  "name": "remove <lanes...>",
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
@@ -356,15 +369,27 @@ https://bit.dev/docs/config/bit-config
356
369
 
357
370
  ## dependencies
358
371
 
372
+ **Alias**: `deps`
359
373
  **Workspace only**: yes
360
- **Description**: EXPERIMENTAL. show direct and indirect dependencies of the given component
374
+ **Description**: manage dependencies
375
+
376
+ `bit dependencies <sub-command>`
377
+
378
+ ### dependencies get
379
+
380
+ **Usage**: `dependencies get <component-name>`
381
+
382
+ **Description**: show direct and indirect dependencies of the given component
383
+
384
+ | **Option** | **Option alias** | **Description** |
385
+ | ---------- | :--------------: | ---------------------------------------------------------------- |
386
+ | `--tree` | `-t` | EXPERIMENTAL. render dependencies as a tree, similar to "npm ls" |
387
+
388
+ ### dependencies debug
361
389
 
362
- `bit dependencies <component-name>`
390
+ **Usage**: `dependencies debug <component-name>`
363
391
 
364
- | **Option** | **Option alias** | **Description** |
365
- | ---------- | :--------------: | -------------------------------------------------------------------- |
366
- | `--tree` | `-t` | render dependencies as a tree, similar to "npm ls" |
367
- | `--debug` | `-d` | show the immediate dependencies and how their version was determined |
392
+ **Description**: show the immediate dependencies and how their versions were determined
368
393
 
369
394
  ---
370
395
 
@@ -979,6 +1004,7 @@ https://bit.dev/docs/components/tags#undoing-a-tag
979
1004
  | `--dev` | `-d` | start the application in dev mode. |
980
1005
  | `--verbose` | `-v` | showing verbose output for inspection and prints stack trace |
981
1006
  | `--skip-watch` | | avoid running the watch process that compiles components in the background |
1007
+ | `--ssr` | | run app in server side rendering mode. |
982
1008
 
983
1009
  ---
984
1010
 
@@ -1143,6 +1169,7 @@ if patterns are entered, you can specify a version per pattern using "@" sign, e
1143
1169
  | `--major` | | syntactic sugar for "--increment major" |
1144
1170
  | `--pre-release [identifier]` | | syntactic sugar for "--increment prerelease" and `--prerelease-id <identifier>` |
1145
1171
  | `--snapped` | | EXPERIMENTAL. tag components that their head is a snap (not a tag) |
1172
+ | `--unmerged` | | EXPERIMENTAL. complete a merge process by tagging the unmerged components |
1146
1173
  | `--skip-tests` | | skip running component tests during tag process |
1147
1174
  | `--skip-auto-tag` | | skip auto tagging dependents |
1148
1175
  | `--soft` | | do not persist. only keep note of the changes to be made |
package/dist/cli-reference.json CHANGED
@@ -223,26 +223,6 @@
223
223
  "group": "info",
224
224
  "private": false
225
225
  },
226
- {
227
- "name": "dependencies <component-name>",
228
- "alias": "",
229
- "options": [
230
- [
231
- "t",
232
- "tree",
233
- "render dependencies as a tree, similar to \"npm ls\""
234
- ],
235
- [
236
- "d",
237
- "debug",
238
- "show the immediate dependencies and how their version was determined"
239
- ]
240
- ],
241
- "description": "EXPERIMENTAL. show direct and indirect dependencies of the given component",
242
- "extendedDescription": "",
243
- "group": "info",
244
- "private": false
245
- },
246
226
  {
247
227
  "name": "_log <path> <args>",
248
228
  "alias": "",
@@ -859,6 +839,53 @@
859
839
  "group": "general",
860
840
  "private": false
861
841
  },
842
+ {
843
+ "name": "dependencies <sub-command>",
844
+ "alias": "deps",
845
+ "options": [],
846
+ "description": "manage dependencies",
847
+ "extendedDescription": "",
848
+ "group": "info",
849
+ "private": false,
850
+ "commands": [
851
+ {
852
+ "name": "get <component-name>",
853
+ "alias": "",
854
+ "options": [
855
+ [
856
+ "t",
857
+ "tree",
858
+ "EXPERIMENTAL. render dependencies as a tree, similar to \"npm ls\""
859
+ ]
860
+ ],
861
+ "description": "show direct and indirect dependencies of the given component",
862
+ "extendedDescription": "",
863
+ "group": "info",
864
+ "private": false,
865
+ "arguments": [
866
+ {
867
+ "name": "component-name",
868
+ "description": "component name or component id"
869
+ }
870
+ ]
871
+ },
872
+ {
873
+ "name": "debug <component-name>",
874
+ "alias": "",
875
+ "options": [],
876
+ "description": "show the immediate dependencies and how their versions were determined",
877
+ "extendedDescription": "",
878
+ "group": "info",
879
+ "private": false,
880
+ "arguments": [
881
+ {
882
+ "name": "component-name",
883
+ "description": "component name or component id"
884
+ }
885
+ ]
886
+ }
887
+ ]
888
+ },
862
889
  {
863
890
  "name": "show <component-name>",
864
891
  "alias": "",
@@ -1938,6 +1965,11 @@
1938
1965
  "snapped",
1939
1966
  "EXPERIMENTAL. tag components that their head is a snap (not a tag)"
1940
1967
  ],
1968
+ [
1969
+ "",
1970
+ "unmerged",
1971
+ "EXPERIMENTAL. complete a merge process by tagging the unmerged components"
1972
+ ],
1941
1973
  [
1942
1974
  "",
1943
1975
  "skip-tests",
@@ -2041,6 +2073,11 @@
2041
2073
  "unmodified",
2042
2074
  "include unmodified components (by default, only new and modified components are snapped)"
2043
2075
  ],
2076
+ [
2077
+ "",
2078
+ "unmerged",
2079
+ "EXPERIMENTAL. complete a merge process by snapping the unmerged components"
2080
+ ],
2044
2081
  [
2045
2082
  "",
2046
2083
  "build",
@@ -2262,6 +2299,11 @@
2262
2299
  "",
2263
2300
  "skip-watch",
2264
2301
  "avoid running the watch process that compiles components in the background"
2302
+ ],
2303
+ [
2304
+ "",
2305
+ "ssr",
2306
+ "run app in server side rendering mode."
2265
2307
  ]
2266
2308
  ],
2267
2309
  "description": "run an app (independent of bit's dev server)",
@@ -2313,6 +2355,42 @@
2313
2355
  "extendedDescription": "",
2314
2356
  "group": "apps",
2315
2357
  "private": false
2358
+ },
2359
+ {
2360
+ "name": "run <app-name>",
2361
+ "alias": "c",
2362
+ "options": [
2363
+ [
2364
+ "d",
2365
+ "dev",
2366
+ "start the application in dev mode."
2367
+ ],
2368
+ [
2369
+ "v",
2370
+ "verbose",
2371
+ "showing verbose output for inspection and prints stack trace"
2372
+ ],
2373
+ [
2374
+ "",
2375
+ "skip-watch",
2376
+ "avoid running the watch process that compiles components in the background"
2377
+ ],
2378
+ [
2379
+ "",
2380
+ "ssr",
2381
+ "run app in server side rendering mode."
2382
+ ]
2383
+ ],
2384
+ "description": "run an app (independent of bit's dev server)",
2385
+ "extendedDescription": "",
2386
+ "group": "apps",
2387
+ "private": false,
2388
+ "arguments": [
2389
+ {
2390
+ "name": "app-name",
2391
+ "description": "the app's name is registered by the app (run 'bit app list' to list the names of the available apps)"
2392
+ }
2393
+ ]
2316
2394
  }
2317
2395
  ]
2318
2396
  },
@@ -2857,7 +2935,7 @@
2857
2935
  ]
2858
2936
  },
2859
2937
  {
2860
- "name": "merge <lane>",
2938
+ "name": "merge <lane> [pattern]",
2861
2939
  "alias": "",
2862
2940
  "options": [
2863
2941
  [
@@ -2882,8 +2960,8 @@
2882
2960
  ],
2883
2961
  [
2884
2962
  "",
2885
- "existing",
2886
- "checkout only components in a lane that exist in the workspace"
2963
+ "workspace",
2964
+ "merge only components in a lane that exist in the workspace"
2887
2965
  ],
2888
2966
  [
2889
2967
  "",
@@ -2910,22 +2988,27 @@
2910
2988
  "squash",
2911
2989
  "EXPERIMENTAL. squash multiple snaps. keep the last one only"
2912
2990
  ],
2913
- [
2914
- "",
2915
- "pattern <component-pattern>",
2916
- "EXPERIMENTAL. partially merge the lane with the specified component-pattern"
2917
- ],
2918
2991
  [
2919
2992
  "",
2920
2993
  "include-deps",
2921
- "EXPERIMENTAL. relevant for \"--pattern\" and \"--existing\". merge also dependencies of the given components"
2994
+ "EXPERIMENTAL. relevant for \"--pattern\" and \"--workspace\". merge also dependencies of the given components"
2922
2995
  ]
2923
2996
  ],
2924
2997
  "description": "merge a local or a remote lane",
2925
2998
  "extendedDescription": "",
2926
2999
  "group": "ungrouped",
2927
3000
  "private": true,
2928
- "remoteOp": true
3001
+ "remoteOp": true,
3002
+ "arguments": [
3003
+ {
3004
+ "name": "lane",
3005
+ "description": "lane-name to merge to the current lane"
3006
+ },
3007
+ {
3008
+ "name": "pattern",
3009
+ "description": "EXPERIMENTAL. partially merge the lane with the specified component-pattern"
3010
+ }
3011
+ ]
2929
3012
  },
2930
3013
  {
2931
3014
  "name": "remove <lanes...>",