Parse a package specifier, peeking at the disk to differentiate between
local tarballs, directories and named modules. This implements the logic
npm install and
npm cache to determine where to get packages
var realizePackageSpecifier =
Parses spec using
npm-package-arg and then uses stat to check to see if
it refers to a local tarball or package directory. Stats are done relative
to where. If it does then the local module is loaded. If it doesn't then
target is left as a remote package specifier. Package directories are
recognized by the presence of a package.json in them.
spec -- a package specifier, like:
where (optional, default: .) -- The directory in which we should look for local tarballs or package directories.
callback function(err, result) -- Called once we've determined what
kind of specifier this is. The result object will be very like the one
npm-package-arg except with three differences: 1) There's a
new type of
directory. 2) The
local type only refers to tarballs. 2)
directory type results spec will contain the full path of
the local package.
The full definition of the result object is:
name- If known, the
namefield 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
github:user/projectfor github or
tag- A tagged version, like
version- A specific version number, like
range- A version range, like
local- A local file path
directory- A local package 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
https- 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.
scope- If a name is something like
scopefield will be set to
org. If it doesn't have a scoped name, then scope is