diff options
author | isaacs <i@izs.me> | 2014-01-06 17:02:07 -0800 |
---|---|---|
committer | isaacs <i@izs.me> | 2014-01-06 17:02:07 -0800 |
commit | 1be93659303c89c4cae2b7974e41c8fbeb7ea108 (patch) | |
tree | 1dcb5bf6c3c608185f4a055b445df88099c27c24 /deps/npm/doc | |
parent | b922b5e90d2c14dd332b95827c2533e083df7e55 (diff) | |
download | node-new-1be93659303c89c4cae2b7974e41c8fbeb7ea108.tar.gz |
npm: Upgrade to 1.3.23
Diffstat (limited to 'deps/npm/doc')
-rw-r--r-- | deps/npm/doc/api/npm-repo.md (renamed from deps/npm/doc/api/repo.md) | 0 | ||||
-rw-r--r-- | deps/npm/doc/cli/npm-repo.md (renamed from deps/npm/doc/cli/repo.md) | 0 | ||||
-rw-r--r-- | deps/npm/doc/files/package.json.md | 59 | ||||
-rw-r--r-- | deps/npm/doc/misc/npm-index.md | 16 |
4 files changed, 31 insertions, 44 deletions
diff --git a/deps/npm/doc/api/repo.md b/deps/npm/doc/api/npm-repo.md index af3c52fab6..af3c52fab6 100644 --- a/deps/npm/doc/api/repo.md +++ b/deps/npm/doc/api/npm-repo.md diff --git a/deps/npm/doc/cli/repo.md b/deps/npm/doc/cli/npm-repo.md index 6bc6f3b375..6bc6f3b375 100644 --- a/deps/npm/doc/cli/repo.md +++ b/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 <email> (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 <email> (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) |