42 lines
1.1 KiB
Groff
42 lines
1.1 KiB
Groff
.TH "NPM\-LINK" "3" "March 2017" "" ""
|
|
.SH "NAME"
|
|
\fBnpm-link\fR \- Symlink a package folder
|
|
.SH SYNOPSIS
|
|
.P
|
|
.RS 2
|
|
.nf
|
|
npm\.commands\.link(callback)
|
|
npm\.commands\.link(packages, callback)
|
|
.fi
|
|
.RE
|
|
.SH DESCRIPTION
|
|
.P
|
|
Package linking is a two\-step process\.
|
|
.P
|
|
Without parameters, link will create a globally\-installed
|
|
symbolic link from \fBprefix/package\-name\fP to the current folder\.
|
|
.P
|
|
With a parameters, link will create a symlink from the local \fBnode_modules\fP
|
|
folder to the global symlink\.
|
|
.P
|
|
When creating tarballs for \fBnpm publish\fP, the linked packages are
|
|
"snapshotted" to their current state by resolving the symbolic links\.
|
|
.P
|
|
This is
|
|
handy for installing your own stuff, so that you can work on it and test it
|
|
iteratively without having to continually rebuild\.
|
|
.P
|
|
For example:
|
|
.P
|
|
.RS 2
|
|
.nf
|
|
npm\.commands\.link(cb) # creates global link from the cwd
|
|
# (say redis package)
|
|
npm\.commands\.link('redis', cb) # link\-install the package
|
|
.fi
|
|
.RE
|
|
.P
|
|
Now, any changes to the redis package will be reflected in
|
|
the package in the current working directory
|
|
|