diff options
| author | Maksym Kobieliev <maximaximums@gmail.com> | 2018-06-29 00:53:28 +0300 |
|---|---|---|
| committer | Kat Marchán <kzm@zkat.tech> | 2018-06-29 00:53:28 +0300 |
| commit | 833efe4b2abcef58806f823d77ab8bb8f4f781c6 (patch) | |
| tree | c5e296b417e21d6aec3570b170c6bdbe6fc24bb5 /doc | |
| parent | 8f033d72da3e84a9dbbabe3a768693817af99912 (diff) | |
docs: Add info about tarball requirements (#20986)
Fixes: https://npm.community/t/add-explicit-information-about-package-tarball-directory-structure-to-docs/232
PR-URL: https://github.com/npm/npm/pull/20986
Credit: @Maximaximum
Reviewed-By: @zkat
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/cli/npm-install.md | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/cli/npm-install.md b/doc/cli/npm-install.md index 66f2ce240..7eb8608a8 100644 --- a/doc/cli/npm-install.md +++ b/doc/cli/npm-install.md @@ -69,8 +69,13 @@ after packing it up into a tarball (b). Install a package that is sitting on the filesystem. Note: if you just want to link a dev directory into your npm root, you can do this more easily by - using `npm link`. The filename *must* use `.tar`, `.tar.gz`, or `.tgz` as + using `npm link`. + + Tarball requirements: + * The filename *must* use `.tar`, `.tar.gz`, or `.tgz` as the extension. + * The package contents should reside in a subfolder inside the tarball (usually it is called `package/`). npm strips one directory layer when installing the package (an equivalent of `tar x --strip-components=1` is run). + * The package must contain a `package.json` file with `name` and `version` properties. Example: |