[Fix] revert proper but unintended breaking change in sync packageFilter

Fixes #157
browserify · Apr 12, 2018 · f5c2a41 · f5c2a41
1 parent bdf1210
commit f5c2a41
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 8 deletions.
diff --git a/lib/sync.js b/lib/sync.js
@@ -86,7 +86,7 @@ module.exports = function (x, options) {
         } catch (jsonErr) {}
 
         if (pkg && opts.packageFilter) {
-            pkg = opts.packageFilter(pkg, pkgfile);
+            pkg = opts.packageFilter(pkg, dir);
         }
 
         return { pkg: pkg, dir: dir };

diff --git a/readme.markdown b/readme.markdown
@@ -60,6 +60,8 @@ 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
+  * pkg - package data
+  * pkgfile - path to package.json
 
 * `opts.pathFilter(pkg, path, relativePath)` - transform a path within a package
   * pkg - package data
@@ -113,7 +115,9 @@ options are:
 
 * opts.isFile - function to synchronously test whether a file exists
 
-* `opts.packageFilter(pkg, pkgfile)` - transform the parsed package.json contents before looking at the "main" field
+* `opts.packageFilter(pkg, 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)
 
 * `opts.pathFilter(pkg, path, relativePath)` - transform a path within a package
   * pkg - package data

diff --git a/test/filter.js b/test/filter.js
@@ -3,17 +3,32 @@ var test = require('tape');
 var resolve = require('../');
 
 test('filter', function (t) {
-    t.plan(2);
+    t.plan(4);
     var dir = path.join(__dirname, 'resolver');
+    var packageFilterArgs;
     resolve('./baz', {
         basedir: dir,
-        packageFilter: function (pkg) {
+        packageFilter: function (pkg, pkgfile) {
             pkg.main = 'doom';
+            packageFilterArgs = [pkg, pkgfile];
             return pkg;
         }
     }, function (err, res, pkg) {
         if (err) t.fail(err);
-        t.equal(res, path.join(dir, 'baz/doom.js'));
-        t.equal(pkg.main, 'doom');
+
+        t.equal(res, path.join(dir, 'baz/doom.js'), 'changing the package "main" works');
+
+        var packageData = packageFilterArgs[0];
+        t.equal(pkg, packageData, 'first packageFilter argument is "pkg"');
+        t.equal(packageData.main, 'doom', 'package "main" was altered');
+
+        var packageFile = packageFilterArgs[1];
+        t.equal(
+            packageFile,
+            path.join(dir, 'baz/package.json'),
+            'second packageFilter argument is "pkgfile"'
+        );
+
+        t.end();
     });
 });
diff --git a/test/filter_sync.js b/test/filter_sync.js
@@ -4,13 +4,23 @@ var resolve = require('../');
 
 test('filter', function (t) {
     var dir = path.join(__dirname, 'resolver');
+    var packageFilterArgs;
     var res = resolve.sync('./baz', {
         basedir: dir,
-        packageFilter: function (pkg) {
+        packageFilter: function (pkg, dir) {
             pkg.main = 'doom';
+            packageFilterArgs = [pkg, dir];
             return pkg;
         }
     });
-    t.equal(res, path.join(dir, 'baz/doom.js'));
+
+    t.equal(res, path.join(dir, 'baz/doom.js'), 'changing the package "main" works');
+
+    var packageData = packageFilterArgs[0];
+    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.end();
 });