|o||a) a folder containing a program described by a package.json file|
|o||b) a gzipped tarball containing (a)|
|o||c) a url that resolves to (b)|
|o||d) a <name>@<version> that is published on the registry with (c)|
|o||e) a <name>@<tag> that points to (d)|
|o||f) a <name> that has a "latest" tag satisfying (e)|
g) a git url that, when cloned, results in (a).
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).
Git urls can be of the form:
git://github.com/user/project.git#commit-ish git+ssh://user@hostname:project.git#commit-ish git+http://user@hostname/project/blah.git#commit-ish git+https://user@hostname/project/blah.git#commit-ish
The commit-ish can be any tag, sha, or branch which can be supplied as an argument to git checkout. The default is master.
You need to have a package.json file in the root of your project to do much of anything with npm. That is basically the whole interface.
See npm help 5 package.json for details about what goes in that file. At the very least, you need:
You can use npm init in the root of your package in order to get you started with a pretty basic package.json file. See npm help npm-init for more info.
Use a .npmignore file to keep stuff out of your package. If theres no .npmignore file, but there is a .gitignore file, then npm will ignore the stuff matched by the .gitignore file. If you want to include something that is excluded by your .gitignore file, you can create an empty .npmignore file to override it. Like git, npm looks for .npmignore and .gitignore files in all subdirectories of your package, not only the root directory.
.npmignore files follow the same pattern rules http://git-scm.com/book/en/v2/Git-Basics-Recording-Changes-to-the-Repository#Ignoring-Files as .gitignore files:
o Blank lines or lines starting with # are ignored. o Standard glob patterns work. o You can end patterns with a forward slash / to specify a directory. o You can negate a pattern by starting it with an exclamation point !.
By default, the following paths and files are ignored, so theres no need to add them to .npmignore explicitly:
o .*.swp o ._* o .DS_Store o .git o .hg o .npmrc o .lock-wscript o .svn o .wafpickle-* o config.gypi o CVS o npm-debug.log
Additionally, everything in node_modules is ignored, except for bundled dependencies. npm automatically handles this for you, so dont bother adding node_modules to .npmignore.
The following paths and files are never ignored, so adding them to .npmignore is pointless:
o package.json o README (and its variants) o CHANGELOG (and its variants) o LICENSE / LICENCE
npm link 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 npm rebuild -g to update compiled packages, of course.)
More info at npm help npm-link.
This is important.
If you can not install it locally, youll have problems trying to publish it. Or, worse yet, youll be able to publish it, but youll be publishing a broken or pointless package. So dont do that.
In the root of your package, do this:
npm install . -g
Thatll show you that its working. If youd rather just create a symlink package that points to your working directory, then do this:
Use npm ls -g to see if its there.
To test a local install, go into some other folder, and then do:
cd ../some-other-folder npm install ../my-package
to install it locally into the node_modules folder in that other place.
Then go into the node-repl, and try using require("my-thing") to bring in your modules main module.
Create a user with the adduser command. It works like this:
and then follow the prompts.
This is documented better in npm help adduser.
This parts easy. IN the root of your folder, do this:
You can give publish a url to a tarball, or a filename of a tarball, or a path to a folder.
Note that pretty much everything in that folder will be exposed by default. So, if you have secret stuff in there, use a .npmignore file to list out the globs to ignore, or publish from a fresh checkout.
Send emails, write blogs, blab in IRC.
Tell the world how easy it is to install your program!
o npm help 7 faq o npm help npm o npm help init o npm help 5 package.json o npm help 7 scripts o npm help publish o npm help adduser o npm help 7 registry
|NPM-DEVELOPERS (7)||October 2015|