install: add support for package aliases

Author: zkat

lib/install.js

@@ -401,7 +401,7 @@ Installer.prototype.normalizeCurrentTree = function (cb) {
   if (this.currentTree.error) {
     for (let child of this.currentTree.children) {
       if (!child.fakeChild && isExtraneous(child)) {
-        this.currentTree.package.dependencies[child.package.name] = computeVersionSpec(this.currentTree, child)
+        this.currentTree.package.dependencies[moduleName(child)] = computeVersionSpec(this.currentTree, child)
       }
     }
   }
@@ -825,7 +825,11 @@ Installer.prototype.printInstalledForHuman = function (diffs, auditResult) {
   var report = ''
   if (this.args.length && (added || updated)) {
     report += this.args.map((p) => {
-      return `+ ${p.name}@${p.version}`
+      return `+ ${p.name}@${p.version}${
+        !p._requested.name || p._requested.name === p.name
+          ? ''
+          : ` (as ${p._requested.name})`
+      }`
     }).join('\n') + '\n'
   }
   var actions = []
@@ -922,10 +926,14 @@ Installer.prototype.printInstalledForJSON = function (diffs, auditResult) {
   function recordAction (action) {
     var mutation = action[0]
     var child = action[1]
+    const isAlias = child.package && child.package._requested.type === 'alias'
+    const name = isAlias
+      ? child.package._requested.name
+      : child.package && child.package.name
     var result = {
       action: mutation,
-      name: moduleName(child),
-      version: child.package && child.package.version,
+      name,
+      version: child.package && `${isAlias ? `npm:${child.package.name}@` : ''}${child.package.version}`,
       path: child.path
     }
     if (mutation === 'move') {
@@ -947,10 +955,16 @@ Installer.prototype.printInstalledForParseable = function (diffs) {
     } else if (mutation === 'update') {
       var previousVersion = child.oldPkg.package && child.oldPkg.package.version
     }
+    const isAlias = child.package._requested.type === 'alias'
+    const version = child.package && isAlias
+      ? `npm:${child.package.name}@${child.package.version}`
+      : child.package
+        ? child.package.version
+        : ''
     output(
       mutation + '\t' +
       moduleName(child) + '\t' +
-      (child.package ? child.package.version : '') + '\t' +
+      version + '\t' +
       (child.path ? path.relative(self.where, child.path) : '') + '\t' +
       (previousVersion || '') + '\t' +
       (previousPath || ''))

lib/install/action/extract.js

@@ -6,6 +6,7 @@ const figgyPudding = require('figgy-pudding')
 const stat = BB.promisify(require('graceful-fs').stat)
 const gentlyRm = BB.promisify(require('../../utils/gently-rm.js'))
 const mkdirp = BB.promisify(require('mkdirp'))
+const moduleName = require('../../utils/module-name.js')
 const moduleStagingPath = require('../module-staging-path.js')
 const move = require('../../utils/move.js')
 const npa = require('npm-package-arg')
@@ -113,7 +114,7 @@ function readBundled (pkg, staging, extractTo) {
 }
 
 function stageBundledModule (bundler, child, staging, parentPath) {
-  const stageFrom = path.join(parentPath, 'node_modules', child.package.name)
+  const stageFrom = path.join(parentPath, 'node_modules', moduleName(child))
   const stageTo = moduleStagingPath(staging, child)
 
   return BB.map(child.children, (child) => {

lib/install/action/global-install.js

@@ -3,12 +3,13 @@ var path = require('path')
 var npm = require('../../npm.js')
 var Installer = require('../../install.js').Installer
 var packageId = require('../../utils/package-id.js')
+var moduleName = require('../../utils/module-name.js')
 
 module.exports = function (staging, pkg, log, next) {
   log.silly('global-install', packageId(pkg))
   var globalRoot = path.resolve(npm.globalDir, '..')
   npm.config.set('global', true)
-  var install = new Installer(globalRoot, false, [pkg.package.name + '@' + pkg.package._requested.fetchSpec])
+  var install = new Installer(globalRoot, false, [moduleName(pkg) + '@' + pkg.package._requested.rawSpec])
   install.link = false
   install.run(function () {
     npm.config.set('global', false)

lib/install/action/global-link.js

@@ -1,8 +1,9 @@
 'use strict'
+var moduleName = require('../../utils/module-name.js')
 var npm = require('../../npm.js')
 var packageId = require('../../utils/package-id.js')
 
 module.exports = function (staging, pkg, log, next) {
   log.silly('global-link', packageId(pkg))
-  npm.link(pkg.package.name, next)
+  npm.link(moduleName(pkg), next)
 }

lib/install/and-add-parent-to-errors.js

@@ -1,12 +1,13 @@
 'use strict'
+var moduleName = require('../utils/module-name.js')
 var validate = require('aproba')
 
 module.exports = function (parent, cb) {
   validate('F', [cb])
   return function (er) {
     if (!er) return cb.apply(null, arguments)
     if (er instanceof Error && parent && parent.package && parent.package.name) {
-      er.parent = parent.package.name
+      er.parent = moduleName(parent)
     }
     cb(er)
   }

lib/install/deps.js

@@ -57,6 +57,10 @@ function doesChildVersionMatch (child, requested, requestor) {
     if (fromSw.toString() === requested.toString()) return true
   }
 
+  if (requested.type === 'alias') {
+    return doesChildVersionMatch(child, requested.subSpec, requestor)
+  }
+
   if (!registryTypes[requested.type]) {
     var childReq = child.package._requested
     if (childReq) {
@@ -72,7 +76,7 @@ function doesChildVersionMatch (child, requested, requestor) {
     // You'll see this scenario happen with at least tags and git dependencies.
     // Some buggy clients will write spaces into the module name part of a _from.
     if (child.package._from) {
-      var fromReq = npa.resolve(moduleName(child), child.package._from.replace(new RegExp('^\\s*' + moduleName(child) + '\\s*@'), ''))
+      var fromReq = npa(child.package._from)
       if (fromReq.rawSpec === requested.rawSpec) return true
       if (fromReq.type === requested.type && fromReq.saveSpec && fromReq.saveSpec === requested.saveSpec) return true
     }
@@ -289,13 +293,15 @@ function computeVersionSpec (tree, child) {
   var requested
   var childReq = child.package._requested
   if (child.isLink) {
-    requested = npa.resolve(child.package.name, 'file:' + child.realpath, getTop(tree).path)
+    requested = npa.resolve(moduleName(child), 'file:' + child.realpath, getTop(tree).path)
   } else if (childReq && (isNotEmpty(childReq.saveSpec) || (isNotEmpty(childReq.rawSpec) && isNotEmpty(childReq.fetchSpec)))) {
     requested = child.package._requested
   } else if (child.package._from) {
     requested = npa(child.package._from, tree.path)
+  } else if (child.name && child.name !== child.package.name) {
+    requested = npa.resolve(child.name, `npm:${child.package.name}@${child.package.version})`)
   } else {
-    requested = npa.resolve(child.package.name, child.package.version)
+    npa.resolve(child.package.name, child.package.version)
   }
   if (isRegistry(requested)) {
     var version = child.package.version
@@ -305,6 +311,9 @@ function computeVersionSpec (tree, child) {
         !npm.config.get('save-exact')) {
       rangeDescriptor = npm.config.get('save-prefix')
     }
+    if (requested.type === 'alias') {
+      rangeDescriptor = `npm:${requested.subSpec.name}@${rangeDescriptor}`
+    }
     return rangeDescriptor + version
   } else if (requested.type === 'directory' || requested.type === 'file') {
     return 'file:' + unixFormatPath(path.relative(getTop(tree).path, requested.fetchSpec))
@@ -324,7 +333,7 @@ exports.removeDeps = function (args, tree, saveToDependencies, next) {
   for (let pkg of args) {
     var pkgName = moduleName(pkg)
     var toRemove = tree.children.filter(moduleNameMatches(pkgName))
-    var pkgToRemove = toRemove[0] || createChild({package: {name: pkgName}})
+    var pkgToRemove = toRemove[0] || createChild({name: pkgName})
     var saveType = getSaveType(tree, pkg) || 'dependencies'
     if (tree.isTop && saveToDependencies) {
       pkgToRemove.save = saveType
@@ -652,11 +661,13 @@ function resolveWithNewModule (pkg, tree, log, next) {
     addBundled(pkg, (bundleErr) => {
       var parent = earliestInstallable(tree, tree, pkg, log, null) || tree
       var isLink = pkg._requested.type === 'directory'
+      var name = pkg._requested.name || pkg.name
       var child = createChild({
+        name,
         package: pkg,
         parent: parent,
-        path: path.join(parent.isLink ? parent.realpath : parent.path, 'node_modules', pkg.name),
-        realpath: isLink ? pkg._requested.fetchSpec : path.join(parent.realpath, 'node_modules', pkg.name),
+        path: path.join(parent.isLink ? parent.realpath : parent.path, 'node_modules', name),
+        realpath: isLink ? pkg._requested.fetchSpec : path.join(parent.realpath, 'node_modules', name),
         children: pkg._bundled || [],
         isLink: isLink,
         isInLink: parent.isLink,

lib/install/is-only-optional.js

@@ -2,6 +2,7 @@
 module.exports = isOptional
 
 const isOptDep = require('./is-opt-dep.js')
+const moduleName = require('../utils/module-name.js')
 
 function isOptional (node, seen) {
   if (!seen) seen = new Set()
@@ -15,6 +16,6 @@ function isOptional (node, seen) {
   const swOptional = node.fromShrinkwrap && node.package._optional
   return node.requiredBy.every(function (req) {
     if (req.fakeChild && swOptional) return true
-    return isOptDep(req, node.package.name) || isOptional(req, seen)
+    return isOptDep(req, moduleName(node)) || isOptional(req, seen)
   })
 }

lib/install/validate-args.js

@@ -2,6 +2,7 @@
 var validate = require('aproba')
 var asyncMap = require('slide').asyncMap
 var chain = require('slide').chain
+var moduleName = require('../utils/module-name.js')
 var npmInstallChecks = require('npm-install-checks')
 var iferr = require('iferr')
 var checkEngine = npmInstallChecks.checkEngine
@@ -54,7 +55,7 @@ var isInstallable = module.exports.isInstallable = function (pkg, next) {
 }
 
 function checkSelf (idealTree, pkg, force, next) {
-  if (idealTree.package && idealTree.package.name !== pkg.name) return next()
+  if (moduleName(idealTree) !== pkg.name) return next()
   if (force) {
     var warn = new Error("Wouldn't install " + pkg.name + ' as a dependency of itself, but being forced')
     warn.code = 'ENOSELF'

lib/ls.js

@@ -12,6 +12,7 @@ var readPackageTree = require('read-package-tree')
 var archy = require('archy')
 var semver = require('semver')
 var color = require('ansicolors')
+var moduleName = require('./utils/module-name.js')
 var npa = require('npm-package-arg')
 var sortedObject = require('sorted-object')
 var npm = require('./npm.js')
@@ -59,7 +60,9 @@ var lsFromTree = ls.fromTree = function (dir, physicalTree, args, silent, cb) {
     args = []
   } else {
     args = args.map(function (a) {
-      if (typeof a === 'object') {
+      if (typeof a === 'object' && a.package._requested.type === 'alias') {
+        return [moduleName(a), `npm:${a.package.name}@${a.package.version}`, a]
+      } else if (typeof a === 'object') {
         return [a.package.name, a.package.version, a]
       } else {
         var p = npa(a)
@@ -278,6 +281,9 @@ function unloop (root) {
     var deps = current.dependencies = current.dependencies || {}
     Object.keys(deps).forEach(function (d) {
       var dep = deps[d]
+      if (dep.name !== d) {
+        dep.version = `${dep.name}@${dep.version}`
+      }
       if (dep.missing && !dep.dependencies) return
       if (dep.path && seen.has(dep)) {
         dep = deps[d] = Object.assign({}, dep)
@@ -394,6 +400,9 @@ function makeArchy_ (data, long, dir, depth, parent, d) {
   var out = {}
   // the top level is a bit special.
   out.label = data._id || ''
+  if (data._requested && data._requested.type === 'alias') {
+    out.label = `${d}@npm:${out.label}`
+  }
   if (data._found === 'explicit' && data._id) {
     if (npm.color) {
       out.label = color.bgBlack(color.yellow(out.label.trim())) + ' '
@@ -546,3 +555,16 @@ function makeParseable_ (data, long, dir, depth, parent, d) {
          (data.peerInvalid ? ':PEERINVALID' : '') +
          (data.peerMissing ? ':PEERINVALID:MISSING' : '')
 }
+
+function physicalName (data) {
+  if (!data._location) {
+    return data.name
+  } else {
+    const match = data._location.match(/(?:@[^/\\]+[/\\])?[^/\\]+$/i)
+    if (match) {
+      return match[0]
+    } else {
+      return data.name
+    }
+  }
+}

lib/outdated.js

@@ -215,8 +215,8 @@ function makeJSON (list, opts) {
 
 function outdated_ (args, path, tree, parentHas, depth, opts, cb) {
   if (!tree.package) tree.package = {}
-  if (path && tree.package.name) path += ' > ' + tree.package.name
-  if (!path && tree.package.name) path = tree.package.name
+  if (path && moduleName(tree)) path += ' > ' + tree.package.name
+  if (!path && moduleName(tree)) path = tree.package.name
   if (depth > opts.depth) {
     return cb(null, [])
   }