deps/npm/html/doc/misc/npm-developers.html

   1 <!doctype html>
   2 <html>
   3   <title>npm-developers</title>
   4   <meta http-equiv="content-type" value="text/html;utf-8">
   5   <link rel="stylesheet" type="text/css" href="../../static/style.css">
   6
   7   <body>
   8     <div id="wrapper">
   9 <h1><a href="../misc/npm-developers.html">npm-developers</a></h1> <p>Developer Guide</p>
  10
  11 <h2 id="DESCRIPTION">DESCRIPTION</h2>
  12
  13 <p>So, you&#39;ve decided to use npm to develop (and maybe publish/deploy)
  14 your project.</p>
  15
  16 <p>Fantastic!</p>
  17
  18 <p>There are a few things that you need to do above the simple steps
  19 that your users will do to install your program.</p>
  20
  21 <h2 id="About-These-Documents">About These Documents</h2>
  22
  23 <p>These are man pages.  If you install npm, you should be able to
  24 then do <code>man npm-thing</code> to get the documentation on a particular
  25 topic, or <code>npm help thing</code> to see the same information.</p>
  26
  27 <h2 id="What-is-a-package">What is a <code>package</code></h2>
  28
  29 <p>A package is:</p>
  30
  31 <ul><li>a) a folder containing a program described by a package.json file</li><li>b) a gzipped tarball containing (a)</li><li>c) a url that resolves to (b)</li><li>d) a <code>&lt;name&gt;@&lt;version&gt;</code> that is published on the registry with (c)</li><li>e) a <code>&lt;name&gt;@&lt;tag&gt;</code> that points to (d)</li><li>f) a <code>&lt;name&gt;</code> that has a &quot;latest&quot; tag satisfying (e)</li><li>g) a <code>git</code> url that, when cloned, results in (a).</li></ul>
  32
  33 <p>Even if you never publish your package, you can still get a lot of
  34 benefits of using npm if you just want to write a node program (a), and
  35 perhaps if you also want to be able to easily install it elsewhere
  36 after packing it up into a tarball (b).</p>
  37
  38 <p>Git urls can be of the form:</p>
  39
  40 <pre><code>git://github.com/user/project.git#commit-ish
  41 git+ssh://user@hostname:project.git#commit-ish
  42 git+http://user@hostname/project/blah.git#commit-ish
  43 git+https://user@hostname/project/blah.git#commit-ish</code></pre>
  44
  45 <p>The <code>commit-ish</code> can be any tag, sha, or branch which can be supplied as
  46 an argument to <code>git checkout</code>.  The default is <code>master</code>.</p>
  47
  48 <h2 id="The-package-json-File">The package.json File</h2>
  49
  50 <p>You need to have a <code>package.json</code> file in the root of your project to do
  51 much of anything with npm.  That is basically the whole interface.</p>
  52
  53 <p>See <code><a href="../files/package.json.html">package.json(5)</a></code> for details about what goes in that file.  At the very
  54 least, you need:</p>
  55
  56 <ul><li><p>name:
  57 This should be a string that identifies your project.  Please do not
  58 use the name to specify that it runs on node, or is in JavaScript.
  59 You can use the &quot;engines&quot; field to explicitly state the versions of
  60 node (or whatever else) that your program requires, and it&#39;s pretty
  61 well assumed that it&#39;s javascript.</p><p>It does not necessarily need to match your github repository name.</p><p>So, <code>node-foo</code> and <code>bar-js</code> are bad names.  <code>foo</code> or <code>bar</code> are better.</p></li><li><p>version:
  62 A semver-compatible version.</p></li><li><p>engines:
  63 Specify the versions of node (or whatever else) that your program
  64 runs on.  The node API changes a lot, and there may be bugs or new
  65 functionality that you depend on.  Be explicit.</p></li><li><p>author:
  66 Take some credit.</p></li><li><p>scripts:
  67 If you have a special compilation or installation script, then you
  68 should put it in the <code>scripts</code> hash.  You should definitely have at
  69 least a basic smoke-test command as the &quot;scripts.test&quot; field.
  70 See <a href="../misc/npm-scripts.html">npm-scripts(7)</a>.</p></li><li><p>main:
  71 If you have a single module that serves as the entry point to your
  72 program (like what the &quot;foo&quot; package gives you at require(&quot;foo&quot;)),
  73 then you need to specify that in the &quot;main&quot; field.</p></li><li><p>directories:
  74 This is a hash of folders.  The best ones to include are &quot;lib&quot; and
  75 &quot;doc&quot;, but if you specify a folder full of man pages in &quot;man&quot;, then
  76 they&#39;ll get installed just like these ones.</p></li></ul>
  77
  78 <p>You can use <code>npm init</code> in the root of your package in order to get you
  79 started with a pretty basic package.json file.  See <code><a href="../cli/npm-init.html">npm-init(1)</a></code> for
  80 more info.</p>
  81
  82 <h2 id="Keeping-files-out-of-your-package">Keeping files <em>out</em> of your package</h2>
  83
  84 <p>Use a <code>.npmignore</code> file to keep stuff out of your package.  If there&#39;s
  85 no <code>.npmignore</code> file, but there <em>is</em> a <code>.gitignore</code> file, then npm will
  86 ignore the stuff matched by the <code>.gitignore</code> file.  If you <em>want</em> to
  87 include something that is excluded by your <code>.gitignore</code> file, you can
  88 create an empty <code>.npmignore</code> file to override it.</p>
  89
  90 <p>By default, the following paths and files are ignored, so there&#39;s no
  91 need to add them to <code>.npmignore</code> explicitly:</p>
  92
  93 <ul><li><code>.*.swp</code></li><li><code>._*</code></li><li><code>.DS_Store</code></li><li><code>.git</code></li><li><code>.hg</code></li><li><code>.lock-wscript</code></li><li><code>.svn</code></li><li><code>.wafpickle-*</code></li><li><code>CVS</code></li><li><code>npm-debug.log</code></li></ul>
  94
  95 <p>Additionally, everything in <code>node_modules</code> is ignored, except for
  96 bundled dependencies. npm automatically handles this for you, so don&#39;t
  97 bother adding <code>node_modules</code> to <code>.npmignore</code>.</p>
  98
  99 <p>The following paths and files are never ignored, so adding them to
 100 <code>.npmignore</code> is pointless:</p>
 101
 102 <ul><li><code>package.json</code></li><li><code><a href="../../doc/README.html">README</a>.*</code></li></ul>
 103
 104 <h2 id="Link-Packages">Link Packages</h2>
 105
 106 <p><code>npm link</code> is designed to install a development package and see the
 107 changes in real time without having to keep re-installing it.  (You do
 108 need to either re-link or <code>npm rebuild -g</code> to update compiled packages,
 109 of course.)</p>
 110
 111 <p>More info at <code><a href="../cli/npm-link.html">npm-link(1)</a></code>.</p>
 112
 113 <h2 id="Before-Publishing-Make-Sure-Your-Package-Installs-and-Works">Before Publishing: Make Sure Your Package Installs and Works</h2>
 114
 115 <p><strong>This is important.</strong></p>
 116
 117 <p>If you can not install it locally, you&#39;ll have
 118 problems trying to publish it.  Or, worse yet, you&#39;ll be able to
 119 publish it, but you&#39;ll be publishing a broken or pointless package.
 120 So don&#39;t do that.</p>
 121
 122 <p>In the root of your package, do this:</p>
 123
 124 <pre><code>npm install . -g</code></pre>
 125
 126 <p>That&#39;ll show you that it&#39;s working.  If you&#39;d rather just create a symlink
 127 package that points to your working directory, then do this:</p>
 128
 129 <pre><code>npm link</code></pre>
 130
 131 <p>Use <code>npm ls -g</code> to see if it&#39;s there.</p>
 132
 133 <p>To test a local install, go into some other folder, and then do:</p>
 134
 135 <pre><code>cd ../some-other-folder
 136 npm install ../my-package</code></pre>
 137
 138 <p>to install it locally into the node_modules folder in that other place.</p>
 139
 140 <p>Then go into the node-repl, and try using require(&quot;my-thing&quot;) to
 141 bring in your module&#39;s main module.</p>
 142
 143 <h2 id="Create-a-User-Account">Create a User Account</h2>
 144
 145 <p>Create a user with the adduser command.  It works like this:</p>
 146
 147 <pre><code>npm adduser</code></pre>
 148
 149 <p>and then follow the prompts.</p>
 150
 151 <p>This is documented better in <a href="../cli/npm-adduser.html">npm-adduser(1)</a>.</p>
 152
 153 <h2 id="Publish-your-package">Publish your package</h2>
 154
 155 <p>This part&#39;s easy.  IN the root of your folder, do this:</p>
 156
 157 <pre><code>npm publish</code></pre>
 158
 159 <p>You can give publish a url to a tarball, or a filename of a tarball,
 160 or a path to a folder.</p>
 161
 162 <p>Note that pretty much <strong>everything in that folder will be exposed</strong>
 163 by default.  So, if you have secret stuff in there, use a
 164 <code>.npmignore</code> file to list out the globs to ignore, or publish
 165 from a fresh checkout.</p>
 166
 167 <h2 id="Brag-about-it">Brag about it</h2>
 168
 169 <p>Send emails, write blogs, blab in IRC.</p>
 170
 171 <p>Tell the world how easy it is to install your program!</p>
 172
 173 <h2 id="SEE-ALSO">SEE ALSO</h2>
 174
 175 <ul><li><a href="../misc/npm-faq.html">npm-faq(7)</a></li><li><a href="../cli/npm.html">npm(1)</a></li><li><a href="../cli/npm-init.html">npm-init(1)</a></li><li><a href="../files/package.json.html">package.json(5)</a></li><li><a href="../misc/npm-scripts.html">npm-scripts(7)</a></li><li><a href="../cli/npm-publish.html">npm-publish(1)</a></li><li><a href="../cli/npm-adduser.html">npm-adduser(1)</a></li><li><a href="../misc/npm-registry.html">npm-registry(7)</a></li></ul>
 176 </div>
 177 <p id="footer">npm-developers &mdash; npm@1.3.17</p>
 178 <script>
 179 ;(function () {
 180 var wrapper = document.getElementById("wrapper")
 181 var els = Array.prototype.slice.call(wrapper.getElementsByTagName("*"), 0)
 182   .filter(function (el) {
 183     return el.parentNode === wrapper
 184         && el.tagName.match(/H[1-6]/)
 185         && el.id
 186   })
 187 var l = 2
 188   , toc = document.createElement("ul")
 189 toc.innerHTML = els.map(function (el) {
 190   var i = el.tagName.charAt(1)
 191     , out = ""
 192   while (i > l) {
 193     out += "<ul>"
 194     l ++
 195   }
 196   while (i < l) {
 197     out += "</ul>"
 198     l --
 199   }
 200   out += "<li><a href='#" + el.id + "'>" +
 201     ( el.innerText || el.text || el.innerHTML)
 202     + "</a>"
 203   return out
 204 }).join("\n")
 205 toc.id = "toc"
 206 document.body.appendChild(toc)
 207 })()
 208 </script>