diff options
Diffstat (limited to 'deps/npm/html/doc/files/npm-json.html')
| -rw-r--r-- | deps/npm/html/doc/files/npm-json.html | 24 |
1 files changed, 16 insertions, 8 deletions
diff --git a/deps/npm/html/doc/files/npm-json.html b/deps/npm/html/doc/files/npm-json.html index 6374cc5a7d..6bf69dca1d 100644 --- a/deps/npm/html/doc/files/npm-json.html +++ b/deps/npm/html/doc/files/npm-json.html @@ -129,13 +129,21 @@ is an object with a "name" field and optionally "url" and &q </code></pre><p>Both email and url are optional either way.</p> <p>npm also sets a top-level "maintainers" field with your npm user info.</p> <h2 id="files">files</h2> -<p>The "files" field is an array of files to include in your project. If -you name a folder in the array, then it will also include the files -inside that folder. (Unless they would be ignored by another rule.)</p> -<p>You can also provide a ".npmignore" file in the root of your package or -in subdirectories, which will keep files from being included, even -if they would be picked up by the files array. The <code>.npmignore</code> file -works just like a <code>.gitignore</code>.</p> +<p>The optional "files" field is an array of file patterns that describes +the entries to be included when your package is installed as a +dependency. If the files array is omitted, everything except +automatically-excluded files will be included in your publish. If you +name a folder in the array, then it will also include the files inside +that folder (unless they would be ignored by another rule in this +section.).</p> +<p>You can also provide a <code>.npmignore</code> file in the root of your package or +in subdirectories, which will keep files from being included. At the +root of your package it will not override the "files" field, but in +subdirectories it will. The <code>.npmignore</code> file works just like a +<code>.gitignore</code>. If there is a <code>.gitignore</code> file, and <code>.npmignore</code> is +missing, <code>.gitignore</code>'s contents will be used instead.</p> +<p>Files included with the "package.json#files" field <em>cannot</em> be excluded +through <code>.npmignore</code> or <code>.gitignore</code>.</p> <p>Certain files are always included, regardless of settings:</p> <ul> <li><code>package.json</code></li> @@ -593,5 +601,5 @@ ignored.</p> <tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6> </td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)"> </td></tr> <tr><td colspan=5 style="width:50px;height:10px;background:#fff"> </td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4> </td><td style="width:90px;height:10px;background:#fff" colspan=9> </td></tr> </table> -<p id="footer">package.json — npm@5.3.0</p> +<p id="footer">package.json — npm@5.5.1</p> |