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
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
|
const definitions = {}
module.exports = definitions
const Definition = require('./definition.js')
const { version: npmVersion } = require('../../../package.json')
const ciDetect = require('@npmcli/ci-detect')
const ciName = ciDetect()
const querystring = require('querystring')
const isWindows = require('../is-windows.js')
const { join } = require('path')
// used by cafile flattening to flatOptions.ca
const fs = require('fs')
const maybeReadFile = file => {
try {
return fs.readFileSync(file, 'utf8')
} catch (er) {
if (er.code !== 'ENOENT')
throw er
return null
}
}
const editor = process.env.EDITOR ||
process.env.VISUAL ||
(isWindows ? 'notepad.exe' : 'vi')
const shell = isWindows ? process.env.ComSpec || 'cmd'
: process.env.SHELL || 'sh'
const { tmpdir, networkInterfaces } = require('os')
const getLocalAddresses = () => {
try {
return Object.values(networkInterfaces()).map(
int => int.map(({ address }) => address)
).reduce((set, addrs) => set.concat(addrs), [null])
} catch (e) {
return [null]
}
}
const unicode = /UTF-?8$/i.test(
process.env.LC_ALL ||
process.env.LC_CTYPE ||
process.env.LANG
)
// use LOCALAPPDATA on Windows, if set
// https://github.com/npm/cli/pull/899
const cacheRoot = (isWindows && process.env.LOCALAPPDATA) || '~'
const cacheExtra = isWindows ? 'npm-cache' : '.npm'
const cache = `${cacheRoot}/${cacheExtra}`
const Config = require('@npmcli/config')
// TODO: refactor these type definitions so that they are less
// weird to pull out of the config module.
// TODO: use better type definition/validation API, nopt's is so weird.
const {
typeDefs: {
semver: { type: semver },
Umask: { type: Umask },
url: { type: url },
path: { type: path },
},
} = Config
const define = (key, def) => {
/* istanbul ignore if - this should never happen, prevents mistakes below */
if (definitions[key])
throw new Error(`defining key more than once: ${key}`)
definitions[key] = new Definition(key, def)
}
// basic flattening function, just copy it over camelCase
const flatten = (key, obj, flatOptions) => {
const camel = key.replace(/-([a-z])/g, (_0, _1) => _1.toUpperCase())
flatOptions[camel] = obj[key]
}
// TODO:
// Instead of having each definition provide a flatten method,
// provide the (?list of?) flat option field(s?) that it impacts.
// When that config is set, we mark the relevant flatOption fields
// dirty. Then, a getter for that field defines how we actually
// set it.
//
// So, `save-dev`, `save-optional`, `save-prod`, et al would indicate
// that they affect the `saveType` flat option. Then the config.flat
// object has a `get saveType () { ... }` that looks at the "real"
// config settings from files etc and returns the appropriate value.
//
// Getters will also (maybe?) give us a hook to audit flat option
// usage, so we can document and group these more appropriately.
//
// This will be a problem with cases where we currently do:
// const opts = { ...npm.flatOptions, foo: 'bar' }, but we can maybe
// instead do `npm.config.set('foo', 'bar')` prior to passing the
// config object down where it needs to go.
//
// This way, when we go hunting for "where does saveType come from anyway!?"
// while fixing some Arborist bug, we won't have to hunt through too
// many places.
// Define all config keys we know about
define('_auth', {
default: null,
type: [null, String],
description: `
A basic-auth string to use when authenticating against the npm registry.
Warning: This should generally not be set via a command-line option. It
is safer to use a registry-provided authentication bearer token stored in
the ~/.npmrc file by running \`npm login\`.
`,
})
define('access', {
default: null,
defaultDescription: `
'restricted' for scoped packages, 'public' for unscoped packages
`,
type: [null, 'restricted', 'public'],
description: `
When publishing scoped packages, the access level defaults to
\`restricted\`. If you want your scoped package to be publicly viewable
(and installable) set \`--access=public\`. The only valid values for
\`access\` are \`public\` and \`restricted\`. Unscoped packages _always_
have an access level of \`public\`.
`,
flatten,
})
define('all', {
default: false,
type: Boolean,
short: 'a',
description: `
When running \`npm outdated\` and \`npm ls\`, setting \`--all\` will show
all outdated or installed packages, rather than only those directly
depended upon by the current project.
`,
flatten,
})
define('allow-same-version', {
default: false,
type: Boolean,
description: `
Prevents throwing an error when \`npm version\` is used to set the new
version to the same value as the current version.
`,
flatten,
})
define('also', {
default: null,
type: [null, 'dev', 'development'],
description: `
When set to \`dev\` or \`development\`, this is an alias for
\`--include=dev\`.
`,
deprecated: 'Please use --include=dev instead.',
flatten (key, obj, flatOptions) {
if (!/^dev(elopment)?$/.test(obj.also))
return
// add to include, and call the omit flattener
obj.include = obj.include || []
obj.include.push('dev')
definitions.omit.flatten('omit', obj, flatOptions)
},
})
define('always-auth', {
default: false,
type: Boolean,
description: `
Force npm to always require authentication when accessing the registry,
even for \`GET\` requests.
`,
flatten,
})
define('audit', {
default: true,
type: Boolean,
description: `
When "true" submit audit reports alongside \`npm install\` runs to the
default registry and all registries configured for scopes. See the
documentation for [\`npm audit\`](/commands/npm-audit) for details on
what is submitted.
`,
flatten,
})
define('audit-level', {
default: null,
type: ['low', 'moderate', 'high', 'critical', 'none', null],
description: `
The minimum level of vulnerability for \`npm audit\` to exit with
a non-zero exit code.
`,
flatten,
})
define('auth-type', {
default: 'legacy',
type: ['legacy', 'sso', 'saml', 'oauth'],
deprecated: `
This method of SSO/SAML/OAuth is deprecated and will be removed in
a future version of npm in favor of web-based login.
`,
description: `
What authentication strategy to use with \`adduser\`/\`login\`.
`,
flatten,
})
define('before', {
default: null,
type: [null, Date],
description: `
If passed to \`npm install\`, will rebuild the npm tree such that only
versions that were available **on or before** the \`--before\` time get
installed. If there's no versions available for the current set of
direct dependencies, the command will error.
If the requested version is a \`dist-tag\` and the given tag does not
pass the \`--before\` filter, the most recent version less than or equal
to that tag will be used. For example, \`foo@latest\` might install
\`foo@1.2\` even though \`latest\` is \`2.0\`.
`,
flatten,
})
define('bin-links', {
default: true,
type: Boolean,
description: `
Tells npm to create symlinks (or \`.cmd\` shims on Windows) for package
executables.
Set to false to have it not do this. This can be used to work around the
fact that some file systems don't support symlinks, even on ostensibly
Unix systems.
`,
flatten,
})
define('browser', {
default: null,
defaultDescription: `
OS X: \`"open"\`, Windows: \`"start"\`, Others: \`"xdg-open"\`
`,
type: [null, Boolean, String],
description: `
The browser that is called by npm commands to open websites.
Set to \`false\` to suppress browser behavior and instead print urls to
terminal.
Set to \`true\` to use default system URL opener.
`,
flatten,
})
define('ca', {
default: null,
type: [null, String, Array],
description: `
The Certificate Authority signing certificate that is trusted for SSL
connections to the registry. Values should be in PEM format (Windows
calls it "Base-64 encoded X.509 (.CER)") with newlines replaced by the
string "\\n". For example:
\`\`\`ini
ca="-----BEGIN CERTIFICATE-----\\nXXXX\\nXXXX\\n-----END CERTIFICATE-----"
\`\`\`
Set to \`null\` to only allow "known" registrars, or to a specific CA
cert to trust only that specific signing authority.
Multiple CAs can be trusted by specifying an array of certificates:
\`\`\`ini
ca[]="..."
ca[]="..."
\`\`\`
See also the \`strict-ssl\` config.
`,
flatten,
})
define('cache', {
default: cache,
defaultDescription: `
Windows: \`%LocalAppData%\\npm-cache\`, Posix: \`~/.npm\`
`,
type: path,
description: `
The location of npm's cache directory. See [\`npm
cache\`](/commands/npm-cache)
`,
flatten (key, obj, flatOptions) {
flatOptions.cache = join(obj.cache, '_cacache')
},
})
define('cache-max', {
default: Infinity,
type: Number,
description: `
\`--cache-max=0\` is an alias for \`--prefer-online\`
`,
deprecated: `
This option has been deprecated in favor of \`--prefer-online\`
`,
flatten (key, obj, flatOptions) {
if (obj[key] <= 0)
flatOptions.preferOnline = true
},
})
define('cache-min', {
default: 0,
type: Number,
description: `
\`--cache-min=9999 (or bigger)\` is an alias for \`--prefer-offline\`.
`,
deprecated: `
This option has been deprecated in favor of \`--prefer-offline\`.
`,
flatten (key, obj, flatOptions) {
if (obj[key] >= 9999)
flatOptions.preferOffline = true
},
})
define('cafile', {
default: null,
type: path,
description: `
A path to a file containing one or multiple Certificate Authority signing
certificates. Similar to the \`ca\` setting, but allows for multiple
CA's, as well as for the CA information to be stored in a file on disk.
`,
flatten (key, obj, flatOptions) {
// always set to null in defaults
if (!obj.cafile)
return
const raw = maybeReadFile(obj.cafile)
if (!raw)
return
const delim = '-----END CERTIFICATE-----'
flatOptions.ca = raw.replace(/\r\n/g, '\n').split(delim)
.filter(section => section.trim())
.map(section => section.trimLeft() + delim)
},
})
define('call', {
default: '',
type: String,
short: 'c',
description: `
Optional companion option for \`npm exec\`, \`npx\` that allows for
specifying a custom command to be run along with the installed packages.
\`\`\`bash
npm exec --package yo --package generator-node --call "yo node"
\`\`\`
`,
flatten,
})
define('cert', {
default: null,
type: [null, String],
description: `
A client certificate to pass when accessing the registry. Values should
be in PEM format (Windows calls it "Base-64 encoded X.509 (.CER)") with
newlines replaced by the string "\\n". For example:
\`\`\`ini
cert="-----BEGIN CERTIFICATE-----\\nXXXX\\nXXXX\\n-----END CERTIFICATE-----"
\`\`\`
It is _not_ the path to a certificate file (and there is no "certfile"
option).
`,
flatten,
})
define('ci-name', {
default: ciName || null,
defaultDescription: `
The name of the current CI system, or \`null\` when not on a known CI
platform.
`,
type: [null, String],
description: `
The name of a continuous integration system. If not set explicitly, npm
will detect the current CI environment using the
[\`@npmcli/ci-detect\`](http://npm.im/@npmcli/ci-detect) module.
`,
flatten,
})
define('cidr', {
default: null,
type: [null, String, Array],
description: `
This is a list of CIDR address to be used when configuring limited access
tokens with the \`npm token create\` command.
`,
flatten,
})
define('color', {
default: !process.env.NO_COLOR || process.env.NO_COLOR === '0',
defaultDescription: `
true unless the NO_COLOR environ is set to something other than '0'
`,
type: ['always', Boolean],
description: `
If false, never shows colors. If \`"always"\` then always shows colors.
If true, then only prints color codes for tty file descriptors.
`,
flatten (key, obj, flatOptions) {
flatOptions.color = !obj.color ? false
: obj.color === 'always' ? true
: process.stdout.isTTY
},
})
define('commit-hooks', {
default: true,
type: Boolean,
description: `
Run git commit hooks when using the \`npm version\` command.
`,
flatten,
})
define('depth', {
default: null,
defaultDescription: `
\`Infinity\` if \`--all\` is set, otherwise \`1\`
`,
type: [null, Number],
description: `
The depth to go when recursing packages for \`npm ls\`.
If not set, \`npm ls\` will show only the immediate dependencies of the
root project. If \`--all\` is set, then npm will show all dependencies
by default.
`,
flatten,
})
define('description', {
default: true,
type: Boolean,
usage: '--no-description',
description: `
Show the description in \`npm search\`
`,
flatten (key, obj, flatOptions) {
flatOptions.search = flatOptions.search || { limit: 20 }
flatOptions.search[key] = obj[key]
},
})
define('diff', {
default: [],
type: [String, Array],
description: `
Define arguments to compare in \`npm diff\`.
`,
flatten,
})
define('diff-ignore-all-space', {
default: false,
type: Boolean,
description: `
Ignore whitespace when comparing lines in \`npm diff\`.
`,
flatten,
})
define('diff-name-only', {
default: false,
type: Boolean,
description: `
Prints only filenames when using \`npm diff\`.
`,
flatten,
})
define('diff-no-prefix', {
default: false,
type: Boolean,
description: `
Do not show any source or destination prefix in \`npm diff\` output.
Note: this causes \`npm diff\` to ignore the \`--diff-src-prefix\` and
\`--diff-dst-prefix\` configs.
`,
flatten,
})
define('diff-dst-prefix', {
default: 'b/',
type: String,
description: `
Destination prefix to be used in \`npm diff\` output.
`,
flatten,
})
define('diff-src-prefix', {
default: 'a/',
type: String,
description: `
Source prefix to be used in \`npm diff\` output.
`,
flatten,
})
define('diff-text', {
default: false,
type: Boolean,
description: `
Treat all files as text in \`npm diff\`.
`,
flatten,
})
define('diff-unified', {
default: 3,
type: Number,
description: `
The number of lines of context to print in \`npm diff\`.
`,
flatten,
})
define('dry-run', {
default: false,
type: Boolean,
description: `
Indicates that you don't want npm to make any changes and that it should
only report what it would have done. This can be passed into any of the
commands that modify your local installation, eg, \`install\`,
\`update\`, \`dedupe\`, \`uninstall\`, as well as \`pack\` and
\`publish\`.
Note: This is NOT honored by other network related commands, eg
\`dist-tags\`, \`owner\`, etc.
`,
flatten,
})
define('editor', {
default: editor,
defaultDescription: `
The EDITOR or VISUAL environment variables, or 'notepad.exe' on Windows,
or 'vim' on Unix systems
`,
type: String,
description: `
The command to run for \`npm edit\` and \`npm config edit\`.
`,
flatten,
})
define('engine-strict', {
default: false,
type: Boolean,
description: `
If set to true, then npm will stubbornly refuse to install (or even
consider installing) any package that claims to not be compatible with
the current Node.js version.
This can be overridden by setting the \`--force\` flag.
`,
flatten,
})
define('fetch-retries', {
default: 2,
type: Number,
description: `
The "retries" config for the \`retry\` module to use when fetching
packages from the registry.
npm will retry idempotent read requests to the registry in the case
of network failures or 5xx HTTP errors.
`,
flatten (key, obj, flatOptions) {
flatOptions.retry = flatOptions.retry || {}
flatOptions.retry.retries = obj[key]
},
})
define('fetch-retry-factor', {
default: 10,
type: Number,
description: `
The "factor" config for the \`retry\` module to use when fetching
packages.
`,
flatten (key, obj, flatOptions) {
flatOptions.retry = flatOptions.retry || {}
flatOptions.retry.factor = obj[key]
},
})
define('fetch-retry-maxtimeout', {
default: 60000,
defaultDescription: '60000 (1 minute)',
type: Number,
description: `
The "maxTimeout" config for the \`retry\` module to use when fetching
packages.
`,
flatten (key, obj, flatOptions) {
flatOptions.retry = flatOptions.retry || {}
flatOptions.retry.maxTimeout = obj[key]
},
})
define('fetch-retry-mintimeout', {
default: 10000,
defaultDescription: '10000 (10 seconds)',
type: Number,
description: `
The "minTimeout" config for the \`retry\` module to use when fetching
packages.
`,
flatten (key, obj, flatOptions) {
flatOptions.retry = flatOptions.retry || {}
flatOptions.retry.minTimeout = obj[key]
},
})
define('fetch-timeout', {
default: 5 * 60 * 1000,
defaultDescription: `${5 * 60 * 1000} (5 minutes)`,
type: Number,
description: `
The maximum amount of time to wait for HTTP requests to complete.
`,
flatten (key, obj, flatOptions) {
flatOptions.timeout = obj[key]
},
})
define('force', {
default: false,
type: Boolean,
short: 'f',
description: `
Removes various protections against unfortunate side effects, common
mistakes, unnecessary performance degradation, and malicious input.
* Allow clobbering non-npm files in global installs.
* Allow the \`npm version\` command to work on an unclean git repository.
* Allow deleting the cache folder with \`npm cache clean\`.
* Allow installing packages that have an \`engines\` declaration
requiring a different version of npm.
* Allow installing packages that have an \`engines\` declaration
requiring a different version of \`node\`, even if \`--engine-strict\`
is enabled.
* Allow \`npm audit fix\` to install modules outside your stated
dependency range (including SemVer-major changes).
* Allow unpublishing all versions of a published package.
* Allow conflicting peerDependencies to be installed in the root project.
If you don't have a clear idea of what you want to do, it is strongly
recommended that you do not use this option!
`,
flatten,
})
define('foreground-scripts', {
default: false,
type: Boolean,
description: `
Run all build scripts (ie, \`preinstall\`, \`install\`, and
\`postinstall\`) scripts for installed packages in the foreground
process, sharing standard input, output, and error with the main npm
process.
Note that this will generally make installs run slower, and be much
noisier, but can be useful for debugging.
`,
flatten,
})
define('format-package-lock', {
default: true,
type: Boolean,
description: `
Format \`package-lock.json\` or \`npm-shrinkwrap.json\` as a human
readable file.
`,
flatten,
})
define('fund', {
default: true,
type: Boolean,
description: `
When "true" displays the message at the end of each \`npm install\`
acknowledging the number of dependencies looking for funding.
See [\`npm fund\`](/commands/npm-fund) for details.
`,
flatten,
})
define('git', {
default: 'git',
type: String,
description: `
The command to use for git commands. If git is installed on the
computer, but is not in the \`PATH\`, then set this to the full path to
the git binary.
`,
flatten,
})
define('git-tag-version', {
default: true,
type: Boolean,
description: `
Tag the commit when using the \`npm version\` command.
`,
flatten,
})
define('global', {
default: false,
type: Boolean,
short: 'g',
description: `
Operates in "global" mode, so that packages are installed into the
\`prefix\` folder instead of the current working directory. See
[folders](/configuring-npm/folders) for more on the differences in
behavior.
* packages are installed into the \`{prefix}/lib/node_modules\` folder,
instead of the current working directory.
* bin files are linked to \`{prefix}/bin\`
* man pages are linked to \`{prefix}/share/man\`
`,
flatten,
})
define('global-style', {
default: false,
type: Boolean,
description: `
Causes npm to install the package into your local \`node_modules\` folder
with the same layout it uses with the global \`node_modules\` folder.
Only your direct dependencies will show in \`node_modules\` and
everything they depend on will be flattened in their \`node_modules\`
folders. This obviously will eliminate some deduping. If used with
\`legacy-bundling\`, \`legacy-bundling\` will be preferred.
`,
flatten,
})
// the globalconfig has its default defined outside of this module
define('globalconfig', {
type: path,
default: '',
defaultDescription: `
The global --prefix setting plus 'etc/npmrc'. For example,
'/usr/local/etc/npmrc'
`,
description: `
The config file to read for global config options.
`,
flatten,
})
define('heading', {
default: 'npm',
type: String,
description: `
The string that starts all the debugging log output.
`,
flatten,
})
define('https-proxy', {
default: null,
type: [null, url],
description: `
A proxy to use for outgoing https requests. If the \`HTTPS_PROXY\` or
\`https_proxy\` or \`HTTP_PROXY\` or \`http_proxy\` environment variables
are set, proxy settings will be honored by the underlying
\`make-fetch-happen\` library.
`,
flatten,
})
define('if-present', {
default: false,
type: Boolean,
description: `
If true, npm will not exit with an error code when \`run-script\` is
invoked for a script that isn't defined in the \`scripts\` section of
\`package.json\`. This option can be used when it's desirable to
optionally run a script when it's present and fail if the script fails.
This is useful, for example, when running scripts that may only apply for
some builds in an otherwise generic CI setup.
`,
flatten,
})
define('ignore-scripts', {
default: false,
type: Boolean,
description: `
If true, npm does not run scripts specified in package.json files.
`,
flatten,
})
define('include', {
default: [],
type: [Array, 'prod', 'dev', 'optional', 'peer'],
description: `
Option that allows for defining which types of dependencies to install.
This is the inverse of \`--omit=<type>\`.
Dependency types specified in \`--include\` will not be omitted,
regardless of the order in which omit/include are specified on the
command-line.
`,
flatten (key, obj, flatOptions) {
// just call the omit flattener, it reads from obj.include
definitions.omit.flatten('omit', obj, flatOptions)
},
})
define('include-staged', {
default: false,
type: Boolean,
description: `
Allow installing "staged" published packages, as defined by [npm RFC PR
#92](https://github.com/npm/rfcs/pull/92).
This is experimental, and not implemented by the npm public registry.
`,
flatten,
})
define('init-author-email', {
default: '',
type: String,
description: `
The value \`npm init\` should use by default for the package author's
email.
`,
})
define('init-author-name', {
default: '',
type: String,
description: `
The value \`npm init\` should use by default for the package author's name.
`,
})
define('init-author-url', {
default: '',
type: ['', url],
description: `
The value \`npm init\` should use by default for the package author's homepage.
`,
})
define('init-license', {
default: 'ISC',
type: String,
description: `
The value \`npm init\` should use by default for the package license.
`,
})
define('init-module', {
default: '~/.npm-init.js',
type: path,
description: `
A module that will be loaded by the \`npm init\` command. See the
documentation for the
[init-package-json](https://github.com/npm/init-package-json) module for
more information, or [npm init](/commands/npm-init).
`,
})
define('init-version', {
default: '1.0.0',
type: semver,
description: `
The value that \`npm init\` should use by default for the package
version number, if not already set in package.json.
`,
})
// these "aliases" are historically supported in .npmrc files, unfortunately
// They should be removed in a future npm version.
define('init.author.email', {
default: '',
type: String,
deprecated: `
Use \`--init-author-email\` instead.`,
description: `
Alias for \`--init-author-email\`
`,
})
define('init.author.name', {
default: '',
type: String,
deprecated: `
Use \`--init-author-name\` instead.
`,
description: `
Alias for \`--init-author-name\`
`,
})
define('init.author.url', {
default: '',
type: ['', url],
deprecated: `
Use \`--init-author-url\` instead.
`,
description: `
Alias for \`--init-author-url\`
`,
})
define('init.license', {
default: 'ISC',
type: String,
deprecated: `
Use \`--init-license\` instead.
`,
description: `
Alias for \`--init-license\`
`,
})
define('init.module', {
default: '~/.npm-init.js',
type: path,
deprecated: `
Use \`--init-module\` instead.
`,
description: `
Alias for \`--init-module\`
`,
})
define('init.version', {
default: '1.0.0',
type: semver,
deprecated: `
Use \`--init-version\` instead.
`,
description: `
Alias for \`--init-version\`
`,
})
define('json', {
default: false,
type: Boolean,
description: `
Whether or not to output JSON data, rather than the normal output.
This feature is currently experimental, and the output data structures
for many commands is either not implemented in JSON yet, or subject to
change. Only the output from \`npm ls --json\` and \`npm search --json\`
are currently valid.
`,
flatten,
})
define('key', {
default: null,
type: [null, String],
description: `
A client key to pass when accessing the registry. Values should be in
PEM format with newlines replaced by the string "\\n". For example:
\`\`\`ini
key="-----BEGIN PRIVATE KEY-----\\nXXXX\\nXXXX\\n-----END PRIVATE KEY-----"
\`\`\`
It is _not_ the path to a key file (and there is no "keyfile" option).
`,
flatten,
})
define('legacy-bundling', {
default: false,
type: Boolean,
description: `
Causes npm to install the package such that versions of npm prior to 1.4,
such as the one included with node 0.8, can install the package. This
eliminates all automatic deduping. If used with \`global-style\` this
option will be preferred.
`,
flatten,
})
define('legacy-peer-deps', {
default: false,
type: Boolean,
description: `
Causes npm to completely ignore \`peerDependencies\` when building a
package tree, as in npm versions 3 through 6.
If a package cannot be installed because of overly strict
\`peerDependencies\` that collide, it provides a way to move forward
resolving the situation.
This differs from \`--omit=peer\`, in that \`--omit=peer\` will avoid
unpacking \`peerDependencies\` on disk, but will still design a tree such
that \`peerDependencies\` _could_ be unpacked in a correct place.
Use of \`legacy-peer-deps\` is not recommended, as it will not enforce
the \`peerDependencies\` contract that meta-dependencies may rely on.
`,
flatten,
})
define('link', {
default: false,
type: Boolean,
description: `
If true, then local installs will link if there is a suitable globally
installed package.
Note that this means that local installs can cause things to be installed
into the global space at the same time. The link is only done if one of
the two conditions are met:
* The package is not already installed globally, or
* the globally installed version is identical to the version that is
being installed locally.
`,
})
define('local-address', {
default: null,
type: getLocalAddresses(),
typeDescription: 'IP Address',
description: `
The IP address of the local interface to use when making connections to
the npm registry. Must be IPv4 in versions of Node prior to 0.12.
`,
flatten,
})
define('loglevel', {
default: 'notice',
type: [
'silent',
'error',
'warn',
'notice',
'http',
'timing',
'info',
'verbose',
'silly',
],
description: `
What level of logs to report. On failure, *all* logs are written to
\`npm-debug.log\` in the current working directory.
Any logs of a higher level than the setting are shown. The default is
"notice".
`,
})
define('logs-max', {
default: 10,
type: Number,
description: `
The maximum number of log files to store.
`,
})
define('long', {
default: false,
type: Boolean,
short: 'l',
description: `
Show extended information in \`npm ls\` and \`npm search\`.
`,
})
define('maxsockets', {
default: Infinity,
type: Number,
description: `
The maximum number of connections to use per origin (protocol/host/port
combination).
`,
flatten (key, obj, flatOptions) {
flatOptions.maxSockets = obj[key]
},
})
define('message', {
default: '%s',
type: String,
short: 'm',
description: `
Commit message which is used by \`npm version\` when creating version commit.
Any "%s" in the message will be replaced with the version number.
`,
flatten,
})
define('node-options', {
default: null,
type: [null, String],
description: `
Options to pass through to Node.js via the \`NODE_OPTIONS\` environment
variable. This does not impact how npm itself is executed but it does
impact how lifecycle scripts are called.
`,
})
define('node-version', {
default: process.version,
defaultDescription: 'Node.js `process.version` value',
type: semver,
description: `
The node version to use when checking a package's \`engines\` setting.
`,
flatten,
})
define('noproxy', {
default: '',
defaultDescription: `
The value of the NO_PROXY environment variable
`,
type: [String, Array],
description: `
Domain extensions that should bypass any proxies.
Also accepts a comma-delimited string.
`,
flatten (key, obj, flatOptions) {
flatOptions.noProxy = obj[key].join(',')
},
})
define('npm-version', {
default: npmVersion,
defaultDescription: 'Output of `npm --version`',
type: semver,
description: `
The npm version to use when checking a package's \`engines\` setting.
`,
flatten,
})
define('offline', {
default: false,
type: Boolean,
description: `
Force offline mode: no network requests will be done during install. To allow
the CLI to fill in missing cache data, see \`--prefer-offline\`.
`,
flatten,
})
define('omit', {
default: process.env.NODE_ENV === 'production' ? ['dev'] : [],
defaultDescription: `
'dev' if the NODE_ENV environment variable is set to 'production',
otherwise empty.
`,
type: [Array, 'dev', 'optional', 'peer'],
description: `
Dependency types to omit from the installation tree on disk.
Note that these dependencies _are_ still resolved and added to the
\`package-lock.json\` or \`npm-shrinkwrap.json\` file. They are just
not physically installed on disk.
If a package type appears in both the \`--include\` and \`--omit\`
lists, then it will be included.
If the resulting omit list includes \`'dev'\`, then the \`NODE_ENV\`
environment variable will be set to \`'production'\` for all lifecycle
scripts.
`,
flatten (key, obj, flatOptions) {
const include = obj.include || []
const omit = flatOptions.omit || []
flatOptions.omit = omit.concat(obj[key])
.filter(type => type && !include.includes(type))
},
})
define('only', {
default: null,
type: [null, 'prod', 'production'],
deprecated: `
Use \`--omit=dev\` to omit dev dependencies from the install.
`,
description: `
When set to \`prod\` or \`production\`, this is an alias for
\`--omit=dev\`.
`,
flatten (key, obj, flatOptions) {
const value = obj[key]
if (!/^prod(uction)?$/.test(value))
return
obj.omit = obj.omit || []
obj.omit.push('dev')
definitions.omit.flatten('omit', obj, flatOptions)
},
})
define('optional', {
default: null,
type: [null, Boolean],
deprecated: `
Use \`--omit=optional\` to exclude optional dependencies, or
\`--include=optional\` to include them.
Default value does install optional deps unless otherwise omitted.
`,
description: `
Alias for --include=optional or --omit=optional
`,
flatten (key, obj, flatOptions) {
const value = obj[key]
if (value === null)
return
else if (value === true) {
obj.include = obj.include || []
obj.include.push('optional')
} else {
obj.omit = obj.omit || []
obj.omit.push('optional')
}
definitions.omit.flatten('omit', obj, flatOptions)
},
})
define('otp', {
default: null,
type: [null, String],
description: `
This is a one-time password from a two-factor authenticator. It's needed
when publishing or changing package permissions with \`npm access\`.
If not set, and a registry response fails with a challenge for a one-time
password, npm will prompt on the command line for one.
`,
flatten,
})
define('package', {
default: [],
hint: '<pkg>[@<version>]',
type: [String, Array],
description: `
The package to install for [\`npm exec\`](/commands/npm-exec)
`,
flatten,
})
define('package-lock', {
default: true,
type: Boolean,
description: `
If set to false, then ignore \`package-lock.json\` files when installing.
This will also prevent _writing_ \`package-lock.json\` if \`save\` is
true.
When package package-locks are disabled, automatic pruning of extraneous
modules will also be disabled. To remove extraneous modules with
package-locks disabled use \`npm prune\`.
`,
flatten,
})
define('package-lock-only', {
default: false,
type: Boolean,
description: `
If set to true, it will update only the \`package-lock.json\`, instead of
checking \`node_modules\` and downloading dependencies.
`,
flatten,
})
define('parseable', {
default: false,
type: Boolean,
short: 'p',
description: `
Output parseable results from commands that write to standard output. For
\`npm search\`, this will be tab-separated table format.
`,
flatten,
})
define('prefer-offline', {
default: false,
type: Boolean,
description: `
If true, staleness checks for cached data will be bypassed, but missing
data will be requested from the server. To force full offline mode, use
\`--offline\`.
`,
flatten,
})
define('prefer-online', {
default: false,
type: Boolean,
description: `
If true, staleness checks for cached data will be forced, making the CLI
look for updates immediately even for fresh package data.
`,
flatten,
})
// `prefix` has its default defined outside of this module
define('prefix', {
type: path,
short: 'C',
default: '',
defaultDescription: `
In global mode, the folder where the node executable is installed. In
local mode, the nearest parent folder containing either a package.json
file or a node_modules folder.
`,
description: `
The location to install global items. If set on the command line, then
it forces non-global commands to run in the specified folder.
`,
})
define('preid', {
default: '',
type: String,
description: `
The "prerelease identifier" to use as a prefix for the "prerelease" part
of a semver. Like the \`rc\` in \`1.2.0-rc.8\`.
`,
flatten,
})
define('production', {
default: false,
type: Boolean,
deprecated: 'Use `--omit=dev` instead.',
description: 'Alias for `--omit=dev`',
flatten (key, obj, flatOptions) {
const value = obj[key]
if (!value)
return
obj.omit = obj.omit || []
obj.omit.push('dev')
definitions.omit.flatten('omit', obj, flatOptions)
},
})
define('progress', {
default: !ciName,
defaultDescription: `
\`true\` unless running in a known CI system
`,
type: Boolean,
description: `
When set to \`true\`, npm will display a progress bar during time
intensive operations, if \`process.stderr\` is a TTY.
Set to \`false\` to suppress the progress bar.
`,
})
define('proxy', {
default: null,
type: [null, false, url], // allow proxy to be disabled explicitly
description: `
A proxy to use for outgoing http requests. If the \`HTTP_PROXY\` or
\`http_proxy\` environment variables are set, proxy settings will be
honored by the underlying \`request\` library.
`,
flatten,
})
define('read-only', {
default: false,
type: Boolean,
description: `
This is used to mark a token as unable to publish when configuring
limited access tokens with the \`npm token create\` command.
`,
flatten,
})
define('rebuild-bundle', {
default: true,
type: Boolean,
description: `
Rebuild bundled dependencies after installation.
`,
flatten,
})
define('registry', {
default: 'https://registry.npmjs.org/',
type: url,
description: `
The base URL of the npm registry.
`,
flatten,
})
define('save', {
default: true,
usage: '-S|--save|--no-save|--save-prod|--save-dev|--save-optional|--save-peer',
type: Boolean,
short: 'S',
description: `
Save installed packages to a package.json file as dependencies.
When used with the \`npm rm\` command, removes the dependency from
package.json.
`,
flatten,
})
define('save-bundle', {
default: false,
type: Boolean,
short: 'B',
description: `
If a package would be saved at install time by the use of \`--save\`,
\`--save-dev\`, or \`--save-optional\`, then also put it in the
\`bundleDependencies\` list.
Ignore if \`--save-peer\` is set, since peerDependencies cannot be bundled.
`,
flatten (key, obj, flatOptions) {
// XXX update arborist to just ignore it if resulting saveType is peer
// otherwise this won't have the expected effect:
//
// npm config set save-peer true
// npm i foo --save-bundle --save-prod <-- should bundle
flatOptions.saveBundle = obj['save-bundle'] && !obj['save-peer']
},
})
// XXX: We should really deprecate all these `--save-blah` switches
// in favor of a single `--save-type` option. The unfortunate shortcut
// we took for `--save-peer --save-optional` being `--save-type=peerOptional`
// makes this tricky, and likely a breaking change.
define('save-dev', {
default: false,
type: Boolean,
short: 'D',
description: `
Save installed packages to a package.json file as \`devDependencies\`.
`,
flatten (key, obj, flatOptions) {
if (!obj[key]) {
if (flatOptions.saveType === 'dev')
delete flatOptions.saveType
return
}
flatOptions.saveType = 'dev'
},
})
define('save-exact', {
default: false,
type: Boolean,
short: 'E',
description: `
Dependencies saved to package.json will be configured with an exact
version rather than using npm's default semver range operator.
`,
flatten,
})
define('save-optional', {
default: false,
type: Boolean,
short: 'O',
description: `
Save installed packages to a package.json file as
\`optionalDependencies\`.
`,
flatten (key, obj, flatOptions) {
if (!obj[key]) {
if (flatOptions.saveType === 'optional')
delete flatOptions.saveType
else if (flatOptions.saveType === 'peerOptional')
flatOptions.saveType = 'peer'
return
}
if (flatOptions.saveType === 'peerOptional')
return
if (flatOptions.saveType === 'peer')
flatOptions.saveType = 'peerOptional'
else
flatOptions.saveType = 'optional'
},
})
define('save-peer', {
default: false,
type: Boolean,
description: `
Save installed packages. to a package.json file as \`peerDependencies\`
`,
flatten (key, obj, flatOptions) {
if (!obj[key]) {
if (flatOptions.saveType === 'peer')
delete flatOptions.saveType
else if (flatOptions.saveType === 'peerOptional')
flatOptions.saveType = 'optional'
return
}
if (flatOptions.saveType === 'peerOptional')
return
if (flatOptions.saveType === 'optional')
flatOptions.saveType = 'peerOptional'
else
flatOptions.saveType = 'peer'
},
})
define('save-prefix', {
default: '^',
type: String,
description: `
Configure how versions of packages installed to a package.json file via
\`--save\` or \`--save-dev\` get prefixed.
For example if a package has version \`1.2.3\`, by default its version is
set to \`^1.2.3\` which allows minor upgrades for that package, but after
\`npm config set save-prefix='~'\` it would be set to \`~1.2.3\` which
only allows patch upgrades.
`,
flatten,
})
define('save-prod', {
default: false,
type: Boolean,
short: 'P',
description: `
Save installed packages into \`dependencies\` specifically. This is
useful if a package already exists in \`devDependencies\` or
\`optionalDependencies\`, but you want to move it to be a non-optional
production dependency.
This is the default behavior if \`--save\` is true, and neither
\`--save-dev\` or \`--save-optional\` are true.
`,
flatten (key, obj, flatOptions) {
if (!obj[key]) {
if (flatOptions.saveType === 'prod')
delete flatOptions.saveType
return
}
flatOptions.saveType = 'prod'
},
})
define('scope', {
default: '',
defaultDescription: `
the scope of the current project, if any, or ""
`,
type: String,
hint: '<@scope>',
description: `
Associate an operation with a scope for a scoped registry.
Useful when logging in to a private registry for the first time:
\`\`\`bash
npm login --scope=@mycorp --registry=https://registry.mycorp.com
\`\`\`
This will cause \`@mycorp\` to be mapped to the registry for future
installation of packages specified according to the pattern
\`@mycorp/package\`.
`,
flatten (key, obj, flatOptions) {
const value = obj[key]
flatOptions.projectScope = value && !/^@/.test(value) ? `@${value}` : value
},
})
define('script-shell', {
default: null,
defaultDescription: `
'/bin/sh' on POSIX systems, 'cmd.exe' on Windows
`,
type: [null, String],
description: `
The shell to use for scripts run with the \`npm run\` command.
`,
flatten (key, obj, flatOptions) {
flatOptions.scriptShell = obj[key] || undefined
},
})
define('searchexclude', {
default: '',
type: String,
description: `
Space-separated options that limit the results from search.
`,
flatten (key, obj, flatOptions) {
flatOptions.search = flatOptions.search || { limit: 20 }
flatOptions.search.exclude = obj[key]
},
})
define('searchlimit', {
default: 20,
type: Number,
description: `
Number of items to limit search results to. Will not apply at all to
legacy searches.
`,
flatten (key, obj, flatOptions) {
flatOptions.search = flatOptions.search || {}
flatOptions.search.limit = obj[key]
},
})
define('searchopts', {
default: '',
type: String,
description: `
Space-separated options that are always passed to search.
`,
flatten (key, obj, flatOptions) {
flatOptions.search = flatOptions.search || { limit: 20 }
flatOptions.search.opts = querystring.parse(obj[key])
},
})
define('searchstaleness', {
default: 15 * 60,
type: Number,
description: `
The age of the cache, in seconds, before another registry request is made
if using legacy search endpoint.
`,
flatten (key, obj, flatOptions) {
flatOptions.search = flatOptions.search || { limit: 20 }
flatOptions.search.staleness = obj[key]
},
})
define('shell', {
default: shell,
defaultDescription: `
SHELL environment variable, or "bash" on Posix, or "cmd.exe" on Windows
`,
type: String,
description: `
The shell to run for the \`npm explore\` command.
`,
flatten,
})
define('shrinkwrap', {
default: true,
type: Boolean,
deprecated: `
Use the --package-lock setting instead.
`,
description: `
Alias for --package-lock
`,
flatten (key, obj, flatOptions) {
obj['package-lock'] = obj.shrinkwrap
definitions['package-lock'].flatten('package-lock', obj, flatOptions)
},
})
define('sign-git-commit', {
default: false,
type: Boolean,
description: `
If set to true, then the \`npm version\` command will commit the new
package version using \`-S\` to add a signature.
Note that git requires you to have set up GPG keys in your git configs
for this to work properly.
`,
flatten,
})
define('sign-git-tag', {
default: false,
type: Boolean,
description: `
If set to true, then the \`npm version\` command will tag the version
using \`-s\` to add a signature.
Note that git requires you to have set up GPG keys in your git configs
for this to work properly.
`,
flatten,
})
define('sso-poll-frequency', {
default: 500,
type: Number,
deprecated: `
The --auth-type method of SSO/SAML/OAuth will be removed in a future
version of npm in favor of web-based login.
`,
description: `
When used with SSO-enabled \`auth-type\`s, configures how regularly the
registry should be polled while the user is completing authentication.
`,
flatten,
})
define('sso-type', {
default: 'oauth',
type: [null, 'oauth', 'saml'],
deprecated: `
The --auth-type method of SSO/SAML/OAuth will be removed in a future
version of npm in favor of web-based login.
`,
description: `
If \`--auth-type=sso\`, the type of SSO type to use.
`,
flatten,
})
define('strict-peer-deps', {
default: false,
type: Boolean,
description: `
If set to \`true\`, and \`--legacy-peer-deps\` is not set, then _any_
conflicting \`peerDependencies\` will be treated as an install failure,
even if npm could reasonably guess the appropriate resolution based on
non-peer dependency relationships.
By default, conflicting \`peerDependencies\` deep in the dependency graph
will be resolved using the nearest non-peer dependency specification,
even if doing so will result in some packages receiving a peer dependency
outside the range set in their package's \`peerDependencies\` object.
When such and override is performed, a warning is printed, explaining the
conflict and the packages involved. If \`--strict-peer-deps\` is set,
then this warning is treated as a failure.
`,
flatten,
})
define('strict-ssl', {
default: true,
type: Boolean,
description: `
Whether or not to do SSL key validation when making requests to the
registry via https.
See also the \`ca\` config.
`,
flatten (key, obj, flatOptions) {
flatOptions.strictSSL = obj[key]
},
})
define('tag', {
default: 'latest',
type: String,
description: `
If you ask npm to install a package and don't tell it a specific version,
then it will install the specified tag.
Also the tag that is added to the package@version specified by the \`npm
tag\` command, if no explicit tag is given.
`,
flatten (key, obj, flatOptions) {
flatOptions.defaultTag = obj[key]
},
})
define('tag-version-prefix', {
default: 'v',
type: String,
description: `
If set, alters the prefix used when tagging a new version when performing
a version increment using \`npm-version\`. To remove the prefix
altogether, set it to the empty string: \`""\`.
Because other tools may rely on the convention that npm version tags look
like \`v1.0.0\`, _only use this property if it is absolutely necessary_.
In particular, use care when overriding this setting for public packages.
`,
flatten,
})
define('timing', {
default: false,
type: Boolean,
description: `
If true, writes an \`npm-debug\` log to \`_logs\` and timing information
to \`_timing.json\`, both in your cache, even if the command completes
successfully. \`_timing.json\` is a newline delimited list of JSON
objects.
You can quickly view it with this [json](https://npm.im/json) command
line: \`npm exec -- json -g < ~/.npm/_timing.json\`.
`,
})
define('tmp', {
default: tmpdir(),
defaultDescription: `
The value returned by the Node.js \`os.tmpdir()\` method
<https://nodejs.org/api/os.html#os_os_tmpdir>
`,
type: path,
deprecated: `
This setting is no longer used. npm stores temporary files in a special
location in the cache, and they are managed by
[\`cacache\`](http://npm.im/cacache).
`,
description: `
Historically, the location where temporary files were stored. No longer
relevant.
`,
})
define('umask', {
default: 0,
type: Umask,
description: `
The "umask" value to use when setting the file creation mode on files and
folders.
Folders and executables are given a mode which is \`0o777\` masked
against this value. Other files are given a mode which is \`0o666\`
masked against this value.
Note that the underlying system will _also_ apply its own umask value to
files and folders that are created, and npm does not circumvent this, but
rather adds the \`--umask\` config to it.
Thus, the effective default umask value on most POSIX systems is 0o22,
meaning that folders and executables are created with a mode of 0o755 and
other files are created with a mode of 0o644.
`,
flatten,
})
define('unicode', {
default: unicode,
defaultDescription: `
false on windows, true on mac/unix systems with a unicode locale, as
defined by the LC_ALL, LC_CTYPE, or LANG environment variables.
`,
type: Boolean,
description: `
When set to true, npm uses unicode characters in the tree output. When
false, it uses ascii characters instead of unicode glyphs.
`,
})
define('update-notifier', {
default: true,
type: Boolean,
description: `
Set to false to suppress the update notification when using an older
version of npm than the latest.
`,
})
define('usage', {
default: false,
type: Boolean,
short: ['?', 'H', 'h'],
description: `
Show short usage output about the command specified.
`,
})
define('user-agent', {
default: 'npm/{npm-version} ' +
'node/{node-version} ' +
'{platform} ' +
'{arch} ' +
'{ci}',
type: String,
description: `
Sets the User-Agent request header. The following fields are replaced
with their actual counterparts:
* \`{npm-version}\` - The npm version in use
* \`{node-version}\` - The Node.js version in use
* \`{platform}\` - The value of \`process.platform\`
* \`{arch}\` - The value of \`process.arch\`
* \`{ci}\` - The value of the \`ci-name\` config, if set, prefixed with
\`ci/\`, or an empty string if \`ci-name\` is empty.
`,
flatten (key, obj, flatOptions) {
const value = obj[key]
const ciName = obj['ci-name']
flatOptions.userAgent =
value.replace(/\{node-version\}/gi, obj['node-version'])
.replace(/\{npm-version\}/gi, obj['npm-version'])
.replace(/\{platform\}/gi, process.platform)
.replace(/\{arch\}/gi, process.arch)
.replace(/\{ci\}/gi, ciName ? `ci/${ciName}` : '')
.trim()
},
})
define('userconfig', {
default: '~/.npmrc',
type: path,
description: `
The location of user-level configuration settings.
This may be overridden by the \`npm_config_userconfig\` environment
variable or the \`--userconfig\` command line option, but may _not_
be overridden by settings in the \`globalconfig\` file.
`,
})
define('version', {
default: false,
type: Boolean,
short: 'v',
description: `
If true, output the npm version and exit successfully.
Only relevant when specified explicitly on the command line.
`,
})
define('versions', {
default: false,
type: Boolean,
description: `
If true, output the npm version as well as node's \`process.versions\`
map and the version in the current working directory's \`package.json\`
file if one exists, and exit successfully.
Only relevant when specified explicitly on the command line.
`,
})
define('viewer', {
default: isWindows ? 'browser' : 'man',
defaultDescription: `
"man" on Posix, "browser" on Windows
`,
type: String,
description: `
The program to use to view help content.
Set to \`"browser"\` to view html help content in the default web browser.
`,
})
define('which', {
default: null,
hint: '<fundingSourceNumber>',
type: [null, Number],
description: `
If there are multiple funding sources, which 1-indexed source URL to open.
`,
})
define('workspace', {
default: [],
type: [String, Array],
short: 'w',
description: `
Enable running a command in the context of the configured workspaces of the
current project while filtering by running only the workspaces defined by
this configuration option.
Valid values for the \`workspace\` config are either:
- Workspace names
- Path to a workspace directory
- Path to a parent workspace directory (will result to selecting all of the
nested workspaces)
`,
})
define('workspaces', {
default: false,
type: Boolean,
short: 'ws',
description: `
Enable running a command in the context of **all** the configured
workspaces.
`,
})
define('yes', {
default: null,
type: [null, Boolean],
short: 'y',
description: `
Automatically answer "yes" to any prompts that npm might print on
the command line.
`,
})
|