diff options
Diffstat (limited to 'deps/npm/html/partial/doc/files/npm-json.html')
| -rw-r--r-- | deps/npm/html/partial/doc/files/npm-json.html | 51 |
1 files changed, 39 insertions, 12 deletions
diff --git a/deps/npm/html/partial/doc/files/npm-json.html b/deps/npm/html/partial/doc/files/npm-json.html index 752a10cbe..b2e54ba74 100644 --- a/deps/npm/html/partial/doc/files/npm-json.html +++ b/deps/npm/html/partial/doc/files/npm-json.html @@ -80,8 +80,8 @@ expression syntax version 2.0 string</a>, like this:</p> <pre><code>{ "license" : "(ISC OR GPL-3.0)" } </code></pre><p>If you are using a license that hasn't been assigned an SPDX identifier, or if you are using a custom license, use the following valid SPDX expression:</p> -<pre><code>{ "license" : "LicenseRef-LICENSE" } -</code></pre><p>Then include a LICENSE file at the top level of the package.</p> +<pre><code>{ "license" : "SEE LICENSE IN <filename>" } +</code></pre><p>Then include a file named <code><filename></code> at the top level of the package.</p> <p>Some old packages used license objects or a "licenses" property containing an array of license objects:</p> <pre><code>// Not valid metadata @@ -106,7 +106,11 @@ array of license objects:</p> <pre><code>{ "license": "ISC" } { "license": "(MIT OR Apache-2.0)" } -</code></pre><h2 id="people-fields-author-contributors">people fields: author, contributors</h2> +</code></pre><p>Finally, if you do not wish to grant others the right to use a private or +unpublished package under any terms:</p> +<pre><code>{ "license": "UNLICENSED"} +</code></pre><p>Consider also setting <code>"private": true</code> to prevent accidental publication.</p> +<h2 id="people-fields-author-contributors">people fields: author, contributors</h2> <p>The "author" is one person. "contributors" is an array of people. A "person" is an object with a "name" field and optionally "url" and "email", like this:</p> <pre><code>{ "name" : "Barney Rubble" @@ -125,6 +129,26 @@ inside that folder. (Unless they would be ignored by another rule.)</p> which will keep files from being included, even if they would be picked up by the files array. The ".npmignore" file works just like a ".gitignore".</p> +<p>Certain files are always included, regardless of settings:</p> +<ul> +<li><code>package.json</code></li> +<li><code><a href="../../doc/README.html">README</a></code> (and its variants)</li> +<li><code>CHANGELOG</code> (and its variants)</li> +<li><code>LICENSE</code> / <code>LICENCE</code></li> +</ul> +<p>Conversely, some files are always ignored:</p> +<ul> +<li><code>.git</code></li> +<li><code>CVS</code></li> +<li><code>.svn</code></li> +<li><code>.hg</code></li> +<li><code>.lock-wscript</code></li> +<li><code>.wafpickle-N</code></li> +<li><code>*.swp</code></li> +<li><code>.DS_Store</code></li> +<li><code>._*</code></li> +<li><code>npm-debug.log</code></li> +</ul> <h2 id="main">main</h2> <p>The main field is a module ID that is the primary entry point to your program. That is, if your package is named <code>foo</code>, and a user installs it, and then does @@ -193,9 +217,12 @@ you'll see that it has directories for doc, lib, and man.</p> <p>Tell people where the bulk of your library is. Nothing special is done with the lib folder in any way, but it's useful meta info.</p> <h3 id="directories-bin">directories.bin</h3> -<p>If you specify a <code>bin</code> directory, then all the files in that folder will -be added as children of the <code>bin</code> path.</p> -<p>If you have a <code>bin</code> path already, then this has no effect.</p> +<p>If you specify a <code>bin</code> directory in <code>directories.bin</code>, all the files in +that folder will be added.</p> +<p>Because of the way the <code>bin</code> directive works, specifying both a +<code>bin</code> path and setting <code>directories.bin</code> is an error. If you want to +specify individual files, use <code>bin</code>, and for all the files in an +existing <code>bin</code> directory, use <code>directories.bin</code>.</p> <h3 id="directories-man">directories.man</h3> <p>A folder that is full of man pages. Sugar to generate a "man" array by walking the folder.</p> @@ -476,12 +503,12 @@ specific registry (for example, an internal registry), then use the <code>publishConfig</code> dictionary described below to override the <code>registry</code> config param at publish-time.</p> <h2 id="publishconfig">publishConfig</h2> -<p>This is a set of config values that will be used at publish-time. It's -especially handy if you want to set the tag or registry, so that you can -ensure that a given package is not tagged with "latest" or published to -the global public registry by default.</p> -<p>Any config values can be overridden, but of course only "tag" and -"registry" probably matter for the purposes of publishing.</p> +<p>This is a set of config values that will be used at publish-time. It's +especially handy if you want to set the tag, registry or access, so that +you can ensure that a given package is not tagged with "latest", published +to the global public registry or that a scoped module is private by default.</p> +<p>Any config values can be overridden, but of course only "tag", "registry" and +"access" probably matter for the purposes of publishing.</p> <p>See <code><a href="../misc/npm-config.html">npm-config(7)</a></code> to see the list of config options that can be overridden.</p> <h2 id="default-values">DEFAULT VALUES</h2> |