diff options
| author | Simen Bekkhus <sbekkhus91@gmail.com> | 2015-07-20 12:35:06 +0300 |
|---|---|---|
| committer | Rebecca Turner <me@re-becca.org> | 2015-07-24 12:33:40 +0300 |
| commit | 39752c534e59c9e67a556ecc264940752a423492 (patch) | |
| tree | aca4c70b311755ff7654a0f0d939d0f2d2cf0ca7 /doc | |
| parent | 23348adffc91ce9422fb69d27cab57087ba84ec5 (diff) | |
docs: list files that are auto-in/excluded
PR-URL: https://github.com/npm/npm/pull/9002
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/files/package.json.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/files/package.json.md b/doc/files/package.json.md index 472e8a553..8e4ef9597 100644 --- a/doc/files/package.json.md +++ b/doc/files/package.json.md @@ -183,6 +183,26 @@ 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". +Certain files are always included, regardless of settings: + +* `package.json` +* `README` (and its variants) +* `CHANGELOG` (and its variants) +* `LICENSE` / `LICENCE` + +Conversely, some files are always ignored: + +* `.git` +* `CVS` +* `.svn` +* `.hg` +* `.lock-wscript` +* `.wafpickle-N` +* `*.swp` +* `.DS_Store` +* `._*` +* `npm-debug.log` + ## main The main field is a module ID that is the primary entry point to your program. |