diff options
Diffstat (limited to 'deps/npm/man/man5/package.json.5')
| -rw-r--r-- | deps/npm/man/man5/package.json.5 | 250 |
1 files changed, 151 insertions, 99 deletions
diff --git a/deps/npm/man/man5/package.json.5 b/deps/npm/man/man5/package.json.5 index ed3ee7c24..f309144b5 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" "June 2015" "" "" +.TH "PACKAGE\.JSON" "5" "August 2015" "" "" .SH "NAME" \fBpackage.json\fR \- Specifics of npm's package\.json handling .SH DESCRIPTION @@ -7,7 +7,7 @@ This document is all you need to know about what's required in your package\.jso file\. It must be actual JSON, not just a JavaScript object literal\. .P A lot of the behavior described in this document is affected by the config -settings described in npm help 7 \fBnpm\-config\fR\|\. +settings described in npm help 7 \fBnpm\-config\fP\|\. .SH name .P The \fImost\fR important things in your package\.json are the name and version fields\. @@ -50,8 +50,8 @@ already, before you get too attached to it\. https://www\.npmjs\.com/ .RE .P -A name can be optionally prefixed by a scope, e\.g\. \fB@myorg/mypackage\fR\|\. See -npm help 7 \fBnpm\-scope\fR for more detail\. +A name can be optionally prefixed by a scope, e\.g\. \fB@myorg/mypackage\fP\|\. See +npm help 7 \fBnpm\-scope\fP for more detail\. .SH version .P The \fImost\fR important things in your package\.json are the name and version fields\. @@ -62,17 +62,17 @@ changes to the version\. .P Version must be parseable by node\-semver \fIhttps://github\.com/isaacs/node\-semver\fR, which is bundled -with npm as a dependency\. (\fBnpm install semver\fR to use it yourself\.) +with npm as a dependency\. (\fBnpm install semver\fP to use it yourself\.) .P More on version numbers and ranges at npm help 7 semver\. .SH description .P Put a description in it\. It's a string\. This helps people discover your -package, as it's listed in \fBnpm search\fR\|\. +package, as it's listed in \fBnpm search\fP\|\. .SH keywords .P Put keywords in it\. It's an array of strings\. This helps people -discover your package as it's listed in \fBnpm search\fR\|\. +discover your package as it's listed in \fBnpm search\fP\|\. .SH homepage .P The url to the project homepage\. @@ -101,7 +101,7 @@ It should look like this: You can specify either one or both values\. If you want to provide only a url, you can specify the value for "bugs" as a simple string instead of an object\. .P -If a url is provided, it will be used by the \fBnpm bugs\fR command\. +If a url is provided, it will be used by the \fBnpm bugs\fP command\. .SH license .P You should specify a license for your package so that people know how they are @@ -134,11 +134,11 @@ you are using a custom license, use the following valid SPDX expression: .P .RS 2 .nf -{ "license" : "LicenseRef\-LICENSE" } +{ "license" : "SEE LICENSE IN <filename>" } .fi .RE .P -Then include a LICENSE file at the top level of the package\. +Then include a file named \fB<filename>\fP at the top level of the package\. .P Some old packages used license objects or a "licenses" property containing an array of license objects: @@ -175,6 +175,17 @@ Those styles are now deprecated\. Instead, use SPDX expressions, like this: { "license": "(MIT OR Apache\-2\.0)" } .fi .RE +.P +Finally, if you do not wish to grant others the right to use a private or +unpublished package under any terms: +.P +.RS 2 +.nf +{ "license": "UNLICENSED"} +.fi +.RE +.P +Consider also setting \fB"private": true\fP to prevent accidental publication\. .SH people fields: author, contributors .P The "author" is one person\. "contributors" is an array of people\. A "person" @@ -210,11 +221,49 @@ 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\. The "\.npmignore" file works just like a "\.gitignore"\. +.P +Certain files are always included, regardless of settings: +.RS 0 +.IP \(bu 2 +\fBpackage\.json\fP +.IP \(bu 2 +\fBREADME\fP (and its variants) +.IP \(bu 2 +\fBCHANGELOG\fP (and its variants) +.IP \(bu 2 +\fBLICENSE\fP / \fBLICENCE\fP + +.RE +.P +Conversely, some files are always ignored: +.RS 0 +.IP \(bu 2 +\fB\|\.git\fP +.IP \(bu 2 +\fBCVS\fP +.IP \(bu 2 +\fB\|\.svn\fP +.IP \(bu 2 +\fB\|\.hg\fP +.IP \(bu 2 +\fB\|\.lock\-wscript\fP +.IP \(bu 2 +\fB\|\.wafpickle\-N\fP +.IP \(bu 2 +\fB*\.swp\fP +.IP \(bu 2 +\fB\|\.DS_Store\fP +.IP \(bu 2 +\fB\|\._*\fP +.IP \(bu 2 +\fBnpm\-debug\.log\fP + +.RE .SH main .P 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\. +That is, if your package is named \fBfoo\fP, and a user installs it, and then does +\fBrequire("foo")\fP, 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 @@ -226,9 +275,9 @@ 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 +To use this, supply a \fBbin\fP field in your package\.json which is a map of command name to local file name\. On install, npm will symlink that file into -\fBprefix/bin\fR for global installs, or \fB\|\./node_modules/\.bin/\fR for local +\fBprefix/bin\fP for global installs, or \fB\|\./node_modules/\.bin/\fP for local installs\. .P For example, myapp could have this: @@ -239,8 +288,8 @@ For example, myapp could have this: .fi .RE .P -So, when you install myapp, it'll create a symlink from the \fBcli\.js\fR script to -\fB/usr/local/bin/myapp\fR\|\. +So, when you install myapp, it'll create a symlink from the \fBcli\.js\fP script to +\fB/usr/local/bin/myapp\fP\|\. .P If you have a single executable, and its name should be the name of the package, then you can just supply it as a string\. For example: @@ -265,10 +314,10 @@ would be the same as this: .SH man .P Specify either a single file or an array of filenames to put in place for the -\fBman\fR program to find\. +\fBman\fP 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: +result from \fBman <pkgname>\fP, regardless of its actual filename\. For example: .P .RS 2 .nf @@ -281,7 +330,7 @@ result from \fBman <pkgname>\fR, regardless of its actual filename\. For exampl .fi .RE .P -would link the \fB\|\./man/doc\.1\fR file in such that it is the target for \fBman foo\fR +would link the \fB\|\./man/doc\.1\fP file in such that it is the target for \fBman foo\fP .P If the filename doesn't start with the package name, then it's prefixed\. So, this: @@ -297,9 +346,9 @@ So, this: .fi .RE .P -will create files to do \fBman foo\fR and \fBman foo\-bar\fR\|\. +will create files to do \fBman foo\fP and \fBman foo\-bar\fP\|\. .P -Man files must end with a number, and optionally a \fB\|\.gz\fR suffix if they are +Man files must end with a number, and optionally a \fB\|\.gz\fP suffix if they are compressed\. The number dictates which man section the file is installed into\. .P .RS 2 @@ -313,11 +362,11 @@ compressed\. The number dictates which man section the file is installed into\. .fi .RE .P -will create entries for \fBman foo\fR and \fBman 2 foo\fR +will create entries for \fBman foo\fP and \fBman 2 foo\fP .SH directories .P 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 +few ways that you can indicate the structure of your package using a \fBdirectories\fP object\. If you look at npm's package\.json \fIhttps://registry\.npmjs\.org/npm/latest\fR, you'll see that it has directories for doc, lib, and man\. .P @@ -328,10 +377,13 @@ Tell people where the bulk of your library is\. Nothing special is done with the lib folder in any way, but it's useful meta info\. .SS directories\.bin .P -If you specify a \fBbin\fR directory, then all the files in that folder will -be added as children of the \fBbin\fR path\. +If you specify a \fBbin\fP directory in \fBdirectories\.bin\fP, all the files in +that folder will be added\. .P -If you have a \fBbin\fR path already, then this has no effect\. +Because of the way the \fBbin\fP directive works, specifying both a +\fBbin\fP path and setting \fBdirectories\.bin\fP is an error\. If you want to +specify individual files, use \fBbin\fP, and for all the files in an +existing \fBbin\fP directory, use \fBdirectories\.bin\fP\|\. .SS directories\.man .P A folder that is full of man pages\. Sugar to generate a "man" array by @@ -346,7 +398,7 @@ Put example scripts in here\. Someday, it might be exposed in some clever way\. .SH repository .P Specify the place where your code lives\. This is helpful for people who -want to contribute\. If the git repo is on GitHub, then the \fBnpm docs\fR +want to contribute\. If the git repo is on GitHub, then the \fBnpm docs\fP command will be able to find you\. .P Do it like this: @@ -370,7 +422,7 @@ directly to a VCS program without any modification\. It should not be a url to html project page that you put in your browser\. It's for computers\. .P For GitHub, GitHub gist, Bitbucket, or GitLab repositories you can use the same -shortcut syntax you use for \fBnpm install\fR: +shortcut syntax you use for \fBnpm install\fP: .P .RS 2 .nf @@ -389,7 +441,7 @@ The "scripts" property is a dictionary containing 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 npm help 7 \fBnpm\-scripts\fR to find out more about writing package scripts\. +See npm help 7 \fBnpm\-scripts\fP to find out more about writing package scripts\. .SH config .P A "config" object can be used to set configuration parameters used in package @@ -404,10 +456,10 @@ following: .RE .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\|\. +\fBnpm_package_config_port\fP environment variable, then the user could +override that by doing \fBnpm config set foo:port 8001\fP\|\. .P -See npm help 7 \fBnpm\-config\fR and npm help 7 \fBnpm\-scripts\fR for more on package +See npm help 7 \fBnpm\-config\fP and npm help 7 \fBnpm\-scripts\fP for more on package configs\. .SH dependencies .P @@ -417,44 +469,44 @@ space\-separated descriptors\. Dependencies can also be identified with a tarball or git URL\. .P \fBPlease do not put test harnesses or transpilers in your -\fBdependencies\fR object\.\fR See \fBdevDependencies\fR, below\. +\fBdependencies\fP object\.\fR See \fBdevDependencies\fP, below\. .P See npm help 7 semver for more details about specifying version ranges\. .RS 0 .IP \(bu 2 -\fBversion\fR Must match \fBversion\fR exactly +\fBversion\fP Must match \fBversion\fP exactly .IP \(bu 2 -\fB>version\fR Must be greater than \fBversion\fR +\fB>version\fP Must be greater than \fBversion\fP .IP \(bu 2 -\fB>=version\fR etc +\fB>=version\fP etc .IP \(bu 2 -\fB<version\fR +\fB<version\fP .IP \(bu 2 -\fB<=version\fR +\fB<=version\fP .IP \(bu 2 -\fB~version\fR "Approximately equivalent to version" See npm help 7 semver +\fB~version\fP "Approximately equivalent to version" See npm help 7 semver .IP \(bu 2 -\fB^version\fR "Compatible with version" See npm help 7 semver +\fB^version\fP "Compatible with version" See npm help 7 semver .IP \(bu 2 -\fB1\.2\.x\fR 1\.2\.0, 1\.2\.1, etc\., but not 1\.3\.0 +\fB1\.2\.x\fP 1\.2\.0, 1\.2\.1, etc\., but not 1\.3\.0 .IP \(bu 2 -\fBhttp://\.\.\.\fR See 'URLs as Dependencies' below +\fBhttp://\.\.\.\fP See 'URLs as Dependencies' below .IP \(bu 2 -\fB*\fR Matches any version +\fB*\fP Matches any version .IP \(bu 2 -\fB""\fR (just an empty string) Same as \fB*\fR +\fB""\fP (just an empty string) Same as \fB*\fP .IP \(bu 2 -\fBversion1 \- version2\fR Same as \fB>=version1 <=version2\fR\|\. +\fBversion1 \- version2\fP Same as \fB>=version1 <=version2\fP\|\. .IP \(bu 2 -\fBrange1 || range2\fR Passes if either range1 or range2 are satisfied\. +\fBrange1 || range2\fP Passes if either range1 or range2 are satisfied\. .IP \(bu 2 -\fBgit\.\.\.\fR See 'Git URLs as Dependencies' below +\fBgit\.\.\.\fP See 'Git URLs as Dependencies' below .IP \(bu 2 -\fBuser/repo\fR See 'GitHub URLs' below +\fBuser/repo\fP See 'GitHub URLs' below .IP \(bu 2 -\fBtag\fR A specific version tagged and published as \fBtag\fR See npm help \fBnpm\-tag\fR +\fBtag\fP A specific version tagged and published as \fBtag\fP See npm help \fBnpm\-tag\fP .IP \(bu 2 -\fBpath/path/path\fR See Local Paths below +\fBpath/path/path\fP See Local Paths below .RE .P @@ -499,12 +551,12 @@ git+https://user@hostname/project/blah\.git#commit\-ish .fi .RE .P -The \fBcommit\-ish\fR can be any tag, sha, or branch which can be supplied as -an argument to \fBgit checkout\fR\|\. The default is \fBmaster\fR\|\. +The \fBcommit\-ish\fP can be any tag, sha, or branch which can be supplied as +an argument to \fBgit checkout\fP\|\. The default is \fBmaster\fP\|\. .SH GitHub URLs .P As of version 1\.1\.65, you can refer to GitHub urls as just "foo": -"user/foo\-project"\. Just as with git URLs, a \fBcommit\-ish\fR suffix can be +"user/foo\-project"\. Just as with git URLs, a \fBcommit\-ish\fP suffix can be included\. For example: .P .RS 2 @@ -522,7 +574,7 @@ included\. For example: .SH Local Paths .P As of version 2\.0\.0 you can provide a path to a local directory that contains a -package\. Local paths can be saved using \fBnpm install \-\-save\fR, using any of +package\. Local paths can be saved using \fBnpm install \-\-save\fP, using any of these forms: .P .RS 2 @@ -535,7 +587,7 @@ these forms: .RE .P in which case they will be normalized to a relative path and added to your -\fBpackage\.json\fR\|\. For example: +\fBpackage\.json\fP\|\. For example: .P .RS 2 .nf @@ -558,15 +610,15 @@ If someone is planning on downloading and using your module in their program, then they probably don't want or need to download and build the external test or documentation framework that you use\. .P -In this case, it's best to map these additional items in a \fBdevDependencies\fR +In this case, it's best to map these additional items in a \fBdevDependencies\fP object\. .P -These things will be installed when doing \fBnpm link\fR or \fBnpm install\fR +These things will be installed when doing \fBnpm link\fP or \fBnpm install\fP from the root of a package, and can be managed like any other npm -configuration param\. See npm help 7 \fBnpm\-config\fR for more on the topic\. +configuration param\. See npm help 7 \fBnpm\-config\fP for more on the topic\. .P For build steps that are not platform\-specific, such as compiling -CoffeeScript or other languages to JavaScript, use the \fBprepublish\fR +CoffeeScript or other languages to JavaScript, use the \fBprepublish\fP script to do this, and make the required package a devDependency\. .P For example: @@ -587,14 +639,14 @@ For example: .fi .RE .P -The \fBprepublish\fR script will be run before publishing, so that users +The \fBprepublish\fP script will be run before publishing, so that users can consume the functionality without requiring them to compile it -themselves\. In dev mode (ie, locally running \fBnpm install\fR), it'll +themselves\. In dev mode (ie, locally running \fBnpm install\fP), it'll run this script as well, so that you can test it easily\. .SH peerDependencies .P In some cases, you want to express the compatibility of your package with a -host tool or library, while not necessarily doing a \fBrequire\fR of this host\. +host tool or library, while not necessarily doing a \fBrequire\fP of this host\. This is usually referred to as a \fIplugin\fR\|\. Notably, your module may be exposing a specific interface, expected and specified by the host documentation\. .P @@ -612,8 +664,8 @@ For example: .fi .RE .P -This ensures your package \fBtea\-latte\fR can be installed \fIalong\fR with the second -major version of the host package \fBtea\fR only\. \fBnpm install tea\-latte\fR could +This ensures your package \fBtea\-latte\fP can be installed \fIalong\fR with the second +major version of the host package \fBtea\fP only\. \fBnpm install tea\-latte\fP could possibly yield the following dependency graph: .P .RS 2 @@ -623,7 +675,7 @@ possibly yield the following dependency graph: .fi .RE .P -\fBNOTE: npm versions 1 and 2 will automatically install \fBpeerDependencies\fR if +\fBNOTE: npm versions 1 and 2 will automatically install \fBpeerDependencies\fP if they are not explicitly depended upon higher in the dependency tree\. In the next major version of npm (npm@3), this will no longer be the case\. You will receive a warning that the peerDependency is not installed instead\.\fR The @@ -636,19 +688,19 @@ possible, and not to lock it down to specific patch versions\. .P Assuming the host complies with semver \fIhttp://semver\.org/\fR, only changes in the host package's major version will break your plugin\. Thus, if you've worked -with every 1\.x version of the host package, use \fB"^1\.0"\fR or \fB"1\.x"\fR to express -this\. If you depend on features introduced in 1\.5\.2, use \fB">= 1\.5\.2 < 2"\fR\|\. +with every 1\.x version of the host package, use \fB"^1\.0"\fP or \fB"1\.x"\fP to express +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\. .P -If this is spelled \fB"bundleDependencies"\fR, then that is also honorable\. +If this is spelled \fB"bundleDependencies"\fP, then that is also honorable\. .SH optionalDependencies .P If a dependency can be used, but you would like npm to proceed if it cannot be -found or fails to install, then you may put it in the \fBoptionalDependencies\fR +found or fails to install, then you may put it in the \fBoptionalDependencies\fP object\. This is a map of package name to version or url, just like the -\fBdependencies\fR object\. The difference is that build failures do not cause +\fBdependencies\fP object\. The difference is that build failures do not cause installation to fail\. .P It is still your program's responsibility to handle the lack of the @@ -674,8 +726,8 @@ if (foo) { .fi .RE .P -Entries in \fBoptionalDependencies\fR will override entries of the same name in -\fBdependencies\fR, so it's usually best to only put in one place\. +Entries in \fBoptionalDependencies\fP will override entries of the same name in +\fBdependencies\fP, so it's usually best to only put in one place\. .SH engines .P You can specify the version of node that your stuff works on: @@ -702,16 +754,16 @@ are capable of properly installing your program\. For example: .fi .RE .P -Note that, unless the user has set the \fBengine\-strict\fR config flag, this +Note that, unless the user has set the \fBengine\-strict\fP config flag, this field is advisory only\. .SH engineStrict .P \fBNOTE: This feature is deprecated and will be removed in npm 3\.0\.0\.\fR .P If you are sure that your module will \fIdefinitely not\fR run properly on -versions of Node/npm other than those specified in the \fBengines\fR object, -then you can set \fB"engineStrict": true\fR in your package\.json file\. -This will override the user's \fBengine\-strict\fR config setting\. +versions of Node/npm other than those specified in the \fBengines\fP object, +then you can set \fB"engineStrict": true\fP in your package\.json file\. +This will override the user's \fBengine\-strict\fP config setting\. .P Please do not do this unless you are really very very sure\. If your engines object is something overly restrictive, you can quite easily and @@ -737,7 +789,7 @@ just prepend the blacklisted os with a '!': .fi .RE .P -The host operating system is determined by \fBprocess\.platform\fR +The host operating system is determined by \fBprocess\.platform\fP .P It is allowed to both blacklist, and whitelist, although there isn't any good reason to do this\. @@ -752,7 +804,7 @@ you can specify which ones\. .fi .RE .P -Like the \fBos\fR option, you can also blacklist architectures: +Like the \fBos\fP option, you can also blacklist architectures: .P .RS 2 .nf @@ -760,54 +812,54 @@ Like the \fBos\fR option, you can also blacklist architectures: .fi .RE .P -The host architecture is determined by \fBprocess\.arch\fR +The host architecture is determined by \fBprocess\.arch\fP .SH preferGlobal .P If your package is primarily a command\-line application that should be -installed globally, then set this value to \fBtrue\fR to provide a warning +installed globally, then set this value to \fBtrue\fP to provide a warning if it is installed locally\. .P It doesn't actually prevent users from installing it locally, but it does help prevent some confusion if it doesn't work as expected\. .SH private .P -If you set \fB"private": true\fR in your package\.json, then npm will refuse +If you set \fB"private": true\fP in your package\.json, then npm will refuse to publish it\. .P This is a way to prevent accidental publication of private repositories\. If you would like to ensure that a given package is only ever published to a specific registry (for example, an internal registry), then use the -\fBpublishConfig\fR dictionary described below to override the \fBregistry\fR config +\fBpublishConfig\fP dictionary described below to override the \fBregistry\fP config param at publish\-time\. .SH publishConfig .P -This is a set of config values that will be used at publish\-time\. It's -especially handy if you want to set the tag or registry, so that you can -ensure that a given package is not tagged with "latest" or published to -the global public registry by default\. +This is a set of config values that will be used at publish\-time\. It's +especially handy if you want to set the tag, registry or access, so that +you can ensure that a given package is not tagged with "latest", published +to the global public registry or that a scoped module is private by default\. .P -Any config values can be overridden, but of course only "tag" and -"registry" probably matter for the purposes of publishing\. +Any config values can be overridden, but of course only "tag", "registry" and +"access" probably matter for the purposes of publishing\. .P -See npm help 7 \fBnpm\-config\fR to see the list of config options that can be +See npm help 7 \fBnpm\-config\fP to see the list of config options that can be overridden\. .SH DEFAULT VALUES .P npm will default some values based on package contents\. .RS 0 .IP \(bu 2 -\fB"scripts": {"start": "node server\.js"}\fR -If there is a \fBserver\.js\fR file in the root of your package, then npm -will default the \fBstart\fR command to \fBnode server\.js\fR\|\. +\fB"scripts": {"start": "node server\.js"}\fP +If there is a \fBserver\.js\fP file in the root of your package, then npm +will default the \fBstart\fP command to \fBnode server\.js\fP\|\. .IP \(bu 2 -\fB"scripts":{"preinstall": "node\-gyp rebuild"}\fR -If there is a \fBbinding\.gyp\fR file in the root of your package, npm will -default the \fBpreinstall\fR command to compile using node\-gyp\. +\fB"scripts":{"preinstall": "node\-gyp rebuild"}\fP +If there is a \fBbinding\.gyp\fP file in the root of your package, npm will +default the \fBpreinstall\fP command to compile using node\-gyp\. .IP \(bu 2 -\fB"contributors": [\.\.\.]\fR -If there is an \fBAUTHORS\fR file in the root of your package, npm will -treat each line as a \fBName <email> (url)\fR format, where email and url -are optional\. Lines which start with a \fB#\fR or are blank, will be +\fB"contributors": [\.\.\.]\fP +If there is an \fBAUTHORS\fP file in the root of your package, npm will +treat each line as a \fBName <email> (url)\fP format, where email and url +are optional\. Lines which start with a \fB#\fP or are blank, will be ignored\. .RE |