feat: Allow negation in --ignore-files (#1348)

Fix #1347

* test: Add test for negated ignore path
* feat: Allow negation in --ignore-files
* swaps minimatch for multimatch to allow opt-in inclusion of node_modules subset
* test: exercise the build command with negated ignore

package.json

@@ -64,8 +64,8 @@
     "firefox-profile": "1.1.0",
     "fx-runner": "1.0.9",
     "git-rev-sync": "1.9.1",
-    "minimatch": "3.0.4",
     "mkdirp": "0.5.1",
+    "multimatch": "2.1.0",
     "mz": "2.7.0",
     "node-notifier": "5.2.1",
     "opn": "5.3.0",

src/util/file-filter.js

@@ -1,7 +1,7 @@
 /* @flow */
 import path from 'path';
 
-import minimatch from 'minimatch';
+import multimatch from 'multimatch';
 
 import {createLogger} from './logger';
 
@@ -88,7 +88,12 @@ export class FileFilter {
    */
   addToIgnoreList(files: Array<string>) {
     for (const file of files) {
-      this.filesToIgnore.push(this.resolveWithSourceDir(file));
+      if (file.charAt(0) === '!') {
+        const resolvedFile = this.resolveWithSourceDir(file.substr(1));
+        this.filesToIgnore.push(`!${resolvedFile}`);
+      } else {
+        this.filesToIgnore.push(this.resolveWithSourceDir(file));
+      }
     }
   }
 
@@ -104,12 +109,10 @@ export class FileFilter {
    */
   wantFile(filePath: string): boolean {
     const resolvedPath = this.resolveWithSourceDir(filePath);
-    for (const test of this.filesToIgnore) {
-      if (minimatch(resolvedPath, test)) {
-        log.debug(
-          `FileFilter: ignoring file ${resolvedPath} (it matched ${test})`);
-        return false;
-      }
+    const matches = multimatch(resolvedPath, this.filesToIgnore);
+    if (matches.length > 0) {
+      log.debug(`FileFilter: ignoring file ${resolvedPath}`);
+      return false;
     }
     return true;
   }

tests/unit/test-cmd/test.build.js

@@ -372,6 +372,40 @@ describe('build', () => {
       });
   });
 
+  it('zips a package and includes a file from a negated filter', () => {
+    const zipFile = new ZipFile();
+
+    return withTempDir(
+      (tmpDir) =>
+        build({
+          sourceDir: fixturePath('minimal-web-ext'),
+          artifactsDir: tmpDir.path(),
+          ignoreFiles: [
+            '!node_modules',
+            '!node_modules/pkg1',
+            '!node_modules/pkg1/**',
+          ],
+        })
+          .then((buildResult) => {
+            assert.match(buildResult.extensionPath,
+                         /minimal_extension-1\.0\.zip$/);
+            return buildResult.extensionPath;
+          })
+          .then((extensionPath) => zipFile.open(extensionPath))
+          .then(() => zipFile.extractFilenames())
+          .then((fileNames) => {
+            fileNames.sort();
+            assert.deepEqual(fileNames, [
+              'background-script.js', 'manifest.json',
+              'node_modules/',
+              'node_modules/pkg1/',
+              'node_modules/pkg1/file1.txt',
+            ]);
+            return zipFile.close();
+          })
+    );
+  });
+
   describe('safeFileName', () => {
 
     it('makes names safe for writing to a file system', () => {

tests/unit/test-util/test.file-filter.js

@@ -131,4 +131,34 @@ describe('util/file-filter', () => {
     });
   });
 
+  describe('negation', () => {
+    const filter = newFileFilter({
+      sourceDir: '/src',
+      ignoreFiles: [
+        '!node_modules/libdweb/src/**',
+      ],
+    });
+
+    it('ignore paths not captured by negation', () => {
+      assert.equal(filter.wantFile('/src/node_modules/lib/foo.js'), false);
+      assert.equal(filter.wantFile('/src/node_modules/lib'), false);
+      assert.equal(filter.wantFile('/src/node_modules/what.js'), false);
+      assert.equal(filter.wantFile('/src/node_modules/libdweb/what.js'), false);
+      assert.equal(filter.wantFile('/src/node_modules/libdweb/src.js'), false);
+      assert.equal(filter.wantFile('/src/node_modules/libdweb/src'), false);
+    });
+
+    it('includes paths captured by negation', () => {
+      assert.equal(
+        filter.wantFile('/src/node_modules/libdweb/src/lib.js'),
+        true);
+      assert.equal(
+        filter.wantFile('/src/node_modules/libdweb/src/sub/lib.js'),
+        true);
+      assert.equal(
+        filter.wantFile('/src/node_modules/libdweb/src/node_modules/lib.js'),
+        true);
+    });
+  });
+
 });