deps/npm/html/doc/files/npm-json.html

   1 <!doctype html>
   2 <html>
   3   <title>package.json</title>
   4   <meta http-equiv="content-type" value="text/html;utf-8">
   5   <link rel="stylesheet" type="text/css" href="../../static/style.css">
   6   <link rel="canonical" href="https://www.npmjs.org/doc/files/package.json.html">
   7   <script async=true src="../../static/toc.js"></script>
   8
   9   <body>
  10     <div id="wrapper">
  11
  12 <h1><a href="../files/package.json.html">package.json</a></h1> <p>Specifics of npm&#39;s package.json handling</p>
  13 <h2 id="description">DESCRIPTION</h2>
  14 <p>This document is all you need to know about what&#39;s required in your package.json
  15 file.  It must be actual JSON, not just a JavaScript object literal.</p>
  16 <p>A lot of the behavior described in this document is affected by the config
  17 settings described in <code><a href="../misc/npm-config.html">npm-config(7)</a></code>.</p>
  18 <h2 id="name">name</h2>
  19 <p>The <em>most</em> important things in your package.json are the name and version fields.
  20 Those are actually required, and your package won&#39;t install without
  21 them.  The name and version together form an identifier that is assumed
  22 to be completely unique.  Changes to the package should come along with
  23 changes to the version.</p>
  24 <p>The name is what your thing is called.</p>
  25 <p>Some rules:</p>
  26 <ul>
  27 <li>The name must be less than or equal to 214 characters. This includes the scope for
  28 scoped packages.</li>
  29 <li>The name can&#39;t start with a dot or an underscore.</li>
  30 <li>New packages must not have uppercase letters in the name.</li>
  31 <li>The name ends up being part of a URL, an argument on the command line, and a
  32 folder name. Therefore, the name can&#39;t contain any non-URL-safe characters.</li>
  33 </ul>
  34 <p>Some tips:</p>
  35 <ul>
  36 <li>Don&#39;t use the same name as a core Node module.</li>
  37 <li>Don&#39;t put &quot;js&quot; or &quot;node&quot; in the name.  It&#39;s assumed that it&#39;s js, since you&#39;re
  38 writing a package.json file, and you can specify the engine using the &quot;engines&quot;
  39 field.  (See below.)</li>
  40 <li>The name will probably be passed as an argument to require(), so it should
  41 be something short, but also reasonably descriptive.</li>
  42 <li>You may want to check the npm registry to see if there&#39;s something by that name
  43 already, before you get too attached to it. <a href="https://www.npmjs.com/">https://www.npmjs.com/</a></li>
  44 </ul>
  45 <p>A name can be optionally prefixed by a scope, e.g. <code>@myorg/mypackage</code>. See
  46 <code><a href="../misc/npm-scope.html">npm-scope(7)</a></code> for more detail.</p>
  47 <h2 id="version">version</h2>
  48 <p>The <em>most</em> important things in your package.json are the name and version fields.
  49 Those are actually required, and your package won&#39;t install without
  50 them.  The name and version together form an identifier that is assumed
  51 to be completely unique.  Changes to the package should come along with
  52 changes to the version.</p>
  53 <p>Version must be parseable by
  54 <a href="https://github.com/isaacs/node-semver">node-semver</a>, which is bundled
  55 with npm as a dependency.  (<code>npm install semver</code> to use it yourself.)</p>
  56 <p>More on version numbers and ranges at <a href="../misc/semver.html">semver(7)</a>.</p>
  57 <h2 id="description">description</h2>
  58 <p>Put a description in it.  It&#39;s a string.  This helps people discover your
  59 package, as it&#39;s listed in <code>npm search</code>.</p>
  60 <h2 id="keywords">keywords</h2>
  61 <p>Put keywords in it.  It&#39;s an array of strings.  This helps people
  62 discover your package as it&#39;s listed in <code>npm search</code>.</p>
  63 <h2 id="homepage">homepage</h2>
  64 <p>The url to the project homepage.</p>
  65 <p><strong>NOTE</strong>: This is <em>not</em> the same as &quot;url&quot;.  If you put a &quot;url&quot; field,
  66 then the registry will think it&#39;s a redirection to your package that has
  67 been published somewhere else, and spit at you.</p>
  68 <p>Literally.  Spit.  I&#39;m so not kidding.</p>
  69 <h2 id="bugs">bugs</h2>
  70 <p>The url to your project&#39;s issue tracker and / or the email address to which
  71 issues should be reported. These are helpful for people who encounter issues
  72 with your package.</p>
  73 <p>It should look like this:</p>
  74 <pre><code>{ &quot;url&quot; : &quot;https://github.com/owner/project/issues&quot;
  75 , &quot;email&quot; : &quot;project@hostname.com&quot;
  76 }
  77 </code></pre><p>You can specify either one or both values. If you want to provide only a url,
  78 you can specify the value for &quot;bugs&quot; as a simple string instead of an object.</p>
  79 <p>If a url is provided, it will be used by the <code>npm bugs</code> command.</p>
  80 <h2 id="license">license</h2>
  81 <p>You should specify a license for your package so that people know how they are
  82 permitted to use it, and any restrictions you&#39;re placing on it.</p>
  83 <p>If you&#39;re using a common license such as BSD-2-Clause or MIT, add a
  84 current SPDX license identifier for the license you&#39;re using, like this:</p>
  85 <pre><code>{ &quot;license&quot; : &quot;BSD-3-Clause&quot; }
  86 </code></pre><p>You can check <a href="https://spdx.org/licenses/">the full list of SPDX license IDs</a>.
  87 Ideally you should pick one that is
  88 <a href="https://opensource.org/licenses/alphabetical">OSI</a> approved.</p>
  89 <p>If your package is licensed under multiple common licenses, use an <a href="https://npmjs.com/package/spdx">SPDX license
  90 expression syntax version 2.0 string</a>, like this:</p>
  91 <pre><code>{ &quot;license&quot; : &quot;(ISC OR GPL-3.0)&quot; }
  92 </code></pre><p>If you are using a license that hasn&#39;t been assigned an SPDX identifier, or if
  93 you are using a custom license, use a string value like this one:</p>
  94 <pre><code>{ &quot;license&quot; : &quot;SEE LICENSE IN &lt;filename&gt;&quot; }
  95 </code></pre><p>Then include a file named <code>&lt;filename&gt;</code> at the top level of the package.</p>
  96 <p>Some old packages used license objects or a &quot;licenses&quot; property containing an
  97 array of license objects:</p>
  98 <pre><code>// Not valid metadata
  99 { &quot;license&quot; :
 100   { &quot;type&quot; : &quot;ISC&quot;
 101   , &quot;url&quot; : &quot;http://opensource.org/licenses/ISC&quot;
 102   }
 103 }
 104
 105 // Not valid metadata
 106 { &quot;licenses&quot; :
 107   [
 108     { &quot;type&quot;: &quot;MIT&quot;
 109     , &quot;url&quot;: &quot;http://www.opensource.org/licenses/mit-license.php&quot;
 110     }
 111   , { &quot;type&quot;: &quot;Apache-2.0&quot;
 112     , &quot;url&quot;: &quot;http://opensource.org/licenses/apache2.0.php&quot;
 113     }
 114   ]
 115 }
 116 </code></pre><p>Those styles are now deprecated. Instead, use SPDX expressions, like this:</p>
 117 <pre><code>{ &quot;license&quot;: &quot;ISC&quot; }
 118
 119 { &quot;license&quot;: &quot;(MIT OR Apache-2.0)&quot; }
 120 </code></pre><p>Finally, if you do not wish to grant others the right to use a private or
 121 unpublished package under any terms:</p>
 122 <pre><code>{ &quot;license&quot;: &quot;UNLICENSED&quot;}
 123 </code></pre><p>Consider also setting <code>&quot;private&quot;: true</code> to prevent accidental publication.</p>
 124 <h2 id="people-fields-author-contributors">people fields: author, contributors</h2>
 125 <p>The &quot;author&quot; is one person.  &quot;contributors&quot; is an array of people.  A &quot;person&quot;
 126 is an object with a &quot;name&quot; field and optionally &quot;url&quot; and &quot;email&quot;, like this:</p>
 127 <pre><code>{ &quot;name&quot; : &quot;Barney Rubble&quot;
 128 , &quot;email&quot; : &quot;b@rubble.com&quot;
 129 , &quot;url&quot; : &quot;http://barnyrubble.tumblr.com/&quot;
 130 }
 131 </code></pre><p>Or you can shorten that all into a single string, and npm will parse it for you:</p>
 132 <pre><code>&quot;Barney Rubble &lt;b@rubble.com&gt; (http://barnyrubble.tumblr.com/)&quot;
 133 </code></pre><p>Both email and url are optional either way.</p>
 134 <p>npm also sets a top-level &quot;maintainers&quot; field with your npm user info.</p>
 135 <h2 id="files">files</h2>
 136 <p>The &quot;files&quot; field is an array of files to include in your project.  If
 137 you name a folder in the array, then it will also include the files
 138 inside that folder. (Unless they would be ignored by another rule.)</p>
 139 <p>You can also provide a &quot;.npmignore&quot; file in the root of your package or
 140 in subdirectories, which will keep files from being included, even
 141 if they would be picked up by the files array.  The <code>.npmignore</code> file
 142 works just like a <code>.gitignore</code>.</p>
 143 <p>Certain files are always included, regardless of settings:</p>
 144 <ul>
 145 <li><code>package.json</code></li>
 146 <li><code><a href="../../doc/README.html">README</a></code></li>
 147 <li><code>CHANGES</code> / <code>CHANGELOG</code> / <code>HISTORY</code> (any casing and file extension)</li>
 148 <li><code>LICENSE</code> / <code>LICENCE</code></li>
 149 <li>The file in the &quot;main&quot; field</li>
 150 </ul>
 151 <p>Conversely, some files are always ignored:</p>
 152 <ul>
 153 <li><code>.git</code></li>
 154 <li><code>CVS</code></li>
 155 <li><code>.svn</code></li>
 156 <li><code>.hg</code></li>
 157 <li><code>.lock-wscript</code></li>
 158 <li><code>.wafpickle-N</code></li>
 159 <li><code>.*.swp</code></li>
 160 <li><code>.DS_Store</code></li>
 161 <li><code>._*</code></li>
 162 <li><code>npm-debug.log</code></li>
 163 <li><code>.npmrc</code></li>
 164 </ul>
 165 <h2 id="main">main</h2>
 166 <p>The main field is a module ID that is the primary entry point to your program.
 167 That is, if your package is named <code>foo</code>, and a user installs it, and then does
 168 <code>require(&quot;foo&quot;)</code>, then your main module&#39;s exports object will be returned.</p>
 169 <p>This should be a module ID relative to the root of your package folder.</p>
 170 <p>For most modules, it makes the most sense to have a main script and often not
 171 much else.</p>
 172 <h2 id="bin">bin</h2>
 173 <p>A lot of packages have one or more executable files that they&#39;d like to
 174 install into the PATH. npm makes this pretty easy (in fact, it uses this
 175 feature to install the &quot;npm&quot; executable.)</p>
 176 <p>To use this, supply a <code>bin</code> field in your package.json which is a map of
 177 command name to local file name. On install, npm will symlink that file into
 178 <code>prefix/bin</code> for global installs, or <code>./node_modules/.bin/</code> for local
 179 installs.</p>
 180 <p>For example, myapp could have this:</p>
 181 <pre><code>{ &quot;bin&quot; : { &quot;myapp&quot; : &quot;./cli.js&quot; } }
 182 </code></pre><p>So, when you install myapp, it&#39;ll create a symlink from the <code>cli.js</code> script to
 183 <code>/usr/local/bin/myapp</code>.</p>
 184 <p>If you have a single executable, and its name should be the name
 185 of the package, then you can just supply it as a string.  For example:</p>
 186 <pre><code>{ &quot;name&quot;: &quot;my-program&quot;
 187 , &quot;version&quot;: &quot;1.2.5&quot;
 188 , &quot;bin&quot;: &quot;./path/to/program&quot; }
 189 </code></pre><p>would be the same as this:</p>
 190 <pre><code>{ &quot;name&quot;: &quot;my-program&quot;
 191 , &quot;version&quot;: &quot;1.2.5&quot;
 192 , &quot;bin&quot; : { &quot;my-program&quot; : &quot;./path/to/program&quot; } }
 193 </code></pre><h2 id="man">man</h2>
 194 <p>Specify either a single file or an array of filenames to put in place for the
 195 <code>man</code> program to find.</p>
 196 <p>If only a single file is provided, then it&#39;s installed such that it is the
 197 result from <code>man &lt;pkgname&gt;</code>, regardless of its actual filename.  For example:</p>
 198 <pre><code>{ &quot;name&quot; : &quot;foo&quot;
 199 , &quot;version&quot; : &quot;1.2.3&quot;
 200 , &quot;description&quot; : &quot;A packaged foo fooer for fooing foos&quot;
 201 , &quot;main&quot; : &quot;foo.js&quot;
 202 , &quot;man&quot; : &quot;./man/doc.1&quot;
 203 }
 204 </code></pre><p>would link the <code>./man/doc.1</code> file in such that it is the target for <code>man foo</code></p>
 205 <p>If the filename doesn&#39;t start with the package name, then it&#39;s prefixed.
 206 So, this:</p>
 207 <pre><code>{ &quot;name&quot; : &quot;foo&quot;
 208 , &quot;version&quot; : &quot;1.2.3&quot;
 209 , &quot;description&quot; : &quot;A packaged foo fooer for fooing foos&quot;
 210 , &quot;main&quot; : &quot;foo.js&quot;
 211 , &quot;man&quot; : [ &quot;./man/foo.1&quot;, &quot;./man/bar.1&quot; ]
 212 }
 213 </code></pre><p>will create files to do <code>man foo</code> and <code>man foo-bar</code>.</p>
 214 <p>Man files must end with a number, and optionally a <code>.gz</code> suffix if they are
 215 compressed.  The number dictates which man section the file is installed into.</p>
 216 <pre><code>{ &quot;name&quot; : &quot;foo&quot;
 217 , &quot;version&quot; : &quot;1.2.3&quot;
 218 , &quot;description&quot; : &quot;A packaged foo fooer for fooing foos&quot;
 219 , &quot;main&quot; : &quot;foo.js&quot;
 220 , &quot;man&quot; : [ &quot;./man/foo.1&quot;, &quot;./man/foo.2&quot; ]
 221 }
 222 </code></pre><p>will create entries for <code>man foo</code> and <code>man 2 foo</code></p>
 223 <h2 id="directories">directories</h2>
 224 <p>The CommonJS <a href="http://wiki.commonjs.org/wiki/Packages/1.0">Packages</a> spec details a
 225 few ways that you can indicate the structure of your package using a <code>directories</code>
 226 object. If you look at <a href="https://registry.npmjs.org/npm/latest">npm&#39;s package.json</a>,
 227 you&#39;ll see that it has directories for doc, lib, and man.</p>
 228 <p>In the future, this information may be used in other creative ways.</p>
 229 <h3 id="directories-lib">directories.lib</h3>
 230 <p>Tell people where the bulk of your library is.  Nothing special is done
 231 with the lib folder in any way, but it&#39;s useful meta info.</p>
 232 <h3 id="directories-bin">directories.bin</h3>
 233 <p>If you specify a <code>bin</code> directory in <code>directories.bin</code>, all the files in
 234 that folder will be added.</p>
 235 <p>Because of the way the <code>bin</code> directive works, specifying both a
 236 <code>bin</code> path and setting <code>directories.bin</code> is an error. If you want to
 237 specify individual files, use <code>bin</code>, and for all the files in an
 238 existing <code>bin</code> directory, use <code>directories.bin</code>.</p>
 239 <h3 id="directories-man">directories.man</h3>
 240 <p>A folder that is full of man pages.  Sugar to generate a &quot;man&quot; array by
 241 walking the folder.</p>
 242 <h3 id="directories-doc">directories.doc</h3>
 243 <p>Put markdown files in here.  Eventually, these will be displayed nicely,
 244 maybe, someday.</p>
 245 <h3 id="directories-example">directories.example</h3>
 246 <p>Put example scripts in here.  Someday, it might be exposed in some clever way.</p>
 247 <h3 id="directories-test">directories.test</h3>
 248 <p>Put your tests in here. It is currently not exposed, but it might be in the
 249 future.</p>
 250 <h2 id="repository">repository</h2>
 251 <p>Specify the place where your code lives. This is helpful for people who
 252 want to contribute.  If the git repo is on GitHub, then the <code>npm docs</code>
 253 command will be able to find you.</p>
 254 <p>Do it like this:</p>
 255 <pre><code>&quot;repository&quot; :
 256   { &quot;type&quot; : &quot;git&quot;
 257   , &quot;url&quot; : &quot;https://github.com/npm/npm.git&quot;
 258   }
 259
 260 &quot;repository&quot; :
 261   { &quot;type&quot; : &quot;svn&quot;
 262   , &quot;url&quot; : &quot;https://v8.googlecode.com/svn/trunk/&quot;
 263   }
 264 </code></pre><p>The URL should be a publicly available (perhaps read-only) url that can be handed
 265 directly to a VCS program without any modification.  It should not be a url to an
 266 html project page that you put in your browser.  It&#39;s for computers.</p>
 267 <p>For GitHub, GitHub gist, Bitbucket, or GitLab repositories you can use the same
 268 shortcut syntax you use for <code>npm install</code>:</p>
 269 <pre><code>&quot;repository&quot;: &quot;npm/npm&quot;
 270
 271 &quot;repository&quot;: &quot;gist:11081aaa281&quot;
 272
 273 &quot;repository&quot;: &quot;bitbucket:example/repo&quot;
 274
 275 &quot;repository&quot;: &quot;gitlab:another/repo&quot;
 276 </code></pre><h2 id="scripts">scripts</h2>
 277 <p>The &quot;scripts&quot; property is a dictionary containing script commands that are run
 278 at various times in the lifecycle of your package.  The key is the lifecycle
 279 event, and the value is the command to run at that point.</p>
 280 <p>See <code><a href="../misc/npm-scripts.html">npm-scripts(7)</a></code> to find out more about writing package scripts.</p>
 281 <h2 id="config">config</h2>
 282 <p>A &quot;config&quot; object can be used to set configuration parameters used in package
 283 scripts that persist across upgrades.  For instance, if a package had the
 284 following:</p>
 285 <pre><code>{ &quot;name&quot; : &quot;foo&quot;
 286 , &quot;config&quot; : { &quot;port&quot; : &quot;8080&quot; } }
 287 </code></pre><p>and then had a &quot;start&quot; command that then referenced the
 288 <code>npm_package_config_port</code> environment variable, then the user could
 289 override that by doing <code>npm config set foo:port 8001</code>.</p>
 290 <p>See <code><a href="../misc/npm-config.html">npm-config(7)</a></code> and <code><a href="../misc/npm-scripts.html">npm-scripts(7)</a></code> for more on package
 291 configs.</p>
 292 <h2 id="dependencies">dependencies</h2>
 293 <p>Dependencies are specified in a simple object that maps a package name to a
 294 version range. The version range is a string which has one or more
 295 space-separated descriptors.  Dependencies can also be identified with a
 296 tarball or git URL.</p>
 297 <p><strong>Please do not put test harnesses or transpilers in your
 298 <code>dependencies</code> object.</strong>  See <code>devDependencies</code>, below.</p>
 299 <p>See <a href="../misc/semver.html">semver(7)</a> for more details about specifying version ranges.</p>
 300 <ul>
 301 <li><code>version</code> Must match <code>version</code> exactly</li>
 302 <li><code>&gt;version</code> Must be greater than <code>version</code></li>
 303 <li><code>&gt;=version</code> etc</li>
 304 <li><code>&lt;version</code></li>
 305 <li><code>&lt;=version</code></li>
 306 <li><code>~version</code> &quot;Approximately equivalent to version&quot;  See <a href="../misc/semver.html">semver(7)</a></li>
 307 <li><code>^version</code> &quot;Compatible with version&quot;  See <a href="../misc/semver.html">semver(7)</a></li>
 308 <li><code>1.2.x</code> 1.2.0, 1.2.1, etc., but not 1.3.0</li>
 309 <li><code>http://...</code> See &#39;URLs as Dependencies&#39; below</li>
 310 <li><code>*</code> Matches any version</li>
 311 <li><code>&quot;&quot;</code> (just an empty string) Same as <code>*</code></li>
 312 <li><code>version1 - version2</code> Same as <code>&gt;=version1 &lt;=version2</code>.</li>
 313 <li><code>range1 || range2</code> Passes if either range1 or range2 are satisfied.</li>
 314 <li><code>git...</code> See &#39;Git URLs as Dependencies&#39; below</li>
 315 <li><code>user/repo</code> See &#39;GitHub URLs&#39; below</li>
 316 <li><code>tag</code> A specific version tagged and published as <code>tag</code>  See <code><a href="../cli/npm-tag.html">npm-tag(1)</a></code></li>
 317 <li><code>path/path/path</code> See <a href="#local-paths">Local Paths</a> below</li>
 318 </ul>
 319 <p>For example, these are all valid:</p>
 320 <pre><code>{ &quot;dependencies&quot; :
 321   { &quot;foo&quot; : &quot;1.0.0 - 2.9999.9999&quot;
 322   , &quot;bar&quot; : &quot;&gt;=1.0.2 &lt;2.1.2&quot;
 323   , &quot;baz&quot; : &quot;&gt;1.0.2 &lt;=2.3.4&quot;
 324   , &quot;boo&quot; : &quot;2.0.1&quot;
 325   , &quot;qux&quot; : &quot;&lt;1.0.0 || &gt;=2.3.1 &lt;2.4.5 || &gt;=2.5.2 &lt;3.0.0&quot;
 326   , &quot;asd&quot; : &quot;http://asdf.com/asdf.tar.gz&quot;
 327   , &quot;til&quot; : &quot;~1.2&quot;
 328   , &quot;elf&quot; : &quot;~1.2.3&quot;
 329   , &quot;two&quot; : &quot;2.x&quot;
 330   , &quot;thr&quot; : &quot;3.3.x&quot;
 331   , &quot;lat&quot; : &quot;latest&quot;
 332   , &quot;dyl&quot; : &quot;file:../dyl&quot;
 333   }
 334 }
 335 </code></pre><h3 id="urls-as-dependencies">URLs as Dependencies</h3>
 336 <p>You may specify a tarball URL in place of a version range.</p>
 337 <p>This tarball will be downloaded and installed locally to your package at
 338 install time.</p>
 339 <h3 id="git-urls-as-dependencies">Git URLs as Dependencies</h3>
 340 <p>Git urls can be of the form:</p>
 341 <pre><code>git://github.com/user/project.git#commit-ish
 342 git+ssh://user@hostname:project.git#commit-ish
 343 git+ssh://user@hostname/project.git#commit-ish
 344 git+http://user@hostname/project/blah.git#commit-ish
 345 git+https://user@hostname/project/blah.git#commit-ish
 346 </code></pre><p>The <code>commit-ish</code> can be any tag, sha, or branch which can be supplied as
 347 an argument to <code>git checkout</code>.  The default is <code>master</code>.</p>
 348 <h2 id="github-urls">GitHub URLs</h2>
 349 <p>As of version 1.1.65, you can refer to GitHub urls as just &quot;foo&quot;:
 350 &quot;user/foo-project&quot;.  Just as with git URLs, a <code>commit-ish</code> suffix can be
 351 included.  For example:</p>
 352 <pre><code>{
 353   &quot;name&quot;: &quot;foo&quot;,
 354   &quot;version&quot;: &quot;0.0.0&quot;,
 355   &quot;dependencies&quot;: {
 356     &quot;express&quot;: &quot;visionmedia/express&quot;,
 357     &quot;mocha&quot;: &quot;visionmedia/mocha#4727d357ea&quot;
 358   }
 359 }
 360 </code></pre><h2 id="local-paths">Local Paths</h2>
 361 <p>As of version 2.0.0 you can provide a path to a local directory that contains a
 362 package. Local paths can be saved using <code>npm install --save</code>, using any of
 363 these forms:</p>
 364 <pre><code>../foo/bar
 365 ~/foo/bar
 366 ./foo/bar
 367 /foo/bar
 368 </code></pre><p>in which case they will be normalized to a relative path and added to your
 369 <code>package.json</code>. For example:</p>
 370 <pre><code>{
 371   &quot;name&quot;: &quot;baz&quot;,
 372   &quot;dependencies&quot;: {
 373     &quot;bar&quot;: &quot;file:../foo/bar&quot;
 374   }
 375 }
 376 </code></pre><p>This feature is helpful for local offline development and creating
 377 tests that require npm installing where you don&#39;t want to hit an
 378 external server, but should not be used when publishing packages
 379 to the public registry.</p>
 380 <h2 id="devdependencies">devDependencies</h2>
 381 <p>If someone is planning on downloading and using your module in their
 382 program, then they probably don&#39;t want or need to download and build
 383 the external test or documentation framework that you use.</p>
 384 <p>In this case, it&#39;s best to map these additional items in a <code>devDependencies</code>
 385 object.</p>
 386 <p>These things will be installed when doing <code>npm link</code> or <code>npm install</code>
 387 from the root of a package, and can be managed like any other npm
 388 configuration param.  See <code><a href="../misc/npm-config.html">npm-config(7)</a></code> for more on the topic.</p>
 389 <p>For build steps that are not platform-specific, such as compiling
 390 CoffeeScript or other languages to JavaScript, use the <code>prepublish</code>
 391 script to do this, and make the required package a devDependency.</p>
 392 <p>For example:</p>
 393 <pre><code>{ &quot;name&quot;: &quot;ethopia-waza&quot;,
 394   &quot;description&quot;: &quot;a delightfully fruity coffee varietal&quot;,
 395   &quot;version&quot;: &quot;1.2.3&quot;,
 396   &quot;devDependencies&quot;: {
 397     &quot;coffee-script&quot;: &quot;~1.6.3&quot;
 398   },
 399   &quot;scripts&quot;: {
 400     &quot;prepublish&quot;: &quot;coffee -o lib/ -c src/waza.coffee&quot;
 401   },
 402   &quot;main&quot;: &quot;lib/waza.js&quot;
 403 }
 404 </code></pre><p>The <code>prepublish</code> script will be run before publishing, so that users
 405 can consume the functionality without requiring them to compile it
 406 themselves.  In dev mode (ie, locally running <code>npm install</code>), it&#39;ll
 407 run this script as well, so that you can test it easily.</p>
 408 <h2 id="peerdependencies">peerDependencies</h2>
 409 <p>In some cases, you want to express the compatibility of your package with a
 410 host tool or library, while not necessarily doing a <code>require</code> of this host.
 411 This is usually referred to as a <em>plugin</em>. Notably, your module may be exposing
 412 a specific interface, expected and specified by the host documentation.</p>
 413 <p>For example:</p>
 414 <pre><code>{
 415   &quot;name&quot;: &quot;tea-latte&quot;,
 416   &quot;version&quot;: &quot;1.3.5&quot;,
 417   &quot;peerDependencies&quot;: {
 418     &quot;tea&quot;: &quot;2.x&quot;
 419   }
 420 }
 421 </code></pre><p>This ensures your package <code>tea-latte</code> can be installed <em>along</em> with the second
 422 major version of the host package <code>tea</code> only. <code>npm install tea-latte</code> could
 423 possibly yield the following dependency graph:</p>
 424 <pre><code>├── tea-latte@1.3.5
 425 └── tea@2.2.0
 426 </code></pre><p><strong>NOTE: npm versions 1 and 2 will automatically install <code>peerDependencies</code> if
 427 they are not explicitly depended upon higher in the dependency tree. In the
 428 next major version of npm (npm@3), this will no longer be the case. You will
 429 receive a warning that the peerDependency is not installed instead.</strong> The
 430 behavior in npms 1 &amp; 2 was frequently confusing and could easily put you into
 431 dependency hell, a situation that npm is designed to avoid as much as possible.</p>
 432 <p>Trying to install another plugin with a conflicting requirement will cause an
 433 error. For this reason, make sure your plugin requirement is as broad as
 434 possible, and not to lock it down to specific patch versions.</p>
 435 <p>Assuming the host complies with <a href="http://semver.org/">semver</a>, only changes in
 436 the host package&#39;s major version will break your plugin. Thus, if you&#39;ve worked
 437 with every 1.x version of the host package, use <code>&quot;^1.0&quot;</code> or <code>&quot;1.x&quot;</code> to express
 438 this. If you depend on features introduced in 1.5.2, use <code>&quot;&gt;= 1.5.2 &lt; 2&quot;</code>.</p>
 439 <h2 id="bundleddependencies">bundledDependencies</h2>
 440 <p>This defines an array of package names that will be bundled when publishing the package.</p>
 441 <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 <code>bundledDependencies</code> array and executing <code>npm pack</code>.</p>
 442 <p>For example:
 443 If we define a package.json like this:</p>
 444 <pre><code>{
 445   &quot;name&quot;: &quot;awesome-web-framework&quot;,
 446   &quot;version&quot;: &quot;1.0.0&quot;,
 447   &quot;bundledDependencies&quot;: [
 448     &#39;renderized&#39;, &#39;super-streams&#39;
 449   ]
 450 }
 451 </code></pre><p>we can obtain <code>awesome-web-framework-1.0.0.tgz</code> file by running <code>npm pack</code>. This file contains the dependencies <code>renderized</code> and <code>super-streams</code> which can be installed in a new project by executing <code>npm install awesome-web-framework-1.0.0.tgz</code>.</p>
 452 <p>If this is spelled <code>&quot;bundleDependencies&quot;</code>, then that is also honored.</p>
 453 <h2 id="optionaldependencies">optionalDependencies</h2>
 454 <p>If a dependency can be used, but you would like npm to proceed if it cannot be
 455 found or fails to install, then you may put it in the <code>optionalDependencies</code>
 456 object.  This is a map of package name to version or url, just like the
 457 <code>dependencies</code> object.  The difference is that build failures do not cause
 458 installation to fail.</p>
 459 <p>It is still your program&#39;s responsibility to handle the lack of the
 460 dependency.  For example, something like this:</p>
 461 <pre><code>try {
 462   var foo = require(&#39;foo&#39;)
 463   var fooVersion = require(&#39;foo/package.json&#39;).version
 464 } catch (er) {
 465   foo = null
 466 }
 467 if ( notGoodFooVersion(fooVersion) ) {
 468   foo = null
 469 }
 470
 471 // .. then later in your program ..
 472
 473 if (foo) {
 474   foo.doFooThings()
 475 }
 476 </code></pre><p>Entries in <code>optionalDependencies</code> will override entries of the same name in
 477 <code>dependencies</code>, so it&#39;s usually best to only put in one place.</p>
 478 <h2 id="engines">engines</h2>
 479 <p>You can specify the version of node that your stuff works on:</p>
 480 <pre><code>{ &quot;engines&quot; : { &quot;node&quot; : &quot;&gt;=0.10.3 &lt;0.12&quot; } }
 481 </code></pre><p>And, like with dependencies, if you don&#39;t specify the version (or if you
 482 specify &quot;*&quot; as the version), then any version of node will do.</p>
 483 <p>If you specify an &quot;engines&quot; field, then npm will require that &quot;node&quot; be
 484 somewhere on that list. If &quot;engines&quot; is omitted, then npm will just assume
 485 that it works on node.</p>
 486 <p>You can also use the &quot;engines&quot; field to specify which versions of npm
 487 are capable of properly installing your program.  For example:</p>
 488 <pre><code>{ &quot;engines&quot; : { &quot;npm&quot; : &quot;~1.0.20&quot; } }
 489 </code></pre><p>Note that, unless the user has set the <code>engine-strict</code> config flag, this
 490 field is advisory only.</p>
 491 <h2 id="enginestrict">engineStrict</h2>
 492 <p><strong>NOTE: This feature is deprecated and will be removed in npm 3.0.0.</strong></p>
 493 <p>If you are sure that your module will <em>definitely not</em> run properly on
 494 versions of Node/npm other than those specified in the <code>engines</code> object,
 495 then you can set <code>&quot;engineStrict&quot;: true</code> in your package.json file.
 496 This will override the user&#39;s <code>engine-strict</code> config setting.</p>
 497 <p>Please do not do this unless you are really very very sure.  If your
 498 engines object is something overly restrictive, you can quite easily and
 499 inadvertently lock yourself into obscurity and prevent your users from
 500 updating to new versions of Node.  Consider this choice carefully.</p>
 501 <h2 id="os">os</h2>
 502 <p>You can specify which operating systems your
 503 module will run on:</p>
 504 <pre><code>&quot;os&quot; : [ &quot;darwin&quot;, &quot;linux&quot; ]
 505 </code></pre><p>You can also blacklist instead of whitelist operating systems,
 506 just prepend the blacklisted os with a &#39;!&#39;:</p>
 507 <pre><code>&quot;os&quot; : [ &quot;!win32&quot; ]
 508 </code></pre><p>The host operating system is determined by <code>process.platform</code></p>
 509 <p>It is allowed to both blacklist, and whitelist, although there isn&#39;t any
 510 good reason to do this.</p>
 511 <h2 id="cpu">cpu</h2>
 512 <p>If your code only runs on certain cpu architectures,
 513 you can specify which ones.</p>
 514 <pre><code>&quot;cpu&quot; : [ &quot;x64&quot;, &quot;ia32&quot; ]
 515 </code></pre><p>Like the <code>os</code> option, you can also blacklist architectures:</p>
 516 <pre><code>&quot;cpu&quot; : [ &quot;!arm&quot;, &quot;!mips&quot; ]
 517 </code></pre><p>The host architecture is determined by <code>process.arch</code></p>
 518 <h2 id="preferglobal">preferGlobal</h2>
 519 <p>If your package is primarily a command-line application that should be
 520 installed globally, then set this value to <code>true</code> to provide a warning
 521 if it is installed locally.</p>
 522 <p>It doesn&#39;t actually prevent users from installing it locally, but it
 523 does help prevent some confusion if it doesn&#39;t work as expected.</p>
 524 <h2 id="private">private</h2>
 525 <p>If you set <code>&quot;private&quot;: true</code> in your package.json, then npm will refuse
 526 to publish it.</p>
 527 <p>This is a way to prevent accidental publication of private repositories.  If
 528 you would like to ensure that a given package is only ever published to a
 529 specific registry (for example, an internal registry), then use the
 530 <code>publishConfig</code> dictionary described below to override the <code>registry</code> config
 531 param at publish-time.</p>
 532 <h2 id="publishconfig">publishConfig</h2>
 533 <p>This is a set of config values that will be used at publish-time. It&#39;s
 534 especially handy if you want to set the tag, registry or access, so that
 535 you can ensure that a given package is not tagged with &quot;latest&quot;, published
 536 to the global public registry or that a scoped module is private by default.</p>
 537 <p>Any config values can be overridden, but of course only &quot;tag&quot;, &quot;registry&quot; and
 538 &quot;access&quot; probably matter for the purposes of publishing.</p>
 539 <p>See <code><a href="../misc/npm-config.html">npm-config(7)</a></code> to see the list of config options that can be
 540 overridden.</p>
 541 <h2 id="default-values">DEFAULT VALUES</h2>
 542 <p>npm will default some values based on package contents.</p>
 543 <ul>
 544 <li><p><code>&quot;scripts&quot;: {&quot;start&quot;: &quot;node server.js&quot;}</code></p>
 545 <p>If there is a <code>server.js</code> file in the root of your package, then npm
 546 will default the <code>start</code> command to <code>node server.js</code>.</p>
 547 </li>
 548 <li><p><code>&quot;scripts&quot;:{&quot;preinstall&quot;: &quot;node-gyp rebuild&quot;}</code></p>
 549 <p>If there is a <code>binding.gyp</code> file in the root of your package, npm will
 550 default the <code>preinstall</code> command to compile using node-gyp.</p>
 551 </li>
 552 <li><p><code>&quot;contributors&quot;: [...]</code></p>
 553 <p>If there is an <code>AUTHORS</code> file in the root of your package, npm will
 554 treat each line as a <code>Name &lt;email&gt; (url)</code> format, where email and url
 555 are optional.  Lines which start with a <code>#</code> or are blank, will be
 556 ignored.</p>
 557 </li>
 558 </ul>
 559 <h2 id="see-also">SEE ALSO</h2>
 560 <ul>
 561 <li><a href="../misc/semver.html">semver(7)</a></li>
 562 <li><a href="../cli/npm-init.html">npm-init(1)</a></li>
 563 <li><a href="../cli/npm-version.html">npm-version(1)</a></li>
 564 <li><a href="../cli/npm-config.html">npm-config(1)</a></li>
 565 <li><a href="../misc/npm-config.html">npm-config(7)</a></li>
 566 <li><a href="../cli/npm-help.html">npm-help(1)</a></li>
 567 <li><a href="../misc/npm-faq.html">npm-faq(7)</a></li>
 568 <li><a href="../cli/npm-install.html">npm-install(1)</a></li>
 569 <li><a href="../cli/npm-publish.html">npm-publish(1)</a></li>
 570 <li><a href="../cli/npm-uninstall.html">npm-uninstall(1)</a></li>
 571 </ul>
 572
 573 </div>
 574
 575 <table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
 576 <tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18>&nbsp;</td></tr>
 577 <tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)">&nbsp;</td><td style="width:40px;height:10px;background:#fff" colspan=4>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4>&nbsp;</td><td style="width:40px;height:10px;background:#fff" colspan=4>&nbsp;</td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)">&nbsp;</td><td colspan=6 style="width:60px;height:10px;background:#fff">&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4>&nbsp;</td></tr>
 578 <tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:#fff" rowspan=3>&nbsp;</td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2>&nbsp;</td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2>&nbsp;</td><td style="width:10px;height:10px;background:#fff" rowspan=3>&nbsp;</td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:#fff" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3>&nbsp;</td></tr>
 579 <tr><td style="width:10px;height:10px;background:#fff" rowspan=2>&nbsp;</td></tr>
 580 <tr><td style="width:10px;height:10px;background:#fff">&nbsp;</td></tr>
 581 <tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6>&nbsp;</td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)">&nbsp;</td></tr>
 582 <tr><td colspan=5 style="width:50px;height:10px;background:#fff">&nbsp;</td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4>&nbsp;</td><td style="width:90px;height:10px;background:#fff" colspan=9>&nbsp;</td></tr>
 583 </table>
 584 <p id="footer">package.json &mdash; npm@2.15.1</p>
 585