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

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