diff options
Diffstat (limited to 'deps/npm/html/doc/developers.html')
| -rw-r--r-- | deps/npm/html/doc/developers.html | 48 |
1 files changed, 24 insertions, 24 deletions
diff --git a/deps/npm/html/doc/developers.html b/deps/npm/html/doc/developers.html index 721ca2c13..40fe2c063 100644 --- a/deps/npm/html/doc/developers.html +++ b/deps/npm/html/doc/developers.html @@ -10,7 +10,7 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2> -<p>So, you've decided to use npm to develop (and maybe publish/deploy) +<p>So, you've decided to use npm to develop (and maybe publish/deploy) your project.</p> <p>Fantastic!</p> @@ -24,11 +24,11 @@ that your users will do to install your program.</p> then do <code>man npm-thing</code> to get the documentation on a particular topic, or <code>npm help thing</code> to see the same information.</p> -<h2 id="What-is-a-package">What is a `package`</h2> +<h2 id="What-is-a-package">What is a <code>package</code></h2> <p>A package is:</p> -<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><name>@<version></code> that is published on the registry with (c)</li><li>e) a <code><name>@<tag></code> that points to (d)</li><li>f) a <code><name></code> that has a "latest" tag satisfying (e)</li><li>g) a <code>git</code> url that, when cloned, results in (a).</li></ul> +<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><name>@<version></code> that is published on the registry with (c)</li><li>e) a <code><name>@<tag></code> that points to (d)</li><li>f) a <code><name></code> that has a "latest" tag satisfying (e)</li><li>g) a <code>git</code> url that, when cloned, results in (a).</li></ul> <p>Even if you never publish your package, you can still get a lot of benefits of using npm if you just want to write a node program (a), and @@ -56,9 +56,9 @@ least, you need:</p> <ul><li><p>name: This should be a string that identifies your project. Please do not use the name to specify that it runs on node, or is in JavaScript. -You can use the "engines" field to explicitly state the versions of -node (or whatever else) that your program requires, and it's pretty -well assumed that it'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: +You can use the "engines" field to explicitly state the versions of +node (or whatever else) that your program requires, and it's pretty +well assumed that it'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: A semver-compatible version.</p></li><li><p>engines: Specify the versions of node (or whatever else) that your program runs on. The node API changes a lot, and there may be bugs or new @@ -66,22 +66,22 @@ functionality that you depend on. Be explicit.</p></li><li><p>author: Take some credit.</p></li><li><p>scripts: If you have a special compilation or installation script, then you should put it in the <code>scripts</code> hash. You should definitely have at -least a basic smoke-test command as the "scripts.test" field. +least a basic smoke-test command as the "scripts.test" field. See <a href="../doc/scripts.html">scripts(1)</a>.</p></li><li><p>main: If you have a single module that serves as the entry point to your -program (like what the "foo" package gives you at require("foo")), -then you need to specify that in the "main" field.</p></li><li><p>directories: -This is a hash of folders. The best ones to include are "lib" and -"doc", but if you specify a folder full of man pages in "man", then -they'll get installed just like these ones.</p></li></ul> +program (like what the "foo" package gives you at require("foo")), +then you need to specify that in the "main" field.</p></li><li><p>directories: +This is a hash of folders. The best ones to include are "lib" and +"doc", but if you specify a folder full of man pages in "man", then +they'll get installed just like these ones.</p></li></ul> <p>You can use <code>npm init</code> in the root of your package in order to get you started with a pretty basic package.json file. See <code><a href="../doc/init.html">init(1)</a></code> for more info.</p> -<h2 id="Keeping-files-out-of-your-package">Keeping files *out* of your package</h2> +<h2 id="Keeping-files-out-of-your-package">Keeping files <em>out</em> of your package</h2> -<p>Use a <code>.npmignore</code> file to keep stuff out of your package. If there's +<p>Use a <code>.npmignore</code> file to keep stuff out of your package. If there's no .npmignore file, but there <em>is</em> a .gitignore file, then npm will ignore the stuff matched by the .gitignore file. If you <em>want</em> to include something that is excluded by your .gitignore file, you can @@ -100,21 +100,21 @@ of course.)</p> <p><strong>This is important.</strong></p> -<p>If you can not install it locally, you'll have -problems trying to publish it. Or, worse yet, you'll be able to -publish it, but you'll be publishing a broken or pointless package. -So don't do that.</p> +<p>If you can not install it locally, you'll have +problems trying to publish it. Or, worse yet, you'll be able to +publish it, but you'll be publishing a broken or pointless package. +So don't do that.</p> <p>In the root of your package, do this:</p> <pre><code>npm install . -g</code></pre> -<p>That'll show you that it's working. If you'd rather just create a symlink +<p>That'll show you that it's working. If you'd rather just create a symlink package that points to your working directory, then do this:</p> <pre><code>npm link</code></pre> -<p>Use <code>npm ls -g</code> to see if it's there.</p> +<p>Use <code>npm ls -g</code> to see if it's there.</p> <p>To test a local install, go into some other folder, and then do:</p> @@ -123,8 +123,8 @@ npm install ../my-package</code></pre> <p>to install it locally into the node_modules folder in that other place.</p> -<p>Then go into the node-repl, and try using require("my-thing") to -bring in your module's main module.</p> +<p>Then go into the node-repl, and try using require("my-thing") to +bring in your module's main module.</p> <h2 id="Create-a-User-Account">Create a User Account</h2> @@ -138,7 +138,7 @@ bring in your module's main module.</p> <h2 id="Publish-your-package">Publish your package</h2> -<p>This part's easy. IN the root of your folder, do this:</p> +<p>This part's easy. IN the root of your folder, do this:</p> <pre><code>npm publish</code></pre> @@ -160,7 +160,7 @@ from a fresh checkout.</p> <ul><li><a href="../doc/faq.html">faq(1)</a></li><li><a href="../doc/npm.html">npm(1)</a></li><li><a href="../doc/init.html">init(1)</a></li><li><a href="../doc/json.html">json(1)</a></li><li><a href="../doc/scripts.html">scripts(1)</a></li><li><a href="../doc/publish.html">publish(1)</a></li><li><a href="../doc/adduser.html">adduser(1)</a></li><li><a href="../doc/registry.html">registry(1)</a></li></ul> </div> -<p id="footer">developers — npm@1.1.46</p> +<p id="footer">developers — npm@1.1.47</p> <script> ;(function () { var wrapper = document.getElementById("wrapper") |