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
|
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
.TH "NPM\-JSON" "1" "January 2011" "" ""
.
.SH "NAME"
\fBnpm-json\fR \-\- Specifics of npm\'s package\.json handling
.
.SH "DESCRIPTION"
npm aims to implement the commonjs Packages \fIhttp://wiki\.commonjs\.org/wiki/Packages/1\.0\fR spec\. However, some
adjustments have been made, which may eventually be unmade, but hopefully will
be incorporated into the spec\.
.
.P
This document is all you need to know about what\'s required in your package\.json
file\.
.
.P
A lot of the behavior described in this document is affected by the config
settings described in \fBnpm help config\fR\|\.
.
.SH "name"
The \fImost\fR important things in your package\.json are the name and version fields\.
.
.P
The name is what your thing is called\. Some tips:
.
.IP "\(bu" 4
Don\'t put "js" or "node" in the name\. It\'s assumed that it\'s js, since you\'re
writing a package\.json file, and you can specify the engine using the "engines"
field\. (See below\.)
.
.IP "\(bu" 4
The name ends up being part of a URL, an argument on the command line, and a
folder name\. So, don\'t use characters that are annoying in those contexts, like
funny UTF things or parentheses or slashes, or else it\'ll break\.
.
.IP "\(bu" 4
The name will probably be passed as an argument to require(), so it should
be something short, but also reasonably descriptive\.
.
.IP "\(bu" 4
You may want to check the npm registry to see if there\'s something by that name
already, before you get too attached to it\. http://registry\.npmjs\.org/
.
.IP "" 0
.
.SH "version"
The \fImost\fR important things in your package\.json are the name and version fields\.
.
.P
Version must be semver \fIhttp://semver\.org\fR\-compliant\. npm assumes that you\'ve
read the semver page, and that you comply with it\. Here\'s how it deviates from
what\'s on semver\.org:
.
.IP "\(bu" 4
Versions can start with "v"
.
.IP "\(bu" 4
A numeric item separated from the main three\-number version by a hyphen
will be interpreted as a "build" number, and will \fIincrease\fR the version\.
But, if the tag is not a number separated by a hyphen, then it\'s treated
as a pre\-release tag, and is \fIless than\fR the version without a tag\.
So, 0\.1\.2\-7 > 0\.1\.2\-6 > 0\.1\.2 > 0\.1\.2beta
.
.IP "" 0
.
.P
This is a little bit confusing to explain, but matches what you see in practice
when people create tags in git like "v1\.2\.3" and then do "git describe" to generate
a patch version\. (This is how node\'s versions are generated, and has driven this
design\.)
.
.SH "description"
Put a description in it\. It\'s a string\. This helps people discover your
package, as it\'s listed in \fBnpm ls\fR\|\.
.
.SH "keywords"
Put keywords in it\. It\'s an array of strings\. This helps people
discover your package as it\'s listed in \fBnpm ls\fR\|\.
.
.SH "homepage"
The url to the project homepage\.
.
.P
\fBNOTE\fR: This is \fInot\fR the same as "url"\. If you put a "url" field,
then the registry will think it\'s a redirection to your package that has
been published somewhere else, and spit at you\.
.
.P
Literally\. Spit\. I\'m so not kidding\.
.
.SH "people fields: author, contributors"
The "author" is one person\. "contributors" is an array of people\. A "person"
is an object with a "name" field and optionally "url" and "email", like this:
.
.IP "" 4
.
.nf
{ "name" : "Barney Rubble"
, "email" : "b@rubble\.com"
, "url" : "http://barnyrubble\.tumblr\.com/"
}
.
.fi
.
.IP "" 0
.
.P
Or you can shorten that all into a single string, and npm will parse it for you:
.
.IP "" 4
.
.nf
"Barney Rubble <b@rubble\.com> (http://barnyrubble\.tumblr\.com/)
.
.fi
.
.IP "" 0
.
.P
Both email and url are optional either way\.
.
.P
npm also sets a top\-level "maintainers" field with your npm user info\.
.
.SH "files"
The "files" field is an array of files to include in your project\. If
you name a folder in the array, then it will also include the files
inside that folder\. The default is just \fB[""]\fR which includes the
entire package folder in the tarball, but you may want to only include
specific things\.
.
.P
If you specify modules, bins, or man pages, then those will be
automatically added to the files array, even if they would not
ordinarily be included\.
.
.P
You can also provide a "\.npmignore" file in the root of your package,
which will keep files from being included, even if they would be picked
up by the files array\.
.
.SH "main"
The main field is a module ID that is the primary entry point to your program\.
That is, if your package is named \fBfoo\fR, and a user installs it, and then does \fBrequire("foo")\fR, then your main module\'s exports object will be returned\.
.
.P
This should be a module ID relative to the root of your package folder\.
.
.P
For most modules, it makes the most sense to have a main script and often not
much else\.
.
.SH "bin"
A lot of packages have one or more executable files that they\'d like to
install into the PATH\. npm makes this pretty easy (in fact, it uses this
feature to install the "npm" executable\.)
.
.P
To use this, supply a \fBbin\fR field in your package\.json which is a map of
command name to local file name\. On install, npm will link that file into
place right next to wherever node is installed\. (Presumably, this is in your
PATH, and defaults to \fB/usr/local/bin\fR\|\.) On activation, the versioned file
will get linked to the main filename (just like how the main\.js stuff works,
but with an executable in the PATH\.)
.
.P
For example, npm has this:
.
.IP "" 4
.
.nf
{ "bin" : { "npm" : "\./cli\.js" } }
.
.fi
.
.IP "" 0
.
.P
So, when you install npm, it\'ll create a symlink from the \fBcli\.js\fR script to \fB/usr/local/bin/npm\-version\fR\|\. Then, when you activate that version, it\'ll
create a symlink from \fB/usr/local/bin/npm\-version\fR to \fB/usr/local/bin/npm\fR\|\.
.
.P
Notice that if the executable file is interpreted by node (i\.e\., specifying
node in the shebang line), npm actually installs a shim instead of symlinking
it, which causes expressions \fBrequire\.main === module\fR and \fBmodule\.id === "\."\fR
evaluate to \fBfalse\fR within the file\. This seems unable to be resolved until
node provides a "flexible \fBrequire()\fR"\.
.
.P
Shortcut: If you have a single executable, and its name is already what you
want it to be, then you can just supply it as a string\. For example:
.
.IP "" 4
.
.nf
{ "bin" : "\./path/to/program" }
.
.fi
.
.IP "" 0
.
.P
would be the same as this:
.
.IP "" 4
.
.nf
{ "bin" : { "program" : "\./path/to/program" } }
.
.fi
.
.IP "" 0
.
.SH "modules"
The "modules" member exposes CommonJS modules in the package\. So, if you had a
package named \fBfoo\fR, and the package\.json contains \fB"modules":{"bar":"\./lib/baz"}\fR,
and there was a file called \fB\|\./lib/baz\.js\fR, then require("foo/bar") would include
the module defined in \fB\|\./lib/baz\.js\fR\|\.
.
.P
Subfolders are supported, so you can do this:
.
.IP "" 4
.
.nf
{ "name" : "foo"
, "modules" :
{ "bar/baz" : "\./lib/bar/baz"
, "quux" : "\./quux"
}
}
.
.fi
.
.IP "" 0
.
.P
And then, doing \fBrequire("foo/bar/baz")\fR would return the module at \fB\|\./lib/bar/baz\fR
in the foo package\. Doing \fBrequire("foo/quux")\fR would return the module at \fB\|\./quux\fR in the foo package\.
.
.P
Just like the \fBmain\fR script, the modules linked in this fashion will have their
dependencies and paths set up properly by npm\. (In fact, "main" is just sugar
around setting a module named "index"\.)
.
.SH "man"
Specify either a single file or an array of filenames to put in place for the \fBman\fR program to find\.
.
.P
If only a single file is provided, then it\'s installed such that it is the
result from \fBman <pkgname>\fR, regardless of its actual filename\. For example:
.
.IP "" 4
.
.nf
{ "name" : "foo"
, "man" : "\./man/doc\.1"
}
.
.fi
.
.IP "" 0
.
.P
would link the \fB\|\./man/doc\.1\fR file in such that it is the target for \fBman foo\fR
.
.P
If the filename doesn\'t start with the package name, then it\'s prefixed\.
So, this:
.
.IP "" 4
.
.nf
{ "name" : "foo"
, "man" : [ "\./man/foo\.1", "\./man/bar\.1" ]
}
.
.fi
.
.IP "" 0
.
.P
will create files to do \fBman foo\fR and \fBman foo\-bar\fR\|\.
.
.P
Man files must end with a number, and optionally a \fB\|\.gz\fR suffix if they are
compressed\. The number dictates which man section the file is installed into\.
.
.IP "" 4
.
.nf
{ "name" : "foo"
, "man" : [ "\./man/foo\.1", "\./man/foo\.2" ]
}
.
.fi
.
.IP "" 0
.
.P
will create entries for \fBman foo\fR and \fBman 2 foo\fR
.
.SH "directories"
The CommonJS Packages \fIhttp://wiki\.commonjs\.org/wiki/Packages/1\.0\fR spec details a
few ways that you can indicate the structure of your package using a \fBdirectories\fR
hash\. If you look at npm\'s package\.json \fIhttp://registry\.npmjs\.org/npm/latest\fR,
you\'ll see that it has directories for doc, lib, and man\.
.
.P
In the future, this information may be used in other creative ways\.
.
.SS "directories\.lib"
If you specify a "lib" directory, and do not supply a modules hash, then the lib
folder will be walked and any \fI\|\.js or \fR\|\.node files found will be exposed as a
default module hash\.
.
.P
Providing an explicit modules hash is encouraged over exposing the entire lib
folder\.
.
.SS "directories\.bin"
If you specify a "bin" directory, then all the files in that folder will be used
as the "bin" hash\.
.
.P
If you have a "bin" hash already, then this has no effect\.
.
.SS "directories\.man"
A folder that is full of man pages\. Sugar to generate a "man" array by walking the folder\.
.
.SS "directories\.doc"
Put markdown files in here\. Eventually, these will be displayed nicely, maybe, someday\.
.
.SS "directories\.example"
Put example scripts in here\. Someday, it might be exposed in some clever way\.
.
.SH "repository"
Specify the place where your code lives\. This is helpful for people who want to
contribute, as well as perhaps maybe being the underpinning of some magical "track
this package on git" feature someday maybe if somebody wants to write it ever\.
.
.P
Do it like this:
.
.IP "" 4
.
.nf
"repository" :
{ "type" : "git"
, "url" : "http://github\.com/isaacs/npm\.git"
}
"repository" :
{ "type" : "svn"
, "url" : "http://v8\.googlecode\.com/svn/trunk/"
}
.
.fi
.
.IP "" 0
.
.P
The URL should be a publicly available (perhaps read\-only) url that can be handed
directly to a VCS program without any modification\. It should not be a url to an
html project page that you put in your browser\. It\'s for computers\.
.
.P
Here are some examples of Doing It Wrong:
.
.IP "" 4
.
.nf
WRONG!
"repository" :
{ "type" : "git"
, "url" : "git@github\.com:isaacs/npm\.git" <\-\- THIS IS PRIVATE!
}
ALSO WRONG!
"repository" :
{ "type" : "git"
, "url" : "http://github\.com/isaacs/npm" <\-\- THIS IS WEBPAGE!
}
This is ok, but completely unnecessary:
"repository" :
{ "type" : "git"
, "url" : "http://github\.com/isaacs/npm\.git"
, "private" : "git@github\.com:isaacs/npm\.git"
, "web" : "http://github\.com/isaacs/npm"
}
.
.fi
.
.IP "" 0
.
.SH "scripts"
The "scripts" member is an object hash of script commands that are run
at various times in the lifecycle of your package\. The key is the lifecycle
event, and the value is the command to run at that point\.
.
.P
See \fBnpm help scripts\fR to find out more about writing package scripts\.
.
.SH "config"
A "config" hash can be used to set configuration
parameters used in package scripts that persist across upgrades\. For
instance, if a package had the following:
.
.IP "" 4
.
.nf
{ "name" : "foo"
, "config" : { "port" : "8080" } }
.
.fi
.
.IP "" 0
.
.P
and then had a "start" command that then referenced the \fBnpm_package_config_port\fR environment variable, then the user could
override that by doing \fBnpm config set foo:port 8001\fR\|\.
.
.P
See \fBnpm help config\fR and \fBnpm help scripts\fR for more on package
configs\.
.
.SH "dependencies"
Dependencies are specified with a simple hash of package name to version
range\. The version range is EITHER a string with has one or more
space\-separated descriptors, OR a range like "fromVersion \- toVersion"
.
.P
Version range descriptors may be any of the following styles, where "version"
is a semver compatible version identifier\.
.
.IP "\(bu" 4
\fBversion\fR Must match \fBversion\fR exactly
.
.IP "\(bu" 4
\fB=version\fR Same as just \fBversion\fR
.
.IP "\(bu" 4
\fB>version\fR Must be greater than \fBversion\fR
.
.IP "\(bu" 4
\fB>=version\fR etc
.
.IP "\(bu" 4
\fB<version\fR
.
.IP "\(bu" 4
\fB<=version\fR
.
.IP "\(bu" 4
\fB~version\fR See \'Tilde Version Ranges\' below
.
.IP "\(bu" 4
\fB1\.2\.x\fR See \'X Version Ranges\' below
.
.IP "\(bu" 4
\fBhttp://\.\.\.\fR See \'URLs as Dependencies\' below
.
.IP "\(bu" 4
\fB*\fR Matches any version
.
.IP "\(bu" 4
\fB""\fR (just an empty string) Same as \fB*\fR
.
.IP "\(bu" 4
\fBversion1 \- version2\fR Same as \fB>=version1 <=version2\fR\|\.
.
.IP "\(bu" 4
\fBrange1 || range2\fR Passes if either range1 or range2 are satisfied\.
.
.IP "" 0
.
.P
For example, these are all valid:
.
.IP "" 4
.
.nf
{ "dependencies" :
{ "foo" : "1\.0\.0 \- 2\.9999\.9999"
, "bar" : ">=1\.0\.2 <2\.1\.2"
, "baz" : ">1\.0\.2 <=2\.3\.4"
, "boo" : "2\.0\.1"
, "qux" : "<1\.0\.0 || >=2\.3\.1 <2\.4\.5 || >=2\.5\.2 <3\.0\.0"
, "asd" : "http://asdf\.com/asdf\.tar\.gz"
, "til" : "~1\.2"
, "elf" : "~1\.2\.3"
, "two" : "2\.x"
, "thr" : "3\.3\.x"
}
}
.
.fi
.
.IP "" 0
.
.SS "Tilde Version Ranges"
A range specifier starting with a tilde \fB~\fR character is matched against
a version in the following fashion\.
.
.IP "\(bu" 4
The version must be at least as high as the range\.
.
.IP "\(bu" 4
The version must be less than the next major revision above the range\.
.
.IP "" 0
.
.P
For example, the following are equivalent:
.
.IP "\(bu" 4
\fB"~1\.2\.3" = ">=1\.2\.3 <1\.3\.0"\fR
.
.IP "\(bu" 4
\fB"~1\.2" = ">=1\.2\.0 <2\.0\.0"\fR
.
.IP "\(bu" 4
\fB"~1" = ">=1\.0\.0 <2\.0\.0"\fR
.
.IP "" 0
.
.SS "X Version Ranges"
An "x" in a version range specifies that the version number must start
with the supplied digits, but any digit may be used in place of the x\.
.
.P
The following are equivalent:
.
.IP "\(bu" 4
\fB"1\.2\.x" = ">=1\.2\.0 <1\.3\.0"\fR
.
.IP "\(bu" 4
\fB"1\.x\.x" = ">=1\.0\.0 <2\.0\.0"\fR
.
.IP "\(bu" 4
\fB"1\.2" = "1\.2\.x"\fR
.
.IP "\(bu" 4
\fB"1\.x" = "1\.x\.x"\fR
.
.IP "\(bu" 4
\fB"1" = "1\.x\.x"\fR
.
.IP "" 0
.
.P
You may not supply a comparator with a version containing an x\. Any
digits after the first "x" are ignored\.
.
.SS "URLs as Dependencies"
Starting with npm version 0\.2\.14, you may specify a tarball URL in place
of a version range\.
.
.P
This tarball will be downloaded and installed as a bundle at install
time\. See \fBnpm help bundle\fR
.
.SH "engines"
Packages/1\.0 says that you can have an "engines" field with an array of engine
names\. However, it has no provision for specifying which version of the engine
your stuff runs on\.
.
.P
With npm, you can use either of the following styles to specify the version of
node that your stuff works on:
.
.IP "" 4
.
.nf
{ "engines" : [ "node >=0\.1\.27 <0\.1\.30" ] }
.
.fi
.
.IP "" 0
.
.P
or:
.
.IP "" 4
.
.nf
{ "engines" : { "node" : ">=0\.1\.27 <0\.1\.30" } }
.
.fi
.
.IP "" 0
.
.P
And, like with dependencies, if you don\'t specify the version (or if you
specify "*" as the version), then any version of node will do\.
.
.P
If you specify an "engines" field, then npm will require that "node" be
somewhere on that list\. If "engines" is omitted, then npm will just assume
that it works on node\.
.
.SH "overlay"
npm responds to the \fBnode\fR and \fBnpm\fR env\-specific package\.json values, which
you can hang on the "overlay" key\.
.
.P
For example:
.
.IP "" 4
.
.nf
{ "name" : "foo"
, "version" : 7
, "description" : "generic description"
, "overlay" :
{ "node" :
{ "name" : "bar"
, "description" : "description for node"
}
, "npm" :
{ "version" : "1\.0\.7"
, "description" : "description for npm"
}
, "narwhal" :
{ "description" : "description for narwhal" }
}
}
.
.fi
.
.IP "" 0
.
.P
In this case, this is what npm will treat it as:
.
.IP "" 4
.
.nf
{ "name" : "bar"
, "version" : "1\.0\.7"
, "description" : "description for npm"
}
.
.fi
.
.IP "" 0
.
.P
This way, even if npm is not exactly the same as some other package management
system, you can still use both, and it can be a happy planet\.
|