diff options
Diffstat (limited to 'deps/npm/man/man5/package.json.5')
| -rw-r--r-- | deps/npm/man/man5/package.json.5 | 35 |
1 files changed, 33 insertions, 2 deletions
diff --git a/deps/npm/man/man5/package.json.5 b/deps/npm/man/man5/package.json.5 index 51ebb9be651..b492849675c 100644 --- a/deps/npm/man/man5/package.json.5 +++ b/deps/npm/man/man5/package.json.5 @@ -1,4 +1,4 @@ -.TH "PACKAGE\.JSON" "5" "February 2016" "" "" +.TH "PACKAGE\.JSON" "5" "March 2016" "" "" .SH "NAME" \fBpackage.json\fR \- Specifics of npm's package\.json handling .SH DESCRIPTION @@ -401,6 +401,10 @@ maybe, someday\. .SS directories\.example .P Put example scripts in here\. Someday, it might be exposed in some clever way\. +.SS directories\.test +.P +Put your tests in here\. It is currently not exposed, but it might be in the +future\. .SH repository .P Specify the place where your code lives\. This is helpful for people who @@ -698,7 +702,34 @@ with every 1\.x version of the host package, use \fB"^1\.0"\fP or \fB"1\.x"\fP t this\. If you depend on features introduced in 1\.5\.2, use \fB">= 1\.5\.2 < 2"\fP\|\. .SH bundledDependencies .P -Array of package names that will be bundled when publishing the package\. +This defines an array of package names that will be bundled when publishing +the package\. +.P +In cases where you need to preserve npm packages locally or have them +available through a single file download, you can bundle the packages in a +tarball file by specifying the package names in the \fBbundledDependencies\fP +array and executing \fBnpm pack\fP\|\. +.P +For example: +.P +If we define a package\.json like this: +.P +.RS 2 +.nf +{ + "name": "awesome\-web\-framework", + "version": "1\.0\.0", + "bundledDependencies": [ + 'renderized', 'super\-streams' + ] +} +.fi +.RE +.P +we can obtain \fBawesome\-web\-framework\-1\.0\.0\.tgz\fP file by running \fBnpm pack\fP\|\. +This file contains the dependencies \fBrenderized\fP and \fBsuper\-streams\fP which +can be installed in a new project by executing \fBnpm install +awesome\-web\-framework\-1\.0\.0\.tgz\fP\|\. .P If this is spelled \fB"bundleDependencies"\fP, then that is also honored\. .SH optionalDependencies |