@ -3,6 +3,7 @@
< title > package.json< / title > < title > package.json< / title >
< meta http-equiv = "content-type" value = "text/html;utf-8" > < meta http-equiv = "content-type" value = "text/html;utf-8" >
< link rel = "stylesheet" type = "text/css" href = "../../static/style.css" > < link rel = "stylesheet" type = "text/css" href = "../../static/style.css" >
< link rel = "canonical" href = "https://www.npmjs.org/doc/files/package.json.html" >
< script async = true src = "../../static/toc.js" > < / script > < script async = true src = "../../static/toc.js" > < / script >
< body > < body >
@ -396,6 +397,40 @@ can consume the functionality without requiring them to compile it
themselves. In dev mode (ie, locally running < code > npm install< / code > ), it' llthemselves. In dev mode (ie, locally running < code > npm install< / code > ), it' ll
run this script as well, so that you can test it easily.< / p > run this script as well, so that you can test it easily.< / p >
< h2 id = "peerDependencies" > peerDependencies< / h2 >
< p > In some cases, you want to express the compatibility of your package with an
host tool or library, while not necessarily doing a < code > require< / code > of this host.
This is usually refered to as a < em > plugin< / em > . Notably, your module may be exposing
a specific interface, expected and specified by the host documentation.< / p >
< p > For example:< / p >
< pre > < code > {
" name" : " tea-latte" ,
" version" : " 1.3.5"
" peerDependencies" : {
" tea" : " 2.x"
}
}< / code > < / pre >
< p > This ensures your package < code > tea-latte< / code > can be installed < em > along< / em > with the second
major version of the host package < code > tea< / code > only. The host package is automatically
installed if needed. < code > npm install tea-latte< / code > could possibly yield the following
dependency graph:< / p >
< pre > < code > ├── tea-latte@1.3.5
└── tea@2.2.0< / code > < / pre >
< p > Trying to install another plugin with a conflicting requirement will cause an
error. For this reason, make sure your plugin requirement is as broad as
possible, and not to lock it down to specific patch versions.< / p >
< p > Assuming the host complies with < a href = "http://semver.org/" > semver< / a > , 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 < code > " ^1.0" < / code > or < code > " 1.x" < / code > to express
this. If you depend on features introduced in 1.5.2, use < code > " > = 1.5.2 < 2" < / code > .< / p >
< h2 id = "bundledDependencies" > bundledDependencies< / h2 > < h2 id = "bundledDependencies" > bundledDependencies< / h2 >
< p > Array of package names that will be bundled when publishing the package.< / p > < p > Array of package names that will be bundled when publishing the package.< / p >
@ -554,5 +589,5 @@ ignored.</p></li></ul>
< tr > < td style = "width:60px;height:10px;background:rgb(237,127,127)" colspan = 6 > < / td > < td colspan = 10 style = "width:10px;height:10px;background:rgb(237,127,127)" > < / td > < / tr > < tr > < td style = "width:60px;height:10px;background:rgb(237,127,127)" colspan = 6 > < / td > < td colspan = 10 style = "width:10px;height:10px;background:rgb(237,127,127)" > < / td > < / tr >
< tr > < td colspan = 5 style = "width:50px;height:10px;background:#fff" > < / td > < td style = "width:40px;height:10px;background:rgb(237,127,127)" colspan = 4 > < / td > < td style = "width:90px;height:10px;background:#fff" colspan = 9 > < / td > < / tr > < tr > < td colspan = 5 style = "width:50px;height:10px;background:#fff" > < / td > < td style = "width:40px;height:10px;background:rgb(237,127,127)" colspan = 4 > < / td > < td style = "width:90px;height:10px;background:#fff" colspan = 9 > < / td > < / tr >
< / table > < / table >
< p id = "footer" > package.json — npm@1.4.6 < / p > < p id = "footer" > package.json — npm@1.4.7 < / p >
isaacs
11 years ago