/
npm-usage.js.test.cjs
981 lines (629 loc) · 33.2 KB
/
npm-usage.js.test.cjs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
/* IMPORTANT
* This snapshot file is auto-generated, but designed for humans.
* It should be checked into source control and tracked carefully.
* Re-generate by setting TAP_SNAPSHOT=1 and running tests.
* Make sure to inspect the output below. Do not ignore changes!
*/
'use strict'
exports[`test/lib/utils/npm-usage.js TAP usage basic usage > must match snapshot 1`] = `
npm <command>
Usage:
npm install install all the dependencies in your project
npm install <foo> add the <foo> dependency to your project
npm test run this project's tests
npm run <foo> run the script named <foo>
npm <command> -h quick help on <command>
npm -l display usage info for all commands
npm help <term> search for help on <term>
npm help npm more involved overview
All commands:
access, adduser, audit, bin, bugs, cache, ci, completion,
config, dedupe, deprecate, diff, dist-tag, docs, doctor,
edit, exec, explain, explore, find-dupes, fund, get, help,
hook, init, install, install-ci-test, install-test, link,
ll, login, logout, ls, org, outdated, owner, pack, ping,
prefix, profile, prune, publish, rebuild, repo, restart,
root, run-script, search, set, set-script, shrinkwrap, star,
stars, start, stop, team, test, token, uninstall, unpublish,
unstar, update, version, view, whoami
Specify configs in the ini-formatted file:
/some/config/file/.npmrc
or on the command line via: npm <command> --key=value
More configuration info: npm help config
Configuration fields: npm help 7 config
npm@{VERSION} {BASEDIR}
`
exports[`test/lib/utils/npm-usage.js TAP usage set process.stdout.columns columns=0 > must match snapshot 1`] = `
npm <command>
Usage:
npm install install all the dependencies in your project
npm install <foo> add the <foo> dependency to your project
npm test run this project's tests
npm run <foo> run the script named <foo>
npm <command> -h quick help on <command>
npm -l display usage info for all commands
npm help <term> search for help on <term>
npm help npm more involved overview
All commands:
access, adduser, audit, bin, bugs, cache, ci, completion,
config, dedupe, deprecate, diff, dist-tag, docs, doctor,
edit, exec, explain, explore, find-dupes, fund, get, help,
hook, init, install, install-ci-test, install-test, link,
ll, login, logout, ls, org, outdated, owner, pack, ping,
prefix, profile, prune, publish, rebuild, repo, restart,
root, run-script, search, set, set-script, shrinkwrap, star,
stars, start, stop, team, test, token, uninstall, unpublish,
unstar, update, version, view, whoami
Specify configs in the ini-formatted file:
/some/config/file/.npmrc
or on the command line via: npm <command> --key=value
More configuration info: npm help config
Configuration fields: npm help 7 config
npm@{VERSION} {BASEDIR}
`
exports[`test/lib/utils/npm-usage.js TAP usage set process.stdout.columns columns=90 > must match snapshot 1`] = `
npm <command>
Usage:
npm install install all the dependencies in your project
npm install <foo> add the <foo> dependency to your project
npm test run this project's tests
npm run <foo> run the script named <foo>
npm <command> -h quick help on <command>
npm -l display usage info for all commands
npm help <term> search for help on <term>
npm help npm more involved overview
All commands:
access, adduser, audit, bin, bugs, cache, ci, completion,
config, dedupe, deprecate, diff, dist-tag, docs, doctor,
edit, exec, explain, explore, find-dupes, fund, get, help,
hook, init, install, install-ci-test, install-test, link,
ll, login, logout, ls, org, outdated, owner, pack, ping,
prefix, profile, prune, publish, rebuild, repo, restart,
root, run-script, search, set, set-script, shrinkwrap, star,
stars, start, stop, team, test, token, uninstall, unpublish,
unstar, update, version, view, whoami
Specify configs in the ini-formatted file:
/some/config/file/.npmrc
or on the command line via: npm <command> --key=value
More configuration info: npm help config
Configuration fields: npm help 7 config
npm@{VERSION} {BASEDIR}
`
exports[`test/lib/utils/npm-usage.js TAP usage with browser > must match snapshot 1`] = `
npm <command>
Usage:
npm install install all the dependencies in your project
npm install <foo> add the <foo> dependency to your project
npm test run this project's tests
npm run <foo> run the script named <foo>
npm <command> -h quick help on <command>
npm -l display usage info for all commands
npm help <term> search for help on <term> (in a browser)
npm help npm more involved overview (in a browser)
All commands:
access, adduser, audit, bin, bugs, cache, ci, completion,
config, dedupe, deprecate, diff, dist-tag, docs, doctor,
edit, exec, explain, explore, find-dupes, fund, get, help,
hook, init, install, install-ci-test, install-test, link,
ll, login, logout, ls, org, outdated, owner, pack, ping,
prefix, profile, prune, publish, rebuild, repo, restart,
root, run-script, search, set, set-script, shrinkwrap, star,
stars, start, stop, team, test, token, uninstall, unpublish,
unstar, update, version, view, whoami
Specify configs in the ini-formatted file:
/some/config/file/.npmrc
or on the command line via: npm <command> --key=value
More configuration info: npm help config
Configuration fields: npm help 7 config
npm@{VERSION} {BASEDIR}
`
exports[`test/lib/utils/npm-usage.js TAP usage with long > must match snapshot 1`] = `
npm <command>
Usage:
npm install install all the dependencies in your project
npm install <foo> add the <foo> dependency to your project
npm test run this project's tests
npm run <foo> run the script named <foo>
npm <command> -h quick help on <command>
npm -l display usage info for all commands
npm help <term> search for help on <term>
npm help npm more involved overview
All commands:
access npm access
Set access level on published packages
Usage:
npm access public [<package>]
npm access restricted [<package>]
npm access grant <read-only|read-write> <scope:team> [<package>]
npm access revoke <scope:team> [<package>]
npm access 2fa-required [<package>]
npm access 2fa-not-required [<package>]
npm access ls-packages [<user>|<scope>|<scope:team>]
npm access ls-collaborators [<package> [<user>]]
npm access edit [<package>]
Run "npm help access" for more info
adduser npm adduser
Add a registry user account
Usage:
npm adduser
Options:
[--registry <registry>] [--scope <@scope>]
aliases: login, add-user
Run "npm help adduser" for more info
audit npm audit
Run a security audit
Usage:
npm audit [fix]
Options:
[--audit-level <info|low|moderate|high|critical|none>] [--dry-run] [-f|--force]
[--json] [--package-lock-only] [--production]
Run "npm help audit" for more info
bin npm bin
Display npm bin folder
Usage:
npm bin
Options:
[-g|--global]
Run "npm help bin" for more info
bugs npm bugs
Report bugs for a package in a web browser
Usage:
npm bugs [<pkgname>]
alias: issues
Run "npm help bugs" for more info
cache npm cache
Manipulates packages cache
Usage:
npm cache add <tarball file>
npm cache add <folder>
npm cache add <tarball url>
npm cache add <git url>
npm cache add <name>@<version>
npm cache clean
npm cache verify
Run "npm help cache" for more info
ci npm ci
Install a project with a clean slate
Usage:
npm ci
aliases: clean-install, ic, install-clean, isntall-clean
Run "npm help ci" for more info
completion npm completion
Tab Completion for npm
Usage:
npm completion
Run "npm help completion" for more info
config npm config
Manage the npm configuration files
Usage:
npm config set <key>=<value> [<key>=<value> ...]
npm config get [<key> [<key> ...]]
npm config delete <key> [<key> ...]
npm config list [--json]
npm config edit
alias: c
Run "npm help config" for more info
dedupe npm dedupe
Reduce duplication in the package tree
Usage:
npm dedupe
alias: ddp
Run "npm help dedupe" for more info
deprecate npm deprecate
Deprecate a version of a package
Usage:
npm deprecate <pkg>[@<version>] <message>
Run "npm help deprecate" for more info
diff npm diff
The registry diff command
Usage:
npm diff [...<paths>]
npm diff --diff=<pkg-name> [...<paths>]
npm diff --diff=<version-a> [--diff=<version-b>] [...<paths>]
npm diff --diff=<spec-a> [--diff=<spec-b>] [...<paths>]
npm diff [--diff-ignore-all-space] [--diff-name-only] [...<paths>] [...<paths>]
Run "npm help diff" for more info
dist-tag npm dist-tag
Modify package distribution tags
Usage:
npm dist-tag add <pkg>@<version> [<tag>]
npm dist-tag rm <pkg> <tag>
npm dist-tag ls [<pkg>]
Options:
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
[-ws|--workspaces]
alias: dist-tags
Run "npm help dist-tag" for more info
docs npm docs
Open documentation for a package in a web browser
Usage:
npm docs [<pkgname> [<pkgname> ...]]
Options:
[--browser|--browser <browser>] [--registry <registry>]
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
[-ws|--workspaces]
alias: home
Run "npm help docs" for more info
doctor npm doctor
Check your npm environment
Usage:
npm doctor
Run "npm help doctor" for more info
edit npm edit
Edit an installed package
Usage:
npm edit <pkg>[/<subpkg>...]
Run "npm help edit" for more info
exec npm exec
Run a command from a local or remote npm package
Usage:
npm exec -- <pkg>[@<version>] [args...]
npm exec --package=<pkg>[@<version>] -- <cmd> [args...]
npm exec -c '<cmd> [args...]'
npm exec --package=foo -c '<cmd> [args...]'
Options:
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
[-ws|--workspaces]
alias: x
Run "npm help exec" for more info
explain npm explain
Explain installed packages
Usage:
npm explain <folder | specifier>
alias: why
Run "npm help explain" for more info
explore npm explore
Browse an installed package
Usage:
npm explore <pkg> [ -- <command>]
Run "npm help explore" for more info
find-dupes npm find-dupes
Find duplication in the package tree
Usage:
npm find-dupes
Run "npm help find-dupes" for more info
fund npm fund
Retrieve funding information
Usage:
npm fund [[<@scope>/]<pkg>]
Options:
[--json] [--browser|--browser <browser>] [--unicode]
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
[--which <fundingSourceNumber>]
Run "npm help fund" for more info
get npm get
Get a value from the npm configuration
Usage:
npm get [<key> ...] (See \`npm config\`)
Run "npm help get" for more info
help npm help
Get help on npm
Usage:
npm help <term> [<terms..>]
alias: hlep
Run "npm help help" for more info
hook npm hook
Manage registry hooks
Usage:
npm hook add <pkg> <url> <secret> [--type=<type>]
npm hook ls [pkg]
npm hook rm <id>
npm hook update <id> <url> <secret>
Run "npm help hook" for more info
init npm init
Create a package.json file
Usage:
npm init [--force|-f|--yes|-y|--scope]
npm init <@scope> (same as \`npx <@scope>/create\`)
npm init [<@scope>/]<name> (same as \`npx [<@scope>/]create-<name>\`)
Options:
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
[-ws|--workspaces]
aliases: create, innit
Run "npm help init" for more info
install npm install
Install a package
Usage:
npm install [<@scope>/]<pkg>
npm install [<@scope>/]<pkg>@<tag>
npm install [<@scope>/]<pkg>@<version>
npm install [<@scope>/]<pkg>@<version range>
npm install <alias>@npm:<name>
npm install <folder>
npm install <tarball file>
npm install <tarball url>
npm install <git:// url>
npm install <github username>/<github project>
Options:
[-S|--save|--no-save|--save-prod|--save-dev|--save-optional|--save-peer]
[-E|--save-exact]
aliases: i, in, ins, inst, insta, instal, isnt, isnta, isntal, add
Run "npm help install" for more info
install-ci-test npm install-ci-test
Install a project with a clean slate and run tests
Usage:
npm install-ci-test
alias: cit
Run "npm help install-ci-test" for more info
install-test npm install-test
Install package(s) and run tests
Usage:
npm install-test [<@scope>/]<pkg>
npm install-test [<@scope>/]<pkg>@<tag>
npm install-test [<@scope>/]<pkg>@<version>
npm install-test [<@scope>/]<pkg>@<version range>
npm install-test <alias>@npm:<name>
npm install-test <folder>
npm install-test <tarball file>
npm install-test <tarball url>
npm install-test <git:// url>
npm install-test <github username>/<github project>
Options:
[-S|--save|--no-save|--save-prod|--save-dev|--save-optional|--save-peer]
[-E|--save-exact]
alias: it
Run "npm help install-test" for more info
link npm link
Symlink a package folder
Usage:
npm link (in package dir)
npm link [<@scope>/]<pkg>[@<version>]
alias: ln
Run "npm help link" for more info
ll npm ll
List installed packages
Usage:
npm ll [[<@scope>/]<pkg> ...]
alias: la
Run "npm help ll" for more info
login npm adduser
Add a registry user account
Usage:
npm adduser
Options:
[--registry <registry>] [--scope <@scope>]
aliases: login, add-user
Run "npm help adduser" for more info
logout npm logout
Log out of the registry
Usage:
npm logout
Options:
[--registry <registry>] [--scope <@scope>]
Run "npm help logout" for more info
ls npm ls
List installed packages
Usage:
npm ls npm ls [[<@scope>/]<pkg> ...]
alias: list
Run "npm help ls" for more info
org npm org
Manage orgs
Usage:
npm org set orgname username [developer | admin | owner]
npm org rm orgname username
npm org ls orgname [<username>]
alias: ogr
Run "npm help org" for more info
outdated npm outdated
Check for outdated packages
Usage:
npm outdated [[<@scope>/]<pkg> ...]
Run "npm help outdated" for more info
owner npm owner
Manage package owners
Usage:
npm owner add <user> [<@scope>/]<pkg>
npm owner rm <user> [<@scope>/]<pkg>
npm owner ls [<@scope>/]<pkg>
alias: author
Run "npm help owner" for more info
pack npm pack
Create a tarball from a package
Usage:
npm pack [[<@scope>/]<pkg>...]
Options:
[--dry-run]
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
[-ws|--workspaces]
Run "npm help pack" for more info
ping npm ping
Ping npm registry
Usage:
npm ping
Options:
[--registry <registry>]
Run "npm help ping" for more info
prefix npm prefix
Display prefix
Usage:
npm prefix [-g]
Run "npm help prefix" for more info
profile npm profile
Change settings on your registry profile
Usage:
npm profile enable-2fa [auth-only|auth-and-writes]
npm profile disable-2fa
npm profile get [<key>]
npm profile set <key> <value>
Run "npm help profile" for more info
prune npm prune
Remove extraneous packages
Usage:
npm prune [[<@scope>/]<pkg>...]
Options:
[--production]
Run "npm help prune" for more info
publish npm publish
Publish a package
Usage:
npm publish [<folder>]
Options:
[--tag <tag>] [--access <restricted|public>] [--dry-run]
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
[-ws|--workspaces]
Run "npm help publish" for more info
rebuild npm rebuild
Rebuild a package
Usage:
npm rebuild [[<@scope>/]<name>[@<version>] ...]
alias: rb
Run "npm help rebuild" for more info
repo npm repo
Open package repository page in the browser
Usage:
npm repo [<pkgname> [<pkgname> ...]]
Options:
[--browser|--browser <browser>]
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
[-ws|--workspaces]
Run "npm help repo" for more info
restart npm restart
Restart a package
Usage:
npm restart [-- <args>]
Run "npm help restart" for more info
root npm root
Display npm root
Usage:
npm root
Options:
[-g|--global]
Run "npm help root" for more info
run-script npm run-script
Run arbitrary package scripts
Usage:
npm run-script <command> [-- <args>]
Options:
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
[-ws|--workspaces]
aliases: run, rum, urn
Run "npm help run-script" for more info
search npm search
Search for pacakges
Usage:
npm search [search terms ...]
Options:
[-l|--long] [--json] [-p|--parseable] [--no-description]
aliases: s, se, find
Run "npm help search" for more info
set npm set
Set a value in the npm configuration
Usage:
npm set <key>=<value> [<key>=<value> ...] (See \`npm config\`)
Run "npm help set" for more info
set-script npm set-script
Set tasks in the scripts section of package.json
Usage:
npm set-script [<script>] [<command>]
Options:
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
[-ws|--workspaces]
Run "npm help set-script" for more info
shrinkwrap npm shrinkwrap
Lock down dependency versions for publication
Usage:
npm shrinkwrap
Run "npm help shrinkwrap" for more info
star npm star
Mark your favorite packages
Usage:
npm star [<pkg>...]
Run "npm help star" for more info
stars npm stars
View packages marked as favorites
Usage:
npm stars [<user>]
Run "npm help stars" for more info
start npm start
Start a package
Usage:
npm start [-- <args>]
Run "npm help start" for more info
stop npm stop
Stop a package
Usage:
npm stop [-- <args>]
Run "npm help stop" for more info
team npm team
Manage organization teams and team memberships
Usage:
npm team create <scope:team> [--otp <otpcode>]
npm team destroy <scope:team> [--otp <otpcode>]
npm team add <scope:team> <user> [--otp <otpcode>]
npm team rm <scope:team> <user> [--otp <otpcode>]
npm team ls <scope>|<scope:team>
Run "npm help team" for more info
test npm test
Test a package
Usage:
npm test [-- <args>]
aliases: tst, t
Run "npm help test" for more info
token npm token
Manage your authentication tokens
Usage:
npm token list
npm token revoke <id|token>
npm token create [--read-only] [--cidr=list]
Run "npm help token" for more info
uninstall npm uninstall
Remove a package
Usage:
npm uninstall [<@scope>/]<pkg>...
Options:
[-S|--save|--no-save|--save-prod|--save-dev|--save-optional|--save-peer]
aliases: un, unlink, remove, rm, r
Run "npm help uninstall" for more info
unpublish npm unpublish
Remove a package from the registry
Usage:
npm unpublish [<@scope>/]<pkg>[@<version>]
Run "npm help unpublish" for more info
unstar npm unstar
Remove an item from your favorite packages
Usage:
npm unstar [<pkg>...]
Run "npm help unstar" for more info
update npm update
Update packages
Usage:
npm update [<pkg>...]
Options:
[-g|--global]
aliases: up, upgrade, udpate
Run "npm help update" for more info
version npm version
Bump a package version
Usage:
npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease | from-git]
Options:
[--allow-same-version] [--commit-hooks] [--git-tag-version] [--json]
[--preid prerelease-id] [--sign-git-tag]
[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
[-ws|--workspaces]
alias: verison
Run "npm help version" for more info
view npm view
View registry info
Usage:
npm view [<@scope>/]<pkg>[@<version>] [<field>[.subfield]...]
Options:
[--json] [-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]]
[-ws|--workspaces]
aliases: v, info, show
Run "npm help view" for more info
whoami npm whoami
Display npm username
Usage:
npm whoami
Options:
[--registry <registry>]
Run "npm help whoami" for more info
Specify configs in the ini-formatted file:
/some/config/file/.npmrc
or on the command line via: npm <command> --key=value
More configuration info: npm help config
Configuration fields: npm help 7 config
npm@{VERSION} {BASEDIR}
`