diff --git a/deps/npm/doc/api/repo.md b/deps/npm/doc/api/npm-repo.md similarity index 100% rename from deps/npm/doc/api/repo.md rename to deps/npm/doc/api/npm-repo.md diff --git a/deps/npm/doc/cli/repo.md b/deps/npm/doc/cli/npm-repo.md similarity index 100% rename from deps/npm/doc/cli/repo.md rename to deps/npm/doc/cli/npm-repo.md diff --git a/deps/npm/doc/files/package.json.md b/deps/npm/doc/files/package.json.md index 86eb925e66..8e6f97de8f 100644 --- a/deps/npm/doc/files/package.json.md +++ b/deps/npm/doc/files/package.json.md @@ -9,32 +9,6 @@ file. It must be actual JSON, not just a JavaScript object literal. A lot of the behavior described in this document is affected by the config settings described in `npm-config(7)`. -## DEFAULT VALUES - -npm will default some values based on package contents. - -* `"scripts": {"start": "node server.js"}` - - If there is a `server.js` file in the root of your package, then npm - will default the `start` command to `node server.js`. - -* `"scripts":{"preinstall": "node-waf clean || true; node-waf configure build"}` - - If there is a `wscript` file in the root of your package, npm will - default the `preinstall` command to compile using node-waf. - -* `"scripts":{"preinstall": "node-gyp rebuild"}` - - If there is a `binding.gyp` file in the root of your package, npm will - default the `preinstall` command to compile using node-gyp. - -* `"contributors": [...]` - - If there is an `AUTHORS` file in the root of your package, npm will - treat each line as a `Name (url)` format, where email and url - are optional. Lines which start with a `#` or are blank, will be - ignored. - ## name The *most* important things in your package.json are the name and version fields. @@ -122,16 +96,8 @@ You can check [the full list of SPDX license IDs](https://spdx.org/licenses/). Ideally you should pick one that is [OSI](http://opensource.org/licenses/alphabetical) approved. -If you have more complex licensing terms, or you want to provide more detail -in your package.json file, you can use the more verbose plural form, like this: - - "licenses" : [ - { "type" : "MyLicense" - , "url" : "http://github.com/owner/project/path/to/license" - } - ] - -It's also a good idea to include a license file at the top level in your package. +It's also a good idea to include a LICENSE file at the top level in +your package. ## people fields: author, contributors @@ -575,6 +541,27 @@ Any config values can be overridden, but of course only "tag" and See `npm-config(7)` to see the list of config options that can be overridden. +## DEFAULT VALUES + +npm will default some values based on package contents. + +* `"scripts": {"start": "node server.js"}` + + If there is a `server.js` file in the root of your package, then npm + will default the `start` command to `node server.js`. + +* `"scripts":{"preinstall": "node-gyp rebuild"}` + + If there is a `binding.gyp` file in the root of your package, npm will + default the `preinstall` command to compile using node-gyp. + +* `"contributors": [...]` + + If there is an `AUTHORS` file in the root of your package, npm will + treat each line as a `Name (url)` format, where email and url + are optional. Lines which start with a `#` or are blank, will be + ignored. + ## SEE ALSO * semver(7) diff --git a/deps/npm/doc/misc/npm-index.md b/deps/npm/doc/misc/npm-index.md index ba30935121..9f14e51b13 100644 --- a/deps/npm/doc/misc/npm-index.md +++ b/deps/npm/doc/misc/npm-index.md @@ -115,6 +115,10 @@ Publish a package Rebuild a package +## npm-repo(1) + +Open package repository page in the browser + ## npm-restart(1) Start a package @@ -191,10 +195,6 @@ View registry info Display npm username -## repo(1) - -Open package repository page in the browser - # API Documentation ## npm(3) @@ -285,6 +285,10 @@ Publish a package Rebuild a package +## npm-repo(3) + +Open package repository page in the browser + ## npm-restart(3) Start a package @@ -349,10 +353,6 @@ View registry info Display npm username -## repo(3) - -Open package repository page in the browser - # Files ## npm-folders(5) diff --git a/deps/npm/html/doc/README.html b/deps/npm/html/doc/README.html index 5393436305..a16a140ede 100644 --- a/deps/npm/html/doc/README.html +++ b/deps/npm/html/doc/README.html @@ -239,7 +239,7 @@ will no doubt tell you to put the output in a gist or email.

- + diff --git a/deps/npm/html/doc/api/npm-restart.html b/deps/npm/html/doc/api/npm-restart.html index 1fef97a47f..7baa16be10 100644 --- a/deps/npm/html/doc/api/npm-restart.html +++ b/deps/npm/html/doc/api/npm-restart.html @@ -27,7 +27,7 @@ in the packages parameter.

- + diff --git a/deps/npm/html/doc/cli/npm-restart.html b/deps/npm/html/doc/cli/npm-restart.html index 05fd315d59..912999a75a 100644 --- a/deps/npm/html/doc/cli/npm-restart.html +++ b/deps/npm/html/doc/cli/npm-restart.html @@ -24,7 +24,7 @@ the "start" script.

- +