Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
tag: v1.0.29
Fetching contributors…

Cannot retrieve contributors at this time

263 lines (261 sloc) 6.068 kb
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
.TH "NPM\-DEVELOPERS" "1" "September 2011" "" ""
.
.SH "NAME"
\fBnpm-developers\fR \-\- Developer Guide
.
.SH "DESCRIPTION"
So, you\'ve decided to use npm to develop (and maybe publish/deploy)
your project\.
.
.P
Fantastic!
.
.P
There are a few things that you need to do above the simple steps
that your users will do to install your program\.
.
.SH "About These Documents"
These are man pages\. If you install npm, you should be able to
then do \fBman npm\-thing\fR to get the documentation on a particular
topic, or \fBnpm help thing\fR to see the same information\.
.
.SH "What is a `package`"
A package is:
.
.IP "\(bu" 4
a) a folder containing a program described by a package\.json file
.
.IP "\(bu" 4
b) a gzipped tarball containing (a)
.
.IP "\(bu" 4
c) a url that resolves to (b)
.
.IP "\(bu" 4
d) a \fB<name>@<version>\fR that is published on the registry with (c)
.
.IP "\(bu" 4
e) a \fB<name>@<tag>\fR that points to (d)
.
.IP "\(bu" 4
f) a \fB<name>\fR that has a "latest" tag satisfying (e)
.
.IP "" 0
.
.P
Even if you never publish your package, you can still get a lot of
benefits of using npm if you just want to write a node program (a), and
perhaps if you also want to be able to easily install it elsewhere
after packing it up into a tarball (b)\.
.
.SH "The package\.json File"
You need to have a \fBpackage\.json\fR file in the root of your project to do
much of anything with npm\. That is basically the whole interface\.
.
.P
See \fBnpm help json\fR for details about what goes in that file\. At the very
least, you need:
.
.IP "\(bu" 4
name:
This should be a string that identifies your project\. Please do not
use the name to specify that it runs on node, or is in JavaScript\.
You can use the "engines" field to explicitly state the versions of
node (or whatever else) that your program requires, and it\'s pretty
well assumed that it\'s javascript\.
.
.IP
It does not necessarily need to match your github repository name\.
.
.IP
So, \fBnode\-foo\fR and \fBbar\-js\fR are bad names\. \fBfoo\fR or \fBbar\fR are better\.
.
.IP "\(bu" 4
version:
A semver\-compatible version\.
.
.IP "\(bu" 4
engines:
Specify the versions of node (or whatever else) that your program
runs on\. The node API changes a lot, and there may be bugs or new
functionality that you depend on\. Be explicit\.
.
.IP "\(bu" 4
author:
Take some credit\.
.
.IP "\(bu" 4
scripts:
If you have a special compilation or installation script, then you
should put it in the \fBscripts\fR hash\. You should definitely have at
least a basic smoke\-test command as the "scripts\.test" field\.
See npm help scripts\.
.
.IP "\(bu" 4
main:
If you have a single module that serves as the entry point to your
program (like what the "foo" package gives you at require("foo")),
then you need to specify that in the "main" field\.
.
.IP "\(bu" 4
directories:
This is a hash of folders\. The best ones to include are "lib" and
"doc", but if you specify a folder full of man pages in "man", then
they\'ll get installed just like these ones\.
.
.IP "" 0
.
.P
You can use \fBnpm init\fR in the root of your package in order to get you
started with a pretty basic package\.json file\. See \fBnpm help init\fR for
more info\.
.
.SH "Keeping files *out* of your package"
Use a \fB\|\.npmignore\fR file to keep stuff out of your package\. If there\'s
no \.npmignore file, but there \fIis\fR a \.gitignore file, then npm will
ignore the stuff matched by the \.gitignore file\. If you \fIwant\fR to
include something that is excluded by your \.gitignore file, you can
create an empty \.npmignore file to override it\.
.
.SH "Link Packages"
\fBnpm link\fR is designed to install a development package and see the
changes in real time without having to keep re\-installing it\. (You do
need to either re\-link or \fBnpm rebuild \-g\fR to update compiled packages,
of course\.)
.
.P
More info at \fBnpm help link\fR\|\.
.
.SH "Before Publishing: Make Sure Your Package Installs and Works"
\fBThis is important\.\fR
.
.P
If you can not install it locally, you\'ll have
problems trying to publish it\. Or, worse yet, you\'ll be able to
publish it, but you\'ll be publishing a broken or pointless package\.
So don\'t do that\.
.
.P
In the root of your package, do this:
.
.IP "" 4
.
.nf
npm install \. \-g
.
.fi
.
.IP "" 0
.
.P
That\'ll show you that it\'s working\. If you\'d rather just create a symlink
package that points to your working directory, then do this:
.
.IP "" 4
.
.nf
npm link
.
.fi
.
.IP "" 0
.
.P
Use \fBnpm ls \-g\fR to see if it\'s there\.
.
.P
To test a local install, go into some other folder, and then do:
.
.IP "" 4
.
.nf
cd \.\./some\-other\-folder
npm install \.\./my\-package
.
.fi
.
.IP "" 0
.
.P
to install it locally into the node_modules folder in that other place\.
.
.P
Then go into the node\-repl, and try using require("my\-thing") to
bring in your module\'s main module\.
.
.SH "Create a User Account"
Create a user with the adduser command\. It works like this:
.
.IP "" 4
.
.nf
npm adduser
.
.fi
.
.IP "" 0
.
.P
and then follow the prompts\.
.
.P
This is documented better in npm help adduser\.
.
.SH "Publish your package"
This part\'s easy\. IN the root of your folder, do this:
.
.IP "" 4
.
.nf
npm publish
.
.fi
.
.IP "" 0
.
.P
You can give publish a url to a tarball, or a filename of a tarball,
or a path to a folder\.
.
.P
Note that pretty much \fBeverything in that folder will be exposed\fR
by default\. So, if you have secret stuff in there, use a \fB\|\.npminclude\fR
or \fB\|\.npmignore\fR file to list out the globs to include/ignore, or publish
from a fresh checkout\.
.
.SH "Brag about it"
Send emails, write blogs, blab in IRC\.
.
.P
Tell the world how easy it is to install your program!
.
.SH "SEE ALSO"
.
.IP "\(bu" 4
npm help faq
.
.IP "\(bu" 4
npm help npm
.
.IP "\(bu" 4
npm help init
.
.IP "\(bu" 4
npm help json
.
.IP "\(bu" 4
npm help scripts
.
.IP "\(bu" 4
npm help publish
.
.IP "\(bu" 4
npm help adduser
.
.IP "\(bu" 4
npm help registry
.
.IP "" 0
Jump to Line
Something went wrong with that request. Please try again.