deps/npm/lib/link.js

   1 // link with no args: symlink the folder to the global location
   2 // link with package arg: symlink the global to the local
   3
   4 var npm = require("./npm.js")
   5   , symlink = require("./utils/link.js")
   6   , fs = require("graceful-fs")
   7   , log = require("npmlog")
   8   , asyncMap = require("slide").asyncMap
   9   , chain = require("slide").chain
  10   , path = require("path")
  11   , build = require("./build.js")
  12   , npa = require("npm-package-arg")
  13
  14 module.exports = link
  15
  16 link.usage = "npm link (in package dir)"
  17            + "\nnpm link <pkg> (link global into local)"
  18
  19 link.completion = function (opts, cb) {
  20   var dir = npm.globalDir
  21   fs.readdir(dir, function (er, files) {
  22     cb(er, files.filter(function (f) {
  23       return !f.match(/^[\._-]/)
  24     }))
  25   })
  26 }
  27
  28 function link (args, cb) {
  29   if (process.platform === 'win32') {
  30     var semver = require('semver')
  31     if (!semver.gte(process.version, '0.7.9')) {
  32       var msg = 'npm link not supported on windows prior to node 0.7.9'
  33       var e = new Error(msg)
  34       e.code = 'ENOTSUP'
  35       e.errno = require('constants').ENOTSUP
  36       return cb(e)
  37     }
  38   }
  39
  40   if (npm.config.get("global")) {
  41     return cb(new Error("link should never be --global.\n"
  42                        +"Please re-run this command with --local"))
  43   }
  44
  45   if (args.length === 1 && args[0] === ".") args = []
  46   if (args.length) return linkInstall(args, cb)
  47   linkPkg(npm.prefix, cb)
  48 }
  49
  50 function linkInstall (pkgs, cb) {
  51   asyncMap(pkgs, function (pkg, cb) {
  52     var t = path.resolve(npm.globalDir, "..")
  53       , pp = path.resolve(npm.globalDir, pkg)
  54       , rp = null
  55       , target = path.resolve(npm.dir, pkg)
  56
  57     function n (er, data) {
  58       if (er) return cb(er, data)
  59       // install returns [ [folder, pkgId], ... ]
  60       // but we definitely installed just one thing.
  61       var d = data.filter(function (d) { return !d[3] })
  62       var what = npa(d[0][0])
  63       pp = d[0][1]
  64       pkg = what.name
  65       target = path.resolve(npm.dir, pkg)
  66       next()
  67     }
  68
  69     // if it's a folder, a random not-installed thing, or not a scoped package,
  70     // then link or install it first
  71     if (pkg[0] !== "@" && (pkg.indexOf("/") !== -1 || pkg.indexOf("\\") !== -1)) {
  72       return fs.lstat(path.resolve(pkg), function (er, st) {
  73         if (er || !st.isDirectory()) {
  74           npm.commands.install(t, pkg, n)
  75         } else {
  76           rp = path.resolve(pkg)
  77           linkPkg(rp, n)
  78         }
  79       })
  80     }
  81
  82     fs.lstat(pp, function (er, st) {
  83       if (er) {
  84         rp = pp
  85         return npm.commands.install(t, pkg, n)
  86       } else if (!st.isSymbolicLink()) {
  87         rp = pp
  88         next()
  89       } else {
  90         return fs.realpath(pp, function (er, real) {
  91           if (er) log.warn("invalid symbolic link", pkg)
  92           else rp = real
  93           next()
  94         })
  95       }
  96     })
  97
  98     function next () {
  99       chain
 100         ( [ [function (cb) {
 101               log.verbose("link", "symlinking %s to %s",  pp, target)
 102               cb()
 103             }]
 104           , [symlink, pp, target]
 105           // do not run any scripts
 106           , rp && [build, [target], npm.config.get("global"), build._noLC, true]
 107           , [ resultPrinter, pkg, pp, target, rp ] ]
 108         , cb )
 109     }
 110   }, cb)
 111 }
 112
 113 function linkPkg (folder, cb_) {
 114   var me = folder || npm.prefix
 115     , readJson = require("read-package-json")
 116
 117   log.verbose("linkPkg", folder)
 118
 119   readJson(path.resolve(me, "package.json"), function (er, d) {
 120     function cb (er) {
 121       return cb_(er, [[d && d._id, target, null, null]])
 122     }
 123     if (er) return cb(er)
 124     if (!d.name) {
 125       er = new Error("Package must have a name field to be linked")
 126       return cb(er)
 127     }
 128     var target = path.resolve(npm.globalDir, d.name)
 129     symlink(me, target, false, true, function (er) {
 130       if (er) return cb(er)
 131       log.verbose("link", "build target", target)
 132       // also install missing dependencies.
 133       npm.commands.install(me, [], function (er) {
 134         if (er) return cb(er)
 135         // build the global stuff.  Don't run *any* scripts, because
 136         // install command already will have done that.
 137         build([target], true, build._noLC, true, function (er) {
 138           if (er) return cb(er)
 139           resultPrinter(path.basename(me), me, target, cb)
 140         })
 141       })
 142     })
 143   })
 144 }
 145
 146 function resultPrinter (pkg, src, dest, rp, cb) {
 147   if (typeof cb !== "function") cb = rp, rp = null
 148   var where = dest
 149   rp = (rp || "").trim()
 150   src = (src || "").trim()
 151   // XXX If --json is set, then look up the data from the package.json
 152   if (npm.config.get("parseable")) {
 153     return parseableOutput(dest, rp || src, cb)
 154   }
 155   if (rp === src) rp = null
 156   console.log(where + " -> " + src + (rp ? " -> " + rp: ""))
 157   cb()
 158 }
 159
 160 function parseableOutput (dest, rp, cb) {
 161   // XXX this should match ls --parseable and install --parseable
 162   // look up the data from package.json, format it the same way.
 163   //
 164   // link is always effectively "long", since it doesn't help much to
 165   // *just* print the target folder.
 166   // However, we don't actually ever read the version number, so
 167   // the second field is always blank.
 168   console.log(dest + "::" + rp)
 169   cb()
 170 }