[Breaking] packageFilter: bring sync/async into alignment; pass three args: pkg, pkgfile, dir.

See #171.

Author: ljharb

lib/async.js

@@ -126,7 +126,7 @@ module.exports = function resolve(x, options, callback) {
                 try { var pkg = JSON.parse(body); } catch (jsonErr) {}
 
                 if (pkg && opts.packageFilter) {
-                    pkg = opts.packageFilter(pkg, pkgfile);
+                    pkg = opts.packageFilter(pkg, pkgfile, dir);
                 }
                 cb(null, pkg, dir);
             });
@@ -153,7 +153,7 @@ module.exports = function resolve(x, options, callback) {
                 } catch (jsonErr) {}
 
                 if (opts.packageFilter) {
-                    pkg = opts.packageFilter(pkg, pkgfile);
+                    pkg = opts.packageFilter(pkg, pkgfile, x);
                 }
 
                 if (pkg.main) {

lib/sync.js

@@ -88,7 +88,7 @@ module.exports = function (x, options) {
         } catch (jsonErr) {}
 
         if (pkg && opts.packageFilter) {
-            pkg = opts.packageFilter(pkg, dir);
+            pkg = opts.packageFilter(pkg, pkgfile, dir);
         }
 
         return { pkg: pkg, dir: dir };

readme.markdown

@@ -59,9 +59,10 @@ options are:
 
 * opts.isFile - function to asynchronously test whether a file exists
 
-* `opts.packageFilter(pkg, pkgfile)` - transform the parsed package.json contents before looking at the "main" field
+* `opts.packageFilter(pkg, pkgfile, dir)` - transform the parsed package.json contents before looking at the "main" field
   * pkg - package data
   * pkgfile - path to package.json
+  * dir - directory that contains package.json
 
 * `opts.pathFilter(pkg, path, relativePath)` - transform a path within a package
   * pkg - package data
@@ -113,9 +114,10 @@ options are:
 
 * opts.isFile - function to synchronously test whether a file exists
 
-* `opts.packageFilter(pkg, dir)` - transform the parsed package.json contents before looking at the "main" field
+* `opts.packageFilter(pkg, pkgfile, dir)` - transform the parsed package.json contents before looking at the "main" field
   * pkg - package data
-  * dir - directory for package.json (Note: the second argument will change to "pkgfile" in v2)
+  * pkgfile - path to package.json
+  * dir - directory that contains package.json
 
 * `opts.pathFilter(pkg, path, relativePath)` - transform a path within a package
   * pkg - package data

test/filter.js

@@ -3,14 +3,14 @@ var test = require('tape');
 var resolve = require('../');
 
 test('filter', function (t) {
-    t.plan(4);
+    t.plan(5);
     var dir = path.join(__dirname, 'resolver');
     var packageFilterArgs;
     resolve('./baz', {
         basedir: dir,
-        packageFilter: function (pkg, pkgfile) {
+        packageFilter: function (pkg, pkgfile, dir) {
             pkg.main = 'doom';
-            packageFilterArgs = [pkg, pkgfile];
+            packageFilterArgs = [pkg, pkgfile, dir];
             return pkg;
         }
     }, function (err, res, pkg) {
@@ -29,6 +29,9 @@ test('filter', function (t) {
             'second packageFilter argument is "pkgfile"'
         );
 
+        var packageFileDir = packageFilterArgs[2];
+        t.equal(packageFileDir, path.join(dir, 'baz'), 'third packageFilter argument is "dir"');
+
         t.end();
     });
 });

test/filter_sync.js

@@ -7,9 +7,9 @@ test('filter', function (t) {
     var packageFilterArgs;
     var res = resolve.sync('./baz', {
         basedir: dir,
-        packageFilter: function (pkg, dir) {
+        packageFilter: function (pkg, pkgfile, dir) {
             pkg.main = 'doom';
-            packageFilterArgs = [pkg, dir];
+            packageFilterArgs = [pkg, pkgfile, dir];
             return pkg;
         }
     });
@@ -20,7 +20,14 @@ test('filter', function (t) {
     t.equal(packageData.main, 'doom', 'package "main" was altered');
 
     var packageFile = packageFilterArgs[1];
-    t.equal(packageFile, path.join(dir, 'baz'), 'second packageFilter argument is "dir"');
+    t.equal(
+        packageFile,
+        path.join(dir, 'baz/package.json'),
+        'second packageFilter argument is "pkgfile"'
+    );
+
+    var packageFileDir = packageFilterArgs[2];
+    t.equal(packageFileDir, path.join(dir, 'baz'), 'third packageFilter argument is "dir"');
 
     t.end();
 });