deps/npm/html/doc/files/package.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 shorter than 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="http://opensource.org/licenses/alphabetical">OSI</a> approved.</p>
  89 <p>If your package is licensed under multiple common licenses, use an <a href="http://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 the following valid SPDX expression:</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> (and its variants)</li>
 147 <li><code>CHANGELOG</code> (and its variants)</li>
 148 <li><code>LICENSE</code> / <code>LICENCE</code></li>
 149 </ul>
 150 <p>Conversely, some files are always ignored:</p>
 151 <ul>
 152 <li><code>.git</code></li>
 153 <li><code>CVS</code></li>
 154 <li><code>.svn</code></li>
 155 <li><code>.hg</code></li>
 156 <li><code>.lock-wscript</code></li>
 157 <li><code>.wafpickle-N</code></li>
 158 <li><code>*.swp</code></li>
 159 <li><code>.DS_Store</code></li>
 160 <li><code>._*</code></li>
 161 <li><code>npm-debug.log</code></li>
 162 </ul>
 163 <h2 id="main">main</h2>
 164 <p>The main field is a module ID that is the primary entry point to your program.
 165 That is, if your package is named <code>foo</code>, and a user installs it, and then does
 166 <code>require(&quot;foo&quot;)</code>, then your main module&#39;s exports object will be returned.</p>
 167 <p>This should be a module ID relative to the root of your package folder.</p>
 168 <p>For most modules, it makes the most sense to have a main script and often not
 169 much else.</p>
 170 <h2 id="bin">bin</h2>
 171 <p>A lot of packages have one or more executable files that they&#39;d like to
 172 install into the PATH. npm makes this pretty easy (in fact, it uses this
 173 feature to install the &quot;npm&quot; executable.)</p>
 174 <p>To use this, supply a <code>bin</code> field in your package.json which is a map of
 175 command name to local file name. On install, npm will symlink that file into
 176 <code>prefix/bin</code> for global installs, or <code>./node_modules/.bin/</code> for local
 177 installs.</p>
 178 <p>For example, myapp could have this:</p>
 179 <pre><code>{ &quot;bin&quot; : { &quot;myapp&quot; : &quot;./cli.js&quot; } }
 180 </code></pre><p>So, when you install myapp, it&#39;ll create a symlink from the <code>cli.js</code> script to
 181 <code>/usr/local/bin/myapp</code>.</p>
 182 <p>If you have a single executable, and its name should be the name
 183 of the package, then you can just supply it as a string.  For example:</p>
 184 <pre><code>{ &quot;name&quot;: &quot;my-program&quot;
 185 , &quot;version&quot;: &quot;1.2.5&quot;
 186 , &quot;bin&quot;: &quot;./path/to/program&quot; }
 187 </code></pre><p>would be the same as this:</p>
 188 <pre><code>{ &quot;name&quot;: &quot;my-program&quot;
 189 , &quot;version&quot;: &quot;1.2.5&quot;
 190 , &quot;bin&quot; : { &quot;my-program&quot; : &quot;./path/to/program&quot; } }
 191 </code></pre><h2 id="man">man</h2>
 192 <p>Specify either a single file or an array of filenames to put in place for the
 193 <code>man</code> program to find.</p>
 194 <p>If only a single file is provided, then it&#39;s installed such that it is the
 195 result from <code>man &lt;pkgname&gt;</code>, regardless of its actual filename.  For example:</p>
 196 <pre><code>{ &quot;name&quot; : &quot;foo&quot;
 197 , &quot;version&quot; : &quot;1.2.3&quot;
 198 , &quot;description&quot; : &quot;A packaged foo fooer for fooing foos&quot;
 199 , &quot;main&quot; : &quot;foo.js&quot;
 200 , &quot;man&quot; : &quot;./man/doc.1&quot;
 201 }
 202 </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>
 203 <p>If the filename doesn&#39;t start with the package name, then it&#39;s prefixed.
 204 So, this:</p>
 205 <pre><code>{ &quot;name&quot; : &quot;foo&quot;
 206 , &quot;version&quot; : &quot;1.2.3&quot;
 207 , &quot;description&quot; : &quot;A packaged foo fooer for fooing foos&quot;
 208 , &quot;main&quot; : &quot;foo.js&quot;
 209 , &quot;man&quot; : [ &quot;./man/foo.1&quot;, &quot;./man/bar.1&quot; ]
 210 }
 211 </code></pre><p>will create files to do <code>man foo</code> and <code>man foo-bar</code>.</p>
 212 <p>Man files must end with a number, and optionally a <code>.gz</code> suffix if they are
 213 compressed.  The number dictates which man section the file is installed into.</p>
 214 <pre><code>{ &quot;name&quot; : &quot;foo&quot;
 215 , &quot;version&quot; : &quot;1.2.3&quot;
 216 , &quot;description&quot; : &quot;A packaged foo fooer for fooing foos&quot;
 217 , &quot;main&quot; : &quot;foo.js&quot;
 218 , &quot;man&quot; : [ &quot;./man/foo.1&quot;, &quot;./man/foo.2&quot; ]
 219 }
 220 </code></pre><p>will create entries for <code>man foo</code> and <code>man 2 foo</code></p>
 221 <h2 id="directories">directories</h2>
 222 <p>The CommonJS <a href="http://wiki.commonjs.org/wiki/Packages/1.0">Packages</a> spec details a
 223 few ways that you can indicate the structure of your package using a <code>directories</code>
 224 object. If you look at <a href="https://registry.npmjs.org/npm/latest">npm&#39;s package.json</a>,
 225 you&#39;ll see that it has directories for doc, lib, and man.</p>
 226 <p>In the future, this information may be used in other creative ways.</p>
 227 <h3 id="directories-lib">directories.lib</h3>
 228 <p>Tell people where the bulk of your library is.  Nothing special is done
 229 with the lib folder in any way, but it&#39;s useful meta info.</p>
 230 <h3 id="directories-bin">directories.bin</h3>
 231 <p>If you specify a <code>bin</code> directory in <code>directories.bin</code>, all the files in
 232 that folder will be added.</p>
 233 <p>Because of the way the <code>bin</code> directive works, specifying both a
 234 <code>bin</code> path and setting <code>directories.bin</code> is an error. If you want to
 235 specify individual files, use <code>bin</code>, and for all the files in an
 236 existing <code>bin</code> directory, use <code>directories.bin</code>.</p>
 237 <h3 id="directories-man">directories.man</h3>
 238 <p>A folder that is full of man pages.  Sugar to generate a &quot;man&quot; array by
 239 walking the folder.</p>
 240 <h3 id="directories-doc">directories.doc</h3>
 241 <p>Put markdown files in here.  Eventually, these will be displayed nicely,
 242 maybe, someday.</p>
 243 <h3 id="directories-example">directories.example</h3>
 244 <p>Put example scripts in here.  Someday, it might be exposed in some clever way.</p>
 245 <h2 id="repository">repository</h2>
 246 <p>Specify the place where your code lives. This is helpful for people who
 247 want to contribute.  If the git repo is on GitHub, then the <code>npm docs</code>
 248 command will be able to find you.</p>
 249 <p>Do it like this:</p>
 250 <pre><code>&quot;repository&quot; :
 251   { &quot;type&quot; : &quot;git&quot;
 252   , &quot;url&quot; : &quot;https://github.com/npm/npm.git&quot;
 253   }
 254
 255 &quot;repository&quot; :
 256   { &quot;type&quot; : &quot;svn&quot;
 257   , &quot;url&quot; : &quot;https://v8.googlecode.com/svn/trunk/&quot;
 258   }
 259 </code></pre><p>The URL should be a publicly available (perhaps read-only) url that can be handed
 260 directly to a VCS program without any modification.  It should not be a url to an
 261 html project page that you put in your browser.  It&#39;s for computers.</p>
 262 <p>For GitHub, GitHub gist, Bitbucket, or GitLab repositories you can use the same
 263 shortcut syntax you use for <code>npm install</code>:</p>
 264 <pre><code>&quot;repository&quot;: &quot;npm/npm&quot;
 265
 266 &quot;repository&quot;: &quot;gist:11081aaa281&quot;
 267
 268 &quot;repository&quot;: &quot;bitbucket:example/repo&quot;
 269
 270 &quot;repository&quot;: &quot;gitlab:another/repo&quot;
 271 </code></pre><h2 id="scripts">scripts</h2>
 272 <p>The &quot;scripts&quot; property is a dictionary containing script commands that are run
 273 at various times in the lifecycle of your package.  The key is the lifecycle
 274 event, and the value is the command to run at that point.</p>
 275 <p>See <code><a href="../misc/npm-scripts.html">npm-scripts(7)</a></code> to find out more about writing package scripts.</p>
 276 <h2 id="config">config</h2>
 277 <p>A &quot;config&quot; object can be used to set configuration parameters used in package
 278 scripts that persist across upgrades.  For instance, if a package had the
 279 following:</p>
 280 <pre><code>{ &quot;name&quot; : &quot;foo&quot;
 281 , &quot;config&quot; : { &quot;port&quot; : &quot;8080&quot; } }
 282 </code></pre><p>and then had a &quot;start&quot; command that then referenced the
 283 <code>npm_package_config_port</code> environment variable, then the user could
 284 override that by doing <code>npm config set foo:port 8001</code>.</p>
 285 <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
 286 configs.</p>
 287 <h2 id="dependencies">dependencies</h2>
 288 <p>Dependencies are specified in a simple object that maps a package name to a
 289 version range. The version range is a string which has one or more
 290 space-separated descriptors.  Dependencies can also be identified with a
 291 tarball or git URL.</p>
 292 <p><strong>Please do not put test harnesses or transpilers in your
 293 <code>dependencies</code> object.</strong>  See <code>devDependencies</code>, below.</p>
 294 <p>See <a href="../misc/semver.html">semver(7)</a> for more details about specifying version ranges.</p>
 295 <ul>
 296 <li><code>version</code> Must match <code>version</code> exactly</li>
 297 <li><code>&gt;version</code> Must be greater than <code>version</code></li>
 298 <li><code>&gt;=version</code> etc</li>
 299 <li><code>&lt;version</code></li>
 300 <li><code>&lt;=version</code></li>
 301 <li><code>~version</code> &quot;Approximately equivalent to version&quot;  See <a href="../misc/semver.html">semver(7)</a></li>
 302 <li><code>^version</code> &quot;Compatible with version&quot;  See <a href="../misc/semver.html">semver(7)</a></li>
 303 <li><code>1.2.x</code> 1.2.0, 1.2.1, etc., but not 1.3.0</li>
 304 <li><code>http://...</code> See &#39;URLs as Dependencies&#39; below</li>
 305 <li><code>*</code> Matches any version</li>
 306 <li><code>&quot;&quot;</code> (just an empty string) Same as <code>*</code></li>
 307 <li><code>version1 - version2</code> Same as <code>&gt;=version1 &lt;=version2</code>.</li>
 308 <li><code>range1 || range2</code> Passes if either range1 or range2 are satisfied.</li>
 309 <li><code>git...</code> See &#39;Git URLs as Dependencies&#39; below</li>
 310 <li><code>user/repo</code> See &#39;GitHub URLs&#39; below</li>
 311 <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>
 312 <li><code>path/path/path</code> See Local Paths below</li>
 313 </ul>
 314 <p>For example, these are all valid:</p>
 315 <pre><code>{ &quot;dependencies&quot; :
 316   { &quot;foo&quot; : &quot;1.0.0 - 2.9999.9999&quot;
 317   , &quot;bar&quot; : &quot;&gt;=1.0.2 &lt;2.1.2&quot;
 318   , &quot;baz&quot; : &quot;&gt;1.0.2 &lt;=2.3.4&quot;
 319   , &quot;boo&quot; : &quot;2.0.1&quot;
 320   , &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;
 321   , &quot;asd&quot; : &quot;http://asdf.com/asdf.tar.gz&quot;
 322   , &quot;til&quot; : &quot;~1.2&quot;
 323   , &quot;elf&quot; : &quot;~1.2.3&quot;
 324   , &quot;two&quot; : &quot;2.x&quot;
 325   , &quot;thr&quot; : &quot;3.3.x&quot;
 326   , &quot;lat&quot; : &quot;latest&quot;
 327   , &quot;dyl&quot; : &quot;file:../dyl&quot;
 328   }
 329 }
 330 </code></pre><h3 id="urls-as-dependencies">URLs as Dependencies</h3>
 331 <p>You may specify a tarball URL in place of a version range.</p>
 332 <p>This tarball will be downloaded and installed locally to your package at
 333 install time.</p>
 334 <h3 id="git-urls-as-dependencies">Git URLs as Dependencies</h3>
 335 <p>Git urls can be of the form:</p>
 336 <pre><code>git://github.com/user/project.git#commit-ish
 337 git+ssh://user@hostname:project.git#commit-ish
 338 git+ssh://user@hostname/project.git#commit-ish
 339 git+http://user@hostname/project/blah.git#commit-ish
 340 git+https://user@hostname/project/blah.git#commit-ish
 341 </code></pre><p>The <code>commit-ish</code> can be any tag, sha, or branch which can be supplied as
 342 an argument to <code>git checkout</code>.  The default is <code>master</code>.</p>
 343 <h2 id="github-urls">GitHub URLs</h2>
 344 <p>As of version 1.1.65, you can refer to GitHub urls as just &quot;foo&quot;:
 345 &quot;user/foo-project&quot;.  Just as with git URLs, a <code>commit-ish</code> suffix can be
 346 included.  For example:</p>
 347 <pre><code>{
 348   &quot;name&quot;: &quot;foo&quot;,
 349   &quot;version&quot;: &quot;0.0.0&quot;,
 350   &quot;dependencies&quot;: {
 351     &quot;express&quot;: &quot;visionmedia/express&quot;,
 352     &quot;mocha&quot;: &quot;visionmedia/mocha#4727d357ea&quot;
 353   }
 354 }
 355 </code></pre><h2 id="local-paths">Local Paths</h2>
 356 <p>As of version 2.0.0 you can provide a path to a local directory that contains a
 357 package. Local paths can be saved using <code>npm install --save</code>, using any of
 358 these forms:</p>
 359 <pre><code>../foo/bar
 360 ~/foo/bar
 361 ./foo/bar
 362 /foo/bar
 363 </code></pre><p>in which case they will be normalized to a relative path and added to your
 364 <code>package.json</code>. For example:</p>
 365 <pre><code>{
 366   &quot;name&quot;: &quot;baz&quot;,
 367   &quot;dependencies&quot;: {
 368     &quot;bar&quot;: &quot;file:../foo/bar&quot;
 369   }
 370 }
 371 </code></pre><p>This feature is helpful for local offline development and creating
 372 tests that require npm installing where you don&#39;t want to hit an
 373 external server, but should not be used when publishing packages
 374 to the public registry.</p>
 375 <h2 id="devdependencies">devDependencies</h2>
 376 <p>If someone is planning on downloading and using your module in their
 377 program, then they probably don&#39;t want or need to download and build
 378 the external test or documentation framework that you use.</p>
 379 <p>In this case, it&#39;s best to map these additional items in a <code>devDependencies</code>
 380 object.</p>
 381 <p>These things will be installed when doing <code>npm link</code> or <code>npm install</code>
 382 from the root of a package, and can be managed like any other npm
 383 configuration param.  See <code><a href="../misc/npm-config.html">npm-config(7)</a></code> for more on the topic.</p>
 384 <p>For build steps that are not platform-specific, such as compiling
 385 CoffeeScript or other languages to JavaScript, use the <code>prepublish</code>
 386 script to do this, and make the required package a devDependency.</p>
 387 <p>For example:</p>
 388 <pre><code>{ &quot;name&quot;: &quot;ethopia-waza&quot;,
 389   &quot;description&quot;: &quot;a delightfully fruity coffee varietal&quot;,
 390   &quot;version&quot;: &quot;1.2.3&quot;,
 391   &quot;devDependencies&quot;: {
 392     &quot;coffee-script&quot;: &quot;~1.6.3&quot;
 393   },
 394   &quot;scripts&quot;: {
 395     &quot;prepublish&quot;: &quot;coffee -o lib/ -c src/waza.coffee&quot;
 396   },
 397   &quot;main&quot;: &quot;lib/waza.js&quot;
 398 }
 399 </code></pre><p>The <code>prepublish</code> script will be run before publishing, so that users
 400 can consume the functionality without requiring them to compile it
 401 themselves.  In dev mode (ie, locally running <code>npm install</code>), it&#39;ll
 402 run this script as well, so that you can test it easily.</p>
 403 <h2 id="peerdependencies">peerDependencies</h2>
 404 <p>In some cases, you want to express the compatibility of your package with a
 405 host tool or library, while not necessarily doing a <code>require</code> of this host.
 406 This is usually referred to as a <em>plugin</em>. Notably, your module may be exposing
 407 a specific interface, expected and specified by the host documentation.</p>
 408 <p>For example:</p>
 409 <pre><code>{
 410   &quot;name&quot;: &quot;tea-latte&quot;,
 411   &quot;version&quot;: &quot;1.3.5&quot;,
 412   &quot;peerDependencies&quot;: {
 413     &quot;tea&quot;: &quot;2.x&quot;
 414   }
 415 }
 416 </code></pre><p>This ensures your package <code>tea-latte</code> can be installed <em>along</em> with the second
 417 major version of the host package <code>tea</code> only. <code>npm install tea-latte</code> could
 418 possibly yield the following dependency graph:</p>
 419 <pre><code>├── tea-latte@1.3.5
 420 └── tea@2.2.0
 421 </code></pre><p><strong>NOTE: npm versions 1 and 2 will automatically install <code>peerDependencies</code> if
 422 they are not explicitly depended upon higher in the dependency tree. In the
 423 next major version of npm (npm@3), this will no longer be the case. You will
 424 receive a warning that the peerDependency is not installed instead.</strong> The
 425 behavior in npms 1 &amp; 2 was frequently confusing and could easily put you into
 426 dependency hell, a situation that npm is designed to avoid as much as possible.</p>
 427 <p>Trying to install another plugin with a conflicting requirement will cause an
 428 error. For this reason, make sure your plugin requirement is as broad as
 429 possible, and not to lock it down to specific patch versions.</p>
 430 <p>Assuming the host complies with <a href="http://semver.org/">semver</a>, only changes in
 431 the host package&#39;s major version will break your plugin. Thus, if you&#39;ve worked
 432 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
 433 this. If you depend on features introduced in 1.5.2, use <code>&quot;&gt;= 1.5.2 &lt; 2&quot;</code>.</p>
 434 <h2 id="bundleddependencies">bundledDependencies</h2>
 435 <p>Array of package names that will be bundled when publishing the package.</p>
 436 <p>If this is spelled <code>&quot;bundleDependencies&quot;</code>, then that is also honored.</p>
 437 <h2 id="optionaldependencies">optionalDependencies</h2>
 438 <p>If a dependency can be used, but you would like npm to proceed if it cannot be
 439 found or fails to install, then you may put it in the <code>optionalDependencies</code>
 440 object.  This is a map of package name to version or url, just like the
 441 <code>dependencies</code> object.  The difference is that build failures do not cause
 442 installation to fail.</p>
 443 <p>It is still your program&#39;s responsibility to handle the lack of the
 444 dependency.  For example, something like this:</p>
 445 <pre><code>try {
 446   var foo = require(&#39;foo&#39;)
 447   var fooVersion = require(&#39;foo/package.json&#39;).version
 448 } catch (er) {
 449   foo = null
 450 }
 451 if ( notGoodFooVersion(fooVersion) ) {
 452   foo = null
 453 }
 454
 455 // .. then later in your program ..
 456
 457 if (foo) {
 458   foo.doFooThings()
 459 }
 460 </code></pre><p>Entries in <code>optionalDependencies</code> will override entries of the same name in
 461 <code>dependencies</code>, so it&#39;s usually best to only put in one place.</p>
 462 <h2 id="engines">engines</h2>
 463 <p>You can specify the version of node that your stuff works on:</p>
 464 <pre><code>{ &quot;engines&quot; : { &quot;node&quot; : &quot;&gt;=0.10.3 &lt;0.12&quot; } }
 465 </code></pre><p>And, like with dependencies, if you don&#39;t specify the version (or if you
 466 specify &quot;*&quot; as the version), then any version of node will do.</p>
 467 <p>If you specify an &quot;engines&quot; field, then npm will require that &quot;node&quot; be
 468 somewhere on that list. If &quot;engines&quot; is omitted, then npm will just assume
 469 that it works on node.</p>
 470 <p>You can also use the &quot;engines&quot; field to specify which versions of npm
 471 are capable of properly installing your program.  For example:</p>
 472 <pre><code>{ &quot;engines&quot; : { &quot;npm&quot; : &quot;~1.0.20&quot; } }
 473 </code></pre><p>Note that, unless the user has set the <code>engine-strict</code> config flag, this
 474 field is advisory only.</p>
 475 <h2 id="enginestrict">engineStrict</h2>
 476 <p><strong>NOTE: This feature is deprecated and will be removed in npm 3.0.0.</strong></p>
 477 <p>If you are sure that your module will <em>definitely not</em> run properly on
 478 versions of Node/npm other than those specified in the <code>engines</code> object,
 479 then you can set <code>&quot;engineStrict&quot;: true</code> in your package.json file.
 480 This will override the user&#39;s <code>engine-strict</code> config setting.</p>
 481 <p>Please do not do this unless you are really very very sure.  If your
 482 engines object is something overly restrictive, you can quite easily and
 483 inadvertently lock yourself into obscurity and prevent your users from
 484 updating to new versions of Node.  Consider this choice carefully.</p>
 485 <h2 id="os">os</h2>
 486 <p>You can specify which operating systems your
 487 module will run on:</p>
 488 <pre><code>&quot;os&quot; : [ &quot;darwin&quot;, &quot;linux&quot; ]
 489 </code></pre><p>You can also blacklist instead of whitelist operating systems,
 490 just prepend the blacklisted os with a &#39;!&#39;:</p>
 491 <pre><code>&quot;os&quot; : [ &quot;!win32&quot; ]
 492 </code></pre><p>The host operating system is determined by <code>process.platform</code></p>
 493 <p>It is allowed to both blacklist, and whitelist, although there isn&#39;t any
 494 good reason to do this.</p>
 495 <h2 id="cpu">cpu</h2>
 496 <p>If your code only runs on certain cpu architectures,
 497 you can specify which ones.</p>
 498 <pre><code>&quot;cpu&quot; : [ &quot;x64&quot;, &quot;ia32&quot; ]
 499 </code></pre><p>Like the <code>os</code> option, you can also blacklist architectures:</p>
 500 <pre><code>&quot;cpu&quot; : [ &quot;!arm&quot;, &quot;!mips&quot; ]
 501 </code></pre><p>The host architecture is determined by <code>process.arch</code></p>
 502 <h2 id="preferglobal">preferGlobal</h2>
 503 <p>If your package is primarily a command-line application that should be
 504 installed globally, then set this value to <code>true</code> to provide a warning
 505 if it is installed locally.</p>
 506 <p>It doesn&#39;t actually prevent users from installing it locally, but it
 507 does help prevent some confusion if it doesn&#39;t work as expected.</p>
 508 <h2 id="private">private</h2>
 509 <p>If you set <code>&quot;private&quot;: true</code> in your package.json, then npm will refuse
 510 to publish it.</p>
 511 <p>This is a way to prevent accidental publication of private repositories.  If
 512 you would like to ensure that a given package is only ever published to a
 513 specific registry (for example, an internal registry), then use the
 514 <code>publishConfig</code> dictionary described below to override the <code>registry</code> config
 515 param at publish-time.</p>
 516 <h2 id="publishconfig">publishConfig</h2>
 517 <p>This is a set of config values that will be used at publish-time. It&#39;s
 518 especially handy if you want to set the tag, registry or access, so that
 519 you can ensure that a given package is not tagged with &quot;latest&quot;, published
 520 to the global public registry or that a scoped module is private by default.</p>
 521 <p>Any config values can be overridden, but of course only &quot;tag&quot;, &quot;registry&quot; and
 522 &quot;access&quot; probably matter for the purposes of publishing.</p>
 523 <p>See <code><a href="../misc/npm-config.html">npm-config(7)</a></code> to see the list of config options that can be
 524 overridden.</p>
 525 <h2 id="default-values">DEFAULT VALUES</h2>
 526 <p>npm will default some values based on package contents.</p>
 527 <ul>
 528 <li><p><code>&quot;scripts&quot;: {&quot;start&quot;: &quot;node server.js&quot;}</code></p>
 529 <p>If there is a <code>server.js</code> file in the root of your package, then npm
 530 will default the <code>start</code> command to <code>node server.js</code>.</p>
 531 </li>
 532 <li><p><code>&quot;scripts&quot;:{&quot;preinstall&quot;: &quot;node-gyp rebuild&quot;}</code></p>
 533 <p>If there is a <code>binding.gyp</code> file in the root of your package, npm will
 534 default the <code>preinstall</code> command to compile using node-gyp.</p>
 535 </li>
 536 <li><p><code>&quot;contributors&quot;: [...]</code></p>
 537 <p>If there is an <code>AUTHORS</code> file in the root of your package, npm will
 538 treat each line as a <code>Name &lt;email&gt; (url)</code> format, where email and url
 539 are optional.  Lines which start with a <code>#</code> or are blank, will be
 540 ignored.</p>
 541 </li>
 542 </ul>
 543 <h2 id="see-also">SEE ALSO</h2>
 544 <ul>
 545 <li><a href="../misc/semver.html">semver(7)</a></li>
 546 <li><a href="../cli/npm-init.html">npm-init(1)</a></li>
 547 <li><a href="../cli/npm-version.html">npm-version(1)</a></li>
 548 <li><a href="../cli/npm-config.html">npm-config(1)</a></li>
 549 <li><a href="../misc/npm-config.html">npm-config(7)</a></li>
 550 <li><a href="../cli/npm-help.html">npm-help(1)</a></li>
 551 <li><a href="../misc/npm-faq.html">npm-faq(7)</a></li>
 552 <li><a href="../cli/npm-install.html">npm-install(1)</a></li>
 553 <li><a href="../cli/npm-publish.html">npm-publish(1)</a></li>
 554 <li><a href="../cli/npm-rm.html">npm-rm(1)</a></li>
 555 </ul>
 556
 557 </div>
 558
 559 <table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
 560 <tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18>&nbsp;</td></tr>
 561 <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>
 562 <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>
 563 <tr><td style="width:10px;height:10px;background:#fff" rowspan=2>&nbsp;</td></tr>
 564 <tr><td style="width:10px;height:10px;background:#fff">&nbsp;</td></tr>
 565 <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>
 566 <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>
 567 </table>
 568 <p id="footer">package.json &mdash; npm@2.14.4</p>
 569