diff options
-rw-r--r-- | node_modules/npm-package-arg/CHANGELOG.md | 23 | ||||
-rw-r--r-- | node_modules/npm-package-arg/README.md | 117 | ||||
-rw-r--r-- | node_modules/npm-package-arg/npa.js | 354 | ||||
-rw-r--r-- | node_modules/npm-package-arg/package.json | 64 | ||||
-rw-r--r-- | npm-shrinkwrap.json | 4 | ||||
-rw-r--r-- | package.json | 2 |
6 files changed, 306 insertions, 258 deletions
diff --git a/node_modules/npm-package-arg/CHANGELOG.md b/node_modules/npm-package-arg/CHANGELOG.md new file mode 100644 index 000000000..339ef8793 --- /dev/null +++ b/node_modules/npm-package-arg/CHANGELOG.md @@ -0,0 +1,23 @@ +## new + +* New properties: + * `from` indicates how we parsed this specifier, values are: + localArgument, local, hosted, url and registry. + + _localArgument_ differs from _local_ in that it means the argument + parsing rules were used instead of the dependency parsing rules. That is, the + rules for `npm install /foo` instead of those for `"dependencies": + {"foo": "file:/foo"}`. + +* Changed properties: + * `type` indicates what sort of specifier this is, values are: file, directory, git, remote, version, range, tag. + +* Local specifiers: + * Trailing spaces on local specifiers are no longer trimmed. + * The `spec` field for local specifiers is now a fully resolved path. + * The type is now _file_ or _directory, never _local_. +* Git specifiers: + * The leading `git+` is no longer stripped. This makes the behavior match + `hosted-git-info`. +* Hosted git specifiers: + * The `type` is now _git_. You can check if something is hosted by looking at the `hosted` property or checking to see if `from` is _hosted_. diff --git a/node_modules/npm-package-arg/README.md b/node_modules/npm-package-arg/README.md index 9f4aee1c0..d45032dc7 100644 --- a/node_modules/npm-package-arg/README.md +++ b/node_modules/npm-package-arg/README.md @@ -1,15 +1,7 @@ # npm-package-arg -Parse package name and specifier passed to commands like `npm install` or -`npm cache add`. This just parses the text given-- it's worth noting that -`npm` has further logic it applies by looking at your disk to figure out -what ambiguous specifiers are. If you want that logic, please see -[realize-package-specifier]. - -[realize-package-specifier]: https://www.npmjs.org/package/realize-package-specifier - -Arguments look like: `foo@1.2`, `@bar/foo@1.2`, `foo@user/foo`, `http://x.com/foo.tgz`, -`git+https://github.com/user/foo`, `bitbucket:user/foo`, `foo.tar.gz` or `bar` +Parses package name and specifier passed to commands like `npm install` or +`npm cache add`, or as found in `package.json` dependency sections. ## EXAMPLES @@ -18,93 +10,72 @@ var assert = require("assert") var npa = require("npm-package-arg") // Pass in the descriptor, and it'll return an object -var parsed = npa("@bar/foo@1.2") - -// Returns an object like: -{ - raw: '@bar/foo@1.2', // what was passed in - name: '@bar/foo', // the name of the package - escapedName: '@bar%2ffoo', // the escaped name, for making requests against a registry - scope: '@bar', // the scope of the package, or null - type: 'range', // the type of specifier this is - spec: '>=1.2.0 <1.3.0', // the expanded specifier - rawSpec: '1.2' // the specifier as passed in - } - -// Parsing urls pointing at hosted git services produces a variation: -var parsed = npa("git+https://github.com/user/foo") - -// Returns an object like: -{ - raw: 'git+https://github.com/user/foo', - scope: null, - name: null, - escapedName: null, - rawSpec: 'git+https://github.com/user/foo', - spec: 'user/foo', - type: 'hosted', - hosted: { - type: 'github', - ssh: 'git@github.com:user/foo.git', - sshurl: 'git+ssh://git@github.com/user/foo.git', - https: 'https://github.com/user/foo.git', - directUrl: 'https://raw.githubusercontent.com/user/foo/master/package.json' - } +try { + var parsed = npa("@bar/foo@1.2") +} catch (ex) { + … } - -// Completely unreasonable invalid garbage throws an error -// Make sure you wrap this in a try/catch if you have not -// already sanitized the inputs! -assert.throws(function() { - npa("this is not \0 a valid package name or url") -}) ``` ## USING `var npa = require('npm-package-arg')` -* var result = npa(*arg*) +### var result = npa(*arg*[, *where*]) -Parses *arg* and returns a result object detailing what *arg* is. +* *arg* - a string that you might pass to `npm install`, like: +`foo@1.2`, `@bar/foo@1.2`, `foo@user/foo`, `http://x.com/foo.tgz`, +`git+https://github.com/user/foo`, `bitbucket:user/foo`, `foo.tar.gz`, +`../foo/bar/` or `bar`. If the *arg* you provide doesn't have a specifier +part, eg `foo` then the specifier will default to `latest`. +* *where* - Optionally the path to resolve file paths relative to. Defaults to `process.cwd()` -*arg* -- a package descriptor, like: `foo@1.2`, or `foo@user/foo`, or -`http://x.com/foo.tgz`, or `git+https://github.com/user/foo` +**Throws** if the package name is invalid, a dist-tag is invalid or a URL's protocol is not supported. + +### var result = npa.resolve(*name*, *spec*[, *where*]) + +* *name* - The name of the module you want to install. For example: `foo` or `@bar/foo`. +* *spec* - The specifier indicating where and how you can get this module. Something like: +`1.2`, `^1.7.17`, `http://x.com/foo.tgz`, `git+https://github.com/user/foo`, +`bitbucket:user/foo`, `file:foo.tar.gz` or `file:../foo/bar/`. If not +included then the default is `latest`. +* *where* - Optionally the path to resolve file paths relative to. Defaults to `process.cwd()` + +**Throws** if the package name is invalid, a dist-tag is invalid or a URL's protocol is not supported. ## RESULT OBJECT The objects that are returned by npm-package-arg contain the following keys: -* `name` - If known, the `name` field expected in the resulting pkg. * `type` - One of the following strings: * `git` - A git repo - * `hosted` - A hosted project, from github, bitbucket or gitlab. Originally - either a full url pointing at one of these services or a shorthand like - `user/project` or `github:user/project` for github or `bitbucket:user/project` - for bitbucket. * `tag` - A tagged version, like `"foo@latest"` * `version` - A specific version number, like `"foo@1.2.3"` * `range` - A version range, like `"foo@2.x"` - * `local` - A local file or folder path + * `file` - A local `.tar.gz`, `.tar` or `.tgz` file. + * `directory` - A local directory. * `remote` - An http url (presumably to a tgz) -* `spec` - The "thing". URL, the range, git repo, etc. -* `hosted` - If type=hosted this will be an object with the following keys: - * `type` - github, bitbucket or gitlab - * `ssh` - The ssh path for this git repo - * `sshUrl` - The ssh URL for this git repo - * `httpsUrl` - The HTTPS URL for this git repo - * `directUrl` - The URL for the package.json in this git repo -* `raw` - The original un-modified string that was provided. -* `rawSpec` - The part after the `name@...`, as it was originally - provided. +* `registry` - If true this specifier refers to a resource hosted on a + registry. This is true for `tag`, `version` and `range` types. +* `name` - If known, the `name` field expected in the resulting pkg. * `scope` - If a name is something like `@org/module` then the `scope` field will be set to `@org`. If it doesn't have a scoped name, then scope is `null`. * `escapedName` - A version of `name` escaped to match the npm scoped packages specification. Mostly used when making requests against a registry. When `name` is `null`, `escapedName` will also be `null`. - -If you only include a name and no specifier part, eg, `foo` or `foo@` then -a default of `latest` will be used (as of 4.1.0). This is contrast with -previous behavior where `*` was used. +* `rawSpec` - The specifier part that was parsed out in calls to `npa(arg)`, + or the value of `spec` in calls to `npa.resolve(name, spec). +* `saveSpec` - The normalized specifier, for saving to package.json files. + `null` for registry dependencies. +* `fetchSpec` - The version of the specifier to be used to fetch this + resource. `null` for shortcuts to hosted git dependencies as there isn't + just one URL to try with them. +* `gitRange` - If set, this is a semver specifier to match against git tags with +* `gitCommittish` - If set, this is the specific committish to use with a git dependency. +* `hosted` - If `from === 'hosted'` then this will be a `hosted-git-info` + object. This property is not included when serializing the object as + JSON. +* `raw` - The original un-modified string that was provided. If called as + `npa.resolve(name, spec)` then this will be `name + '@' + spec`. diff --git a/node_modules/npm-package-arg/npa.js b/node_modules/npm-package-arg/npa.js index 07139696d..a94c54abb 100644 --- a/node_modules/npm-package-arg/npa.js +++ b/node_modules/npm-package-arg/npa.js @@ -1,157 +1,201 @@ -var url = require('url') -var assert = require('assert') -var util = require('util') -var semver = require('semver') -var HostedGit = require('hosted-git-info') - +'use strict' module.exports = npa +module.exports.resolve = resolve +module.exports.Result = Result + +let url +let HostedGit +let semver +let path +let validatePackageName +let osenv + +const isWindows = process.platform === 'win32' || global.FAKE_WINDOWS +const hasSlashes = isWindows ? /\\|[/]/ : /[/]/ +const isURL = /^(?:git[+])?[a-z]+:/i +const isFilename = /[.](?:tgz|tar.gz|tar)$/i + +function npa (arg, where) { + let name + let spec + const nameEndsAt = arg[0] === '@' ? arg.slice(1).indexOf('@') + 1 : arg.indexOf('@') + const namePart = nameEndsAt > 0 ? arg.slice(0, nameEndsAt) : arg + if (isURL.test(arg)) { + spec = arg + } else if (namePart[0] !== '@' && (hasSlashes.test(namePart) || isFilename.test(namePart))) { + spec = arg + } else if (nameEndsAt > 0) { + name = namePart + spec = arg.slice(nameEndsAt + 1) + } else { + if (!validatePackageName) validatePackageName = require('validate-npm-package-name') + const valid = validatePackageName(arg) + if (valid.validForOldPackages) { + name = arg + } else { + spec = arg + } + } + return resolve(name, spec, where, arg) +} -var isWindows = process.platform === 'win32' || global.FAKE_WINDOWS -var slashRe = isWindows ? /\\|[/]/ : /[/]/ +const isFilespec = isWindows ? /^(?:[.]|~[/]|[/\\]|[a-zA-Z]:)/ : /^(?:[.]|~[/]|[/]|[a-zA-Z]:)/ -var parseName = /^(?:@([^/]+?)[/])?([^/]+?)$/ -var nameAt = /^(@([^/]+?)[/])?([^/]+?)@/ -var debug = util.debuglog - ? util.debuglog('npa') - : /\bnpa\b/i.test(process.env.NODE_DEBUG || '') - ? function () { - console.error('NPA: ' + util.format.apply(util, arguments).split('\n').join('\nNPA: ')) - } - : function () {} +function resolve (name, spec, where, arg) { + const res = new Result({ + raw: arg, + name: name, + rawSpec: spec, + fromArgument: arg != null + }) -function validName (name) { - if (!name) { - debug('not a name %j', name) - return false - } - var n = name.trim() - if (!n || n.charAt(0) === '.' || - !n.match(/^[a-zA-Z0-9]/) || - n.match(/[/()&?#|<>@:%\s\\*'"!~`]/) || - n.toLowerCase() === 'node_modules' || - n !== encodeURIComponent(n) || - n.toLowerCase() === 'favicon.ico') { - debug('not a valid name %j', name) - return false + if (name) res.setName(name) + + if (spec && (isFilespec.test(spec) || /^file:/i.test(spec))) { + return fromFile(res, where) } - return n -} - -function npa (arg) { - assert.equal(typeof arg, 'string') - arg = arg.trim() - - var res = new Result() - res.raw = arg - res.scope = null - res.escapedName = null - - // See if it's something like foo@... - var nameparse = arg.match(nameAt) - debug('nameparse', nameparse) - if (nameparse && validName(nameparse[3]) && - (!nameparse[2] || validName(nameparse[2]))) { - res.name = (nameparse[1] || '') + nameparse[3] - res.escapedName = escapeName(res.name) - if (nameparse[2]) { - res.scope = '@' + nameparse[2] - } - arg = arg.substr(nameparse[0].length) + if (!HostedGit) HostedGit = require('hosted-git-info') + const hosted = HostedGit.fromUrl(spec, {noGitPlus: true, noCommittish: true}) + if (hosted) { + return fromHostedGit(res, hosted) + } else if (spec && isURL.test(spec)) { + return fromURL(res) + } else if (spec && (hasSlashes.test(spec) || isFilename.test(spec))) { + return fromFile(res, where) } else { - res.name = null + return fromRegistry(res) } +} - res.rawSpec = arg - res.spec = arg +function invalidPackageName (name, valid) { + const err = new Error(`Invalid package name "${name}": ${valid.errors.join('; ')}`) + err.code = 'EINVALIDPACKAGENAME' + return err +} +function invalidTagName (name) { + const err = new Error(`Invalid tag name "${name}": Tags may not have any characters that encodeURIComponent encodes.`) + err.code = 'EINVALIDTAGNAME' + return err +} - var urlparse = url.parse(arg) - debug('urlparse', urlparse) +function Result (opts) { + this.type = opts.type + this.registry = opts.registry + this.where = opts.where + if (opts.raw == null) { + this.raw = opts.name ? opts.name + '@' + opts.rawSpec : opts.rawSpec + } else { + this.raw = opts.raw + } + this.name = undefined + this.escapedName = undefined + this.scope = undefined + this.rawSpec = opts.rawSpec == null ? '' : opts.rawSpec + this.saveSpec = opts.saveSpec + this.fetchSpec = opts.fetchSpec + if (opts.name) this.setName(opts.name) + this.gitRange = opts.gitRange + this.gitCommittish = opts.gitCommittish + this.hosted = opts.hosted +} +Result.prototype = {} - // windows paths look like urls - // don't be fooled! - if (isWindows && urlparse && urlparse.protocol && - urlparse.protocol.match(/^[a-zA-Z]:$/)) { - debug('windows url-ish local path', urlparse) - urlparse = {} +Result.prototype.setName = function (name) { + if (!validatePackageName) validatePackageName = require('validate-npm-package-name') + const valid = validatePackageName(name) + if (!valid.validForOldPackages) { + throw invalidPackageName(name, valid) } + this.name = name + this.scope = name[0] === '@' ? name.slice(0, name.indexOf('/')) : undefined + // scoped packages in couch must have slash url-encoded, e.g. @foo%2Fbar + this.escapedName = name.replace('/', '%2f') + return this +} - if (urlparse.protocol || HostedGit.fromUrl(arg)) { - return parseUrl(res, arg, urlparse) +Result.prototype.toString = function () { + const full = [] + if (this.name != null && this.name !== '') full.push(this.name) + const spec = this.saveSpec || this.fetchSpec || this.rawSpec + if (spec != null && spec !== '') full.push(spec) + return full.length ? full.join('@') : this.raw +} + +Result.prototype.toJSON = function () { + const result = Object.assign({}, this) + delete result.hosted + return result +} + +function setGitCommittish (res, committish) { + if (committish != null && committish.length >= 7 && committish.slice(0, 7) === 'semver:') { + res.gitRange = decodeURIComponent(committish.slice(7)) + res.gitCommittish = null + } else if (committish == null || committish === '') { + res.gitCommittish = 'master' + } else { + res.gitCommittish = committish } + return res +} - // at this point, it's not a url, and not hosted - // If it's a valid name, and doesn't already have a name, then assume - // $name@"" range - // - // if it's got / chars in it, then assume that it's local. - - if (res.name) { - if (arg === '') arg = 'latest' - var version = semver.valid(arg, true) - var range = semver.validRange(arg, true) - // foo@... - if (version) { - res.spec = version - res.type = 'version' - } else if (range) { - res.spec = range - res.type = 'range' - } else if (slashRe.test(arg)) { - parseLocal(res, arg) - } else { - res.type = 'tag' - res.spec = arg - } +const isAbsolutePath = /^[/]|^[A-Za-z]:/ + +function resolvePath (where, spec) { + if (isAbsolutePath.test(spec)) return spec + if (!path) path = require('path') + return path.resolve(where, spec) +} + +function isAbsolute (dir) { + if (dir[0] === '/') return true + if (/^[A-Za-z]:/.test(dir)) return true + return false +} + +function fromFile (res, where) { + if (!where) where = process.cwd() + res.type = isFilename.test(res.rawSpec) ? 'file' : 'directory' + res.where = where + + const spec = res.rawSpec.replace(/\\/g, '/') + .replace(/^file:[/]*([A-Za-z]:)/, '$1') // drive name paths on windows + .replace(/^file:(?:[/]*([~./]))?/, '$1') + if (/^~[/]/.test(spec)) { + // this is needed for windows and for file:~/foo/bar + if (!osenv) osenv = require('osenv') + res.fetchSpec = resolvePath(osenv.home(), spec.slice(2)) + res.saveSpec = 'file:' + spec } else { - var p = arg.match(parseName) - if (p && validName(p[2]) && - (!p[1] || validName(p[1]))) { - res.type = 'tag' - res.spec = 'latest' - res.rawSpec = '' - res.name = arg - res.escapedName = escapeName(res.name) - if (p[1]) { - res.scope = '@' + p[1] - } + res.fetchSpec = resolvePath(where, spec) + if (isAbsolute(spec)) { + res.saveSpec = 'file:' + spec } else { - parseLocal(res, arg) + if (!path) path = require('path') + res.saveSpec = 'file:' + path.relative(where, res.fetchSpec) } } - return res } -function escapeName (name) { - // scoped packages in couch must have slash url-encoded, e.g. @foo%2Fbar - return name && name.replace('/', '%2f') +function fromHostedGit (res, hosted) { + res.type = 'git' + res.hosted = hosted + res.saveSpec = hosted.toString({noGitPlus: false, noCommittish: false}) + res.fetchSpec = hosted.getDefaultRepresentation() === 'shortcut' ? null : hosted.toString() + return setGitCommittish(res, hosted.committish) } -function parseLocal (res, arg) { - // turns out nearly every character is allowed in fs paths - if (/\0/.test(arg)) { - throw new Error('Invalid Path: ' + JSON.stringify(arg)) - } - res.type = 'local' - res.spec = arg -} - -function parseUrl (res, arg, urlparse) { - var gitHost = HostedGit.fromUrl(arg) - if (gitHost) { - res.type = 'hosted' - res.spec = gitHost.toString() - res.hosted = { - type: gitHost.type, - ssh: gitHost.ssh(), - sshUrl: gitHost.sshurl(), - httpsUrl: gitHost.https(), - gitUrl: gitHost.git(), - shortcut: gitHost.shortcut(), - directUrl: gitHost.file('package.json') - } - return res - } +function unsupportedURLType (protocol, spec) { + const err = new Error(`Unsupported URL Type "${protocol}": ${spec}`) + err.code = 'EUNSUPPORTEDPROTOCOL' + return err +} + +function fromURL (res) { + if (!url) url = require('url') + const urlparse = url.parse(res.rawSpec) + res.saveSpec = res.rawSpec // check the protocol, and then see if it's git or not switch (urlparse.protocol) { case 'git:': @@ -162,38 +206,44 @@ function parseUrl (res, arg, urlparse) { case 'git+ssh:': case 'git+file:': res.type = 'git' - res.spec = arg.replace(/^git[+]/, '') + setGitCommittish(res, urlparse.hash != null ? urlparse.hash.slice(1) : '') + urlparse.protocol = urlparse.protocol.replace(/^git[+]/, '') + delete urlparse.hash + res.fetchSpec = url.format(urlparse) break case 'http:': case 'https:': res.type = 'remote' - res.spec = arg - break - - case 'file:': - res.type = 'local' - if (isWindows && arg.match(/^file:\/\/\/?[a-z]:/i)) { - // Windows URIs usually parse all wrong, so we just take matters - // into our own hands, in this case. - res.spec = arg.replace(/^file:\/\/\/?/i, '') - } else { - res.spec = urlparse.pathname - } + res.fetchSpec = res.saveSpec break default: - throw new Error('Unsupported URL Type: ' + arg) + throw unsupportedURLType(urlparse.protocol, res.rawSpec) } return res } -function Result () { - if (!(this instanceof Result)) return new Result() +function fromRegistry (res) { + res.registry = true + const spec = res.rawSpec === '' ? 'latest' : res.rawSpec + // no save spec for registry components as we save based on the fetched + // version, not on the argument so this can't compute that. + res.saveSpec = null + res.fetchSpec = spec + if (!semver) semver = require('semver') + const version = semver.valid(spec, true) + const range = semver.validRange(spec, true) + if (version) { + res.type = 'version' + } else if (range) { + res.type = 'range' + } else { + if (encodeURIComponent(spec) !== spec) { + throw invalidTagName(spec) + } + res.type = 'tag' + } + return res } -Result.prototype.name = null -Result.prototype.type = null -Result.prototype.spec = null -Result.prototype.raw = null -Result.prototype.hosted = null diff --git a/node_modules/npm-package-arg/package.json b/node_modules/npm-package-arg/package.json index 61475cad0..2078c2ef5 100644 --- a/node_modules/npm-package-arg/package.json +++ b/node_modules/npm-package-arg/package.json @@ -2,53 +2,54 @@ "_args": [ [ { + "type": "tag", + "registry": true, "raw": "npm-package-arg@latest", - "scope": null, - "escapedName": "npm-package-arg", "name": "npm-package-arg", + "escapedName": "npm-package-arg", "rawSpec": "latest", - "spec": "latest", - "type": "tag" + "saveSpec": null, + "fetchSpec": "latest" }, - "/Users/zkat/Documents/code/npm" + "/Users/rebecca/code/npm" ] ], "_from": "npm-package-arg@latest", - "_id": "npm-package-arg@4.2.1", + "_id": "npm-package-arg@5.0.1", "_inCache": true, "_location": "/npm-package-arg", - "_nodeVersion": "7.7.1", + "_nodeVersion": "7.7.4", "_npmOperationalInternal": { "host": "packages-18-east.internal.npmjs.com", - "tmp": "tmp/npm-package-arg-4.2.1.tgz_1488928211600_0.17898930050432682" + "tmp": "tmp/npm-package-arg-5.0.1.tgz_1492211885788_0.7383633449207991" }, "_npmUser": { - "name": "zkat", - "email": "kat@sykosomatic.org" + "name": "iarna", + "email": "me@re-becca.org" }, - "_npmVersion": "4.1.2", + "_npmVersion": "4.5.0", "_phantomChildren": {}, "_requested": { + "type": "tag", + "registry": true, "raw": "npm-package-arg@latest", - "scope": null, - "escapedName": "npm-package-arg", "name": "npm-package-arg", + "escapedName": "npm-package-arg", "rawSpec": "latest", - "spec": "latest", - "type": "tag" + "saveSpec": null, + "fetchSpec": "latest" }, "_requiredBy": [ "#USER", "/", "/init-package-json", - "/npm-registry-client", - "/realize-package-specifier" + "/npm-registry-client" ], - "_resolved": "https://registry.npmjs.org/npm-package-arg/-/npm-package-arg-4.2.1.tgz", - "_shasum": "593303fdea85f7c422775f17f9eb7670f680e3ec", + "_resolved": "https://registry.npmjs.org/npm-package-arg/-/npm-package-arg-5.0.1.tgz", + "_shasum": "09a816e3f45a549e3ddaf33e9bae5e7b31077872", "_shrinkwrap": null, "_spec": "npm-package-arg@latest", - "_where": "/Users/zkat/Documents/code/npm", + "_where": "/Users/rebecca/code/npm", "author": { "name": "Isaac Z. Schlueter", "email": "i@izs.me", @@ -58,25 +59,27 @@ "url": "https://github.com/npm/npm-package-arg/issues" }, "dependencies": { - "hosted-git-info": "^2.1.5", - "semver": "^5.1.0" + "hosted-git-info": "^2.4.2", + "osenv": "^0.1.4", + "semver": "^5.1.0", + "validate-npm-package-name": "^3.0.0" }, "description": "Parse the things that can be arguments to `npm install`", "devDependencies": { - "standard": "^7.1.2", - "tap": "^5.7.2" + "standard": "9.0.2", + "tap": "^10.3.0" }, "directories": { "test": "test" }, "dist": { - "shasum": "593303fdea85f7c422775f17f9eb7670f680e3ec", - "tarball": "https://registry.npmjs.org/npm-package-arg/-/npm-package-arg-4.2.1.tgz" + "shasum": "09a816e3f45a549e3ddaf33e9bae5e7b31077872", + "tarball": "https://registry.npmjs.org/npm-package-arg/-/npm-package-arg-5.0.1.tgz" }, "files": [ "npa.js" ], - "gitHead": "2fa53ce9c3a000626e58c115205d4049c5b1ef42", + "gitHead": "c85a786857bcc51a6587bf980d724b82d3d4151d", "homepage": "https://github.com/npm/npm-package-arg", "license": "ISC", "main": "npa.js", @@ -100,13 +103,14 @@ ], "name": "npm-package-arg", "optionalDependencies": {}, - "readme": "ERROR: No README data found!", + "readme": "# npm-package-arg\n\nParses package name and specifier passed to commands like `npm install` or\n`npm cache add`, or as found in `package.json` dependency sections.\n\n## EXAMPLES\n\n```javascript\nvar assert = require(\"assert\")\nvar npa = require(\"npm-package-arg\")\n\n// Pass in the descriptor, and it'll return an object\ntry {\n var parsed = npa(\"@bar/foo@1.2\")\n} catch (ex) {\n …\n}\n```\n\n## USING\n\n`var npa = require('npm-package-arg')`\n\n### var result = npa(*arg*[, *where*])\n\n* *arg* - a string that you might pass to `npm install`, like:\n`foo@1.2`, `@bar/foo@1.2`, `foo@user/foo`, `http://x.com/foo.tgz`,\n`git+https://github.com/user/foo`, `bitbucket:user/foo`, `foo.tar.gz`,\n`../foo/bar/` or `bar`. If the *arg* you provide doesn't have a specifier\npart, eg `foo` then the specifier will default to `latest`.\n* *where* - Optionally the path to resolve file paths relative to. Defaults to `process.cwd()`\n\n**Throws** if the package name is invalid, a dist-tag is invalid or a URL's protocol is not supported.\n\n### var result = npa.resolve(*name*, *spec*[, *where*])\n\n* *name* - The name of the module you want to install. For example: `foo` or `@bar/foo`.\n* *spec* - The specifier indicating where and how you can get this module. Something like:\n`1.2`, `^1.7.17`, `http://x.com/foo.tgz`, `git+https://github.com/user/foo`,\n`bitbucket:user/foo`, `file:foo.tar.gz` or `file:../foo/bar/`. If not\nincluded then the default is `latest`.\n* *where* - Optionally the path to resolve file paths relative to. Defaults to `process.cwd()`\n\n**Throws** if the package name is invalid, a dist-tag is invalid or a URL's protocol is not supported.\n\n## RESULT OBJECT\n\nThe objects that are returned by npm-package-arg contain the following\nkeys:\n\n* `type` - One of the following strings:\n * `git` - A git repo\n * `tag` - A tagged version, like `\"foo@latest\"`\n * `version` - A specific version number, like `\"foo@1.2.3\"`\n * `range` - A version range, like `\"foo@2.x\"`\n * `file` - A local `.tar.gz`, `.tar` or `.tgz` file.\n * `directory` - A local directory.\n * `remote` - An http url (presumably to a tgz)\n* `registry` - If true this specifier refers to a resource hosted on a\n registry. This is true for `tag`, `version` and `range` types.\n* `name` - If known, the `name` field expected in the resulting pkg.\n* `scope` - If a name is something like `@org/module` then the `scope`\n field will be set to `@org`. If it doesn't have a scoped name, then\n scope is `null`.\n* `escapedName` - A version of `name` escaped to match the npm scoped packages\n specification. Mostly used when making requests against a registry. When\n `name` is `null`, `escapedName` will also be `null`.\n* `rawSpec` - The specifier part that was parsed out in calls to `npa(arg)`,\n or the value of `spec` in calls to `npa.resolve(name, spec).\n* `saveSpec` - The normalized specifier, for saving to package.json files.\n `null` for registry dependencies.\n* `fetchSpec` - The version of the specifier to be used to fetch this\n resource. `null` for shortcuts to hosted git dependencies as there isn't\n just one URL to try with them.\n* `gitRange` - If set, this is a semver specifier to match against git tags with\n* `gitCommittish` - If set, this is the specific committish to use with a git dependency.\n* `hosted` - If `from === 'hosted'` then this will be a `hosted-git-info`\n object. This property is not included when serializing the object as\n JSON.\n* `raw` - The original un-modified string that was provided. If called as\n `npa.resolve(name, spec)` then this will be `name + '@' + spec`.\n", + "readmeFilename": "README.md", "repository": { "type": "git", "url": "git+https://github.com/npm/npm-package-arg.git" }, "scripts": { - "test": "standard && tap --coverage test/*.js" + "test": "standard && tap -J --coverage test/*.js" }, - "version": "4.2.1" + "version": "5.0.1" } diff --git a/npm-shrinkwrap.json b/npm-shrinkwrap.json index 9b1435e31..e66a698f3 100644 --- a/npm-shrinkwrap.json +++ b/npm-shrinkwrap.json @@ -594,9 +594,9 @@ "from": "npm-install-checks@3.0.0" }, "npm-package-arg": { - "version": "4.2.1", + "version": "5.0.1", "from": "npm-package-arg@latest", - "resolved": "https://registry.npmjs.org/npm-package-arg/-/npm-package-arg-4.2.1.tgz" + "resolved": "https://registry.npmjs.org/npm-package-arg/-/npm-package-arg-5.0.1.tgz" }, "npm-registry-client": { "version": "8.3.0", diff --git a/package.json b/package.json index fc43d6fa8..8807ce6c7 100644 --- a/package.json +++ b/package.json @@ -75,7 +75,7 @@ "normalize-package-data": "~2.3.8", "npm-cache-filename": "~1.0.2", "npm-install-checks": "~3.0.0", - "npm-package-arg": "~4.2.1", + "npm-package-arg": "~5.0.1", "npm-registry-client": "~8.3.0", "npm-user-validate": "~0.1.5", "npmlog": "~4.0.2", |