index.js 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626
  1. var fs = require('fs');
  2. var path = require('path');
  3. var relativePath = require('cached-path-relative');
  4. var browserResolve = require('browser-resolve');
  5. var nodeResolve = require('resolve');
  6. var detective = require('detective');
  7. var through = require('through2');
  8. var concat = require('concat-stream');
  9. var parents = require('parents');
  10. var combine = require('stream-combiner2');
  11. var duplexer = require('duplexer2');
  12. var xtend = require('xtend');
  13. var defined = require('defined');
  14. var inherits = require('inherits');
  15. var Transform = require('readable-stream').Transform;
  16. module.exports = Deps;
  17. inherits(Deps, Transform);
  18. function Deps (opts) {
  19. var self = this;
  20. if (!(this instanceof Deps)) return new Deps(opts);
  21. Transform.call(this, { objectMode: true });
  22. if (!opts) opts = {};
  23. this.basedir = opts.basedir || process.cwd();
  24. this.persistentCache = opts.persistentCache || function (file, id, pkg, fallback, cb) {
  25. process.nextTick(function () {
  26. fallback(null, cb);
  27. });
  28. };
  29. this.cache = opts.cache;
  30. this.fileCache = opts.fileCache;
  31. this.pkgCache = opts.packageCache || {};
  32. this.pkgFileCache = {};
  33. this.pkgFileCachePending = {};
  34. this._emittedPkg = {};
  35. this._transformDeps = {};
  36. this.visited = {};
  37. this.walking = {};
  38. this.entries = [];
  39. this._input = [];
  40. this.paths = opts.paths || process.env.NODE_PATH || '';
  41. if (typeof this.paths === 'string') {
  42. var delimiter = path.delimiter || (process.platform === 'win32' ? ';' : ':');
  43. this.paths = this.paths.split(delimiter);
  44. }
  45. this.paths = this.paths
  46. .filter(Boolean)
  47. .map(function (p) {
  48. return path.resolve(self.basedir, p);
  49. });
  50. this.transforms = [].concat(opts.transform).filter(Boolean);
  51. this.globalTransforms = [].concat(opts.globalTransform).filter(Boolean);
  52. this.resolver = opts.resolve || browserResolve;
  53. this.detective = opts.detect || detective;
  54. this.options = xtend(opts);
  55. if (!this.options.modules) this.options.modules = {};
  56. // If the caller passes options.expose, store resolved pathnames for exposed
  57. // modules in it. If not, set it anyway so it's defined later.
  58. if (!this.options.expose) this.options.expose = {};
  59. this.pending = 0;
  60. this.inputPending = 0;
  61. var topfile = path.join(this.basedir, '__fake.js');
  62. this.top = {
  63. id: topfile,
  64. filename: topfile,
  65. paths: this.paths,
  66. basedir: this.basedir
  67. };
  68. }
  69. Deps.prototype._isTopLevel = function (file) {
  70. var isTopLevel = this.entries.some(function (main) {
  71. var m = relativePath(path.dirname(main), file);
  72. return m.split(/[\\\/]/).indexOf('node_modules') < 0;
  73. });
  74. if (!isTopLevel) {
  75. var m = relativePath(this.basedir, file);
  76. isTopLevel = m.split(/[\\\/]/).indexOf('node_modules') < 0;
  77. }
  78. return isTopLevel;
  79. };
  80. Deps.prototype._transform = function (row, enc, next) {
  81. var self = this;
  82. if (typeof row === 'string') {
  83. row = { file: row };
  84. }
  85. if (row.transform && row.global) {
  86. this.globalTransforms.push([ row.transform, row.options ]);
  87. return next();
  88. }
  89. else if (row.transform) {
  90. this.transforms.push([ row.transform, row.options ]);
  91. return next();
  92. }
  93. self.pending ++;
  94. var basedir = defined(row.basedir, self.basedir);
  95. if (row.entry !== false) {
  96. self.entries.push(path.resolve(basedir, row.file || row.id));
  97. }
  98. self.lookupPackage(row.file, function (err, pkg) {
  99. if (err && self.options.ignoreMissing) {
  100. self.emit('missing', row.file, self.top);
  101. self.pending --;
  102. return next();
  103. }
  104. if (err) return self.emit('error', err)
  105. self.pending --;
  106. self._input.push({ row: row, pkg: pkg });
  107. next();
  108. });
  109. };
  110. Deps.prototype._flush = function () {
  111. var self = this;
  112. var files = {};
  113. self._input.forEach(function (r) {
  114. var w = r.row, f = files[w.file || w.id];
  115. if (f) {
  116. f.row.entry = f.row.entry || w.entry;
  117. var ex = f.row.expose || w.expose;
  118. f.row.expose = ex;
  119. if (ex && f.row.file === f.row.id && w.file !== w.id) {
  120. f.row.id = w.id;
  121. }
  122. }
  123. else files[w.file || w.id] = r;
  124. });
  125. Object.keys(files).forEach(function (key) {
  126. var r = files[key];
  127. var pkg = r.pkg || {};
  128. var dir = r.row.file ? path.dirname(r.row.file) : self.basedir;
  129. if (!pkg.__dirname) pkg.__dirname = dir;
  130. self.walk(r.row, xtend(self.top, {
  131. filename: path.join(dir, '_fake.js')
  132. }));
  133. });
  134. if (this.pending === 0) this.push(null);
  135. this._ended = true;
  136. };
  137. Deps.prototype.resolve = function (id, parent, cb) {
  138. var self = this;
  139. var opts = self.options;
  140. if (xhas(self.cache, parent.id, 'deps', id)
  141. && self.cache[parent.id].deps[id]) {
  142. var file = self.cache[parent.id].deps[id];
  143. var pkg = self.pkgCache[file];
  144. if (pkg) return cb(null, file, pkg);
  145. return self.lookupPackage(file, function (err, pkg) {
  146. cb(null, file, pkg);
  147. });
  148. }
  149. parent.packageFilter = function (p, x) {
  150. var pkgdir = path.dirname(x);
  151. if (opts.packageFilter) p = opts.packageFilter(p, x);
  152. p.__dirname = pkgdir;
  153. return p;
  154. };
  155. if (opts.extensions) parent.extensions = opts.extensions;
  156. if (opts.modules) parent.modules = opts.modules;
  157. self.resolver(id, parent, function onresolve (err, file, pkg, fakePath) {
  158. if (err) return cb(err);
  159. if (!file) return cb(new Error(
  160. 'module not found: "' + id + '" from file '
  161. + parent.filename
  162. ));
  163. if (!pkg || !pkg.__dirname) {
  164. self.lookupPackage(file, function (err, p) {
  165. if (err) return cb(err);
  166. if (!p) p = {};
  167. if (!p.__dirname) p.__dirname = path.dirname(file);
  168. self.pkgCache[file] = p;
  169. onresolve(err, file, opts.packageFilter
  170. ? opts.packageFilter(p, p.__dirname) : p,
  171. fakePath
  172. );
  173. });
  174. }
  175. else cb(err, file, pkg, fakePath);
  176. });
  177. };
  178. Deps.prototype.readFile = function (file, id, pkg) {
  179. var self = this;
  180. if (xhas(this.fileCache, file)) {
  181. return toStream(this.fileCache[file]);
  182. }
  183. var rs = fs.createReadStream(file, {
  184. encoding: 'utf8'
  185. });
  186. return rs;
  187. };
  188. Deps.prototype.getTransforms = function (file, pkg, opts) {
  189. if (!opts) opts = {};
  190. var self = this;
  191. var isTopLevel;
  192. if (opts.builtin || opts.inNodeModules) isTopLevel = false;
  193. else isTopLevel = this._isTopLevel(file);
  194. var transforms = [].concat(isTopLevel ? this.transforms : [])
  195. .concat(getTransforms(pkg, {
  196. globalTransform: this.globalTransforms,
  197. transformKey: this.options.transformKey
  198. }))
  199. ;
  200. if (transforms.length === 0) return through();
  201. var pending = transforms.length;
  202. var streams = [];
  203. var input = through();
  204. var output = through();
  205. var dup = duplexer(input, output);
  206. for (var i = 0; i < transforms.length; i++) (function (i) {
  207. makeTransform(transforms[i], function (err, trs) {
  208. if (err) {
  209. return dup.emit('error', err);
  210. }
  211. streams[i] = trs;
  212. if (-- pending === 0) done();
  213. });
  214. })(i);
  215. return dup;
  216. function done () {
  217. var middle = combine.apply(null, streams);
  218. middle.on('error', function (err) {
  219. err.message += ' while parsing file: ' + file;
  220. if (!err.filename) err.filename = file;
  221. dup.emit('error', err);
  222. });
  223. input.pipe(middle).pipe(output);
  224. }
  225. function makeTransform (tr, cb) {
  226. var trOpts = {};
  227. if (Array.isArray(tr)) {
  228. trOpts = tr[1] || {};
  229. tr = tr[0];
  230. }
  231. trOpts._flags = trOpts.hasOwnProperty('_flags') ? trOpts._flags : self.options;
  232. if (typeof tr === 'function') {
  233. var t = tr(file, trOpts);
  234. // allow transforms to `stream.emit('dep', path)` to add dependencies for this file
  235. t.on('dep', function (dep) {
  236. if (!self._transformDeps[file]) self._transformDeps[file] = [];
  237. self._transformDeps[file].push(dep);
  238. });
  239. self.emit('transform', t, file);
  240. nextTick(cb, null, wrapTransform(t));
  241. }
  242. else {
  243. loadTransform(tr, trOpts, function (err, trs) {
  244. if (err) return cb(err);
  245. cb(null, wrapTransform(trs));
  246. });
  247. }
  248. }
  249. function loadTransform (id, trOpts, cb) {
  250. var params = {
  251. basedir: path.dirname(file),
  252. preserveSymlinks: false
  253. };
  254. nodeResolve(id, params, function nr (err, res, again) {
  255. if (err && again) return cb && cb(err);
  256. if (err) {
  257. params.basedir = pkg.__dirname;
  258. return nodeResolve(id, params, function (e, r) {
  259. nr(e, r, true);
  260. });
  261. }
  262. if (!res) return cb(new Error(
  263. 'cannot find transform module ' + tr
  264. + ' while transforming ' + file
  265. ));
  266. var r = require(res);
  267. if (typeof r !== 'function') {
  268. return cb(new Error(
  269. 'Unexpected ' + typeof r + ' exported by the '
  270. + JSON.stringify(res) + ' package. '
  271. + 'Expected a transform function.'
  272. ));
  273. }
  274. var trs = r(file, trOpts);
  275. // allow transforms to `stream.emit('dep', path)` to add dependencies for this file
  276. trs.on('dep', function (dep) {
  277. if (!self._transformDeps[file]) self._transformDeps[file] = [];
  278. self._transformDeps[file].push(dep);
  279. });
  280. self.emit('transform', trs, file);
  281. cb(null, trs);
  282. });
  283. }
  284. };
  285. Deps.prototype.walk = function (id, parent, cb) {
  286. var self = this;
  287. var opts = self.options;
  288. this.pending ++;
  289. var rec = {};
  290. var input;
  291. if (typeof id === 'object') {
  292. rec = xtend(id);
  293. if (rec.entry === false) delete rec.entry;
  294. id = rec.file || rec.id;
  295. input = true;
  296. this.inputPending ++;
  297. }
  298. self.resolve(id, parent, function (err, file, pkg, fakePath) {
  299. // this is checked early because parent.modules is also modified
  300. // by this function.
  301. var builtin = has(parent.modules, id);
  302. if (rec.expose) {
  303. // Set options.expose to make the resolved pathname available to the
  304. // caller. They may or may not have requested it, but it's harmless
  305. // to set this if they didn't.
  306. self.options.expose[rec.expose] =
  307. self.options.modules[rec.expose] = file;
  308. }
  309. if (pkg && !self._emittedPkg[pkg.__dirname]) {
  310. self._emittedPkg[pkg.__dirname] = true;
  311. self.emit('package', pkg);
  312. }
  313. if (opts.postFilter && !opts.postFilter(id, file, pkg)) {
  314. if (--self.pending === 0) self.push(null);
  315. if (input) --self.inputPending;
  316. return cb && cb(null, undefined);
  317. }
  318. if (err && rec.source) {
  319. file = rec.file;
  320. var ts = self.getTransforms(file, pkg);
  321. ts.on('error', function (err) {
  322. self.emit('error', err);
  323. });
  324. ts.pipe(concat(function (body) {
  325. rec.source = body.toString('utf8');
  326. fromSource(file, rec.source, pkg);
  327. }));
  328. return ts.end(rec.source);
  329. }
  330. if (err && self.options.ignoreMissing) {
  331. if (--self.pending === 0) self.push(null);
  332. if (input) --self.inputPending;
  333. self.emit('missing', id, parent);
  334. return cb && cb(null, undefined);
  335. }
  336. if (err) return self.emit('error', err);
  337. if (self.visited[file]) {
  338. if (-- self.pending === 0) self.push(null);
  339. if (input) --self.inputPending;
  340. return cb && cb(null, file);
  341. }
  342. self.visited[file] = true;
  343. if (rec.source) {
  344. var ts = self.getTransforms(file, pkg);
  345. ts.on('error', function (err) {
  346. self.emit('error', err);
  347. });
  348. ts.pipe(concat(function (body) {
  349. rec.source = body.toString('utf8');
  350. fromSource(file, rec.source, pkg);
  351. }));
  352. return ts.end(rec.source);
  353. }
  354. var c = self.cache && self.cache[file];
  355. if (c) return fromDeps(file, c.source, c.package, fakePath, Object.keys(c.deps));
  356. self.persistentCache(file, id, pkg, persistentCacheFallback, function (err, c) {
  357. self.emit('file', file, id);
  358. if (err) {
  359. self.emit('error', err);
  360. return;
  361. }
  362. fromDeps(file, c.source, c.package, fakePath, Object.keys(c.deps));
  363. });
  364. function persistentCacheFallback (dataAsString, cb) {
  365. var stream = dataAsString ? toStream(dataAsString) : self.readFile(file, id, pkg).on('error', cb);
  366. stream
  367. .pipe(self.getTransforms(fakePath || file, pkg, {
  368. builtin: builtin,
  369. inNodeModules: parent.inNodeModules
  370. }))
  371. .on('error', cb)
  372. .pipe(concat(function (body) {
  373. var src = body.toString('utf8');
  374. try { var deps = getDeps(file, src); }
  375. catch (err) { cb(err); }
  376. if (deps) {
  377. cb(null, {
  378. source: src,
  379. package: pkg,
  380. deps: deps.reduce(function (deps, dep) {
  381. deps[dep] = true;
  382. return deps;
  383. }, {})
  384. });
  385. }
  386. }));
  387. }
  388. });
  389. function getDeps (file, src) {
  390. var deps = rec.noparse ? [] : self.parseDeps(file, src);
  391. // dependencies emitted by transforms
  392. if (self._transformDeps[file]) deps = deps.concat(self._transformDeps[file]);
  393. return deps;
  394. }
  395. function fromSource (file, src, pkg, fakePath) {
  396. var deps = getDeps(file, src);
  397. if (deps) fromDeps(file, src, pkg, fakePath, deps);
  398. }
  399. function fromDeps (file, src, pkg, fakePath, deps) {
  400. var p = deps.length;
  401. var resolved = {};
  402. if (input) --self.inputPending;
  403. (function resolve () {
  404. if (self.inputPending > 0) return setTimeout(resolve);
  405. deps.forEach(function (id) {
  406. if (opts.filter && !opts.filter(id)) {
  407. resolved[id] = false;
  408. if (--p === 0) done();
  409. return;
  410. }
  411. var isTopLevel = self._isTopLevel(fakePath || file);
  412. var current = {
  413. id: file,
  414. filename: file,
  415. basedir: path.dirname(file),
  416. paths: self.paths,
  417. package: pkg,
  418. inNodeModules: parent.inNodeModules || !isTopLevel
  419. };
  420. self.walk(id, current, function (err, r) {
  421. resolved[id] = r;
  422. if (--p === 0) done();
  423. });
  424. });
  425. if (deps.length === 0) done();
  426. })();
  427. function done () {
  428. if (!rec.id) rec.id = file;
  429. if (!rec.source) rec.source = src;
  430. if (!rec.deps) rec.deps = resolved;
  431. if (!rec.file) rec.file = file;
  432. if (self.entries.indexOf(file) >= 0) {
  433. rec.entry = true;
  434. }
  435. self.push(rec);
  436. if (cb) cb(null, file);
  437. if (-- self.pending === 0) self.push(null);
  438. }
  439. }
  440. };
  441. Deps.prototype.parseDeps = function (file, src, cb) {
  442. var self = this;
  443. if (this.options.noParse === true) return [];
  444. if (/\.json$/.test(file)) return [];
  445. if (Array.isArray(this.options.noParse)
  446. && this.options.noParse.indexOf(file) >= 0) {
  447. return [];
  448. }
  449. try { var deps = self.detective(src) }
  450. catch (ex) {
  451. var message = ex && ex.message ? ex.message : ex;
  452. throw new Error(
  453. 'Parsing file ' + file + ': ' + message
  454. );
  455. }
  456. return deps;
  457. };
  458. Deps.prototype.lookupPackage = function (file, cb) {
  459. var self = this;
  460. var cached = this.pkgCache[file];
  461. if (cached) return nextTick(cb, null, cached);
  462. if (cached === false) return nextTick(cb, null, undefined);
  463. var dirs = parents(file ? path.dirname(file) : self.basedir);
  464. (function next () {
  465. if (dirs.length === 0) {
  466. self.pkgCache[file] = false;
  467. return cb(null, undefined);
  468. }
  469. var dir = dirs.shift();
  470. if (dir.split(/[\\\/]/).slice(-1)[0] === 'node_modules') {
  471. return cb(null, undefined);
  472. }
  473. var pkgfile = path.join(dir, 'package.json');
  474. var cached = self.pkgCache[pkgfile];
  475. if (cached) return nextTick(cb, null, cached);
  476. else if (cached === false) return next();
  477. var pcached = self.pkgFileCachePending[pkgfile];
  478. if (pcached) return pcached.push(onpkg);
  479. pcached = self.pkgFileCachePending[pkgfile] = [];
  480. fs.readFile(pkgfile, function (err, src) {
  481. if (err) return onpkg();
  482. try { var pkg = JSON.parse(src) }
  483. catch (err) {
  484. return onpkg(new Error([
  485. err + ' while parsing json file ' + pkgfile
  486. ].join('')));
  487. }
  488. pkg.__dirname = dir;
  489. self.pkgCache[pkgfile] = pkg;
  490. self.pkgCache[file] = pkg;
  491. onpkg(null, pkg);
  492. });
  493. function onpkg (err, pkg) {
  494. if (self.pkgFileCachePending[pkgfile]) {
  495. var fns = self.pkgFileCachePending[pkgfile];
  496. delete self.pkgFileCachePending[pkgfile];
  497. fns.forEach(function (f) { f(err, pkg) });
  498. }
  499. if (err) cb(err);
  500. else if (pkg && typeof pkg === 'object') cb(null, pkg);
  501. else {
  502. self.pkgCache[pkgfile] = false;
  503. next();
  504. }
  505. }
  506. })();
  507. };
  508. function getTransforms (pkg, opts) {
  509. var trx = [];
  510. if (opts.transformKey) {
  511. var n = pkg;
  512. var keys = opts.transformKey;
  513. for (var i = 0; i < keys.length; i++) {
  514. if (n && typeof n === 'object') n = n[keys[i]];
  515. else break;
  516. }
  517. if (i === keys.length) {
  518. trx = [].concat(n).filter(Boolean);
  519. }
  520. }
  521. return trx.concat(opts.globalTransform || []);
  522. }
  523. function nextTick (cb) {
  524. var args = [].slice.call(arguments, 1);
  525. process.nextTick(function () { cb.apply(null, args) });
  526. }
  527. function xhas (obj) {
  528. if (!obj) return false;
  529. for (var i = 1; i < arguments.length; i++) {
  530. var key = arguments[i];
  531. if (!has(obj, key)) return false;
  532. obj = obj[key];
  533. }
  534. return true;
  535. }
  536. function toStream (dataAsString) {
  537. var tr = through();
  538. tr.push(dataAsString);
  539. tr.push(null);
  540. return tr;
  541. }
  542. function has (obj, key) {
  543. return obj && Object.prototype.hasOwnProperty.call(obj, key);
  544. }
  545. function wrapTransform (tr) {
  546. if (typeof tr.read === 'function') return tr;
  547. var input = through(), output = through();
  548. input.pipe(tr).pipe(output);
  549. var wrapper = duplexer(input, output);
  550. tr.on('error', function (err) { wrapper.emit('error', err) });
  551. return wrapper;
  552. }