feat: Added --ignore-files option and made build ignore the artifacts directory (#753)

Author: eight04

src/cmd/build.js

@@ -2,7 +2,6 @@
 import path from 'path';
 import {createWriteStream} from 'fs';
 
-import minimatch from 'minimatch';
 import {fs} from 'mz';
 import parseJSON from 'parse-json';
 import eventToPromise from 'event-to-promise';
@@ -13,9 +12,14 @@ import getValidatedManifest, {getManifestId} from '../util/manifest';
 import {prepareArtifactsDir} from '../util/artifacts';
 import {createLogger} from '../util/logger';
 import {UsageError} from '../errors';
+import {
+  createFileFilter as defaultFileFilterCreator,
+  FileFilter,
+} from '../util/file-filter';
 // Import flow types.
 import type {OnSourceChangeFn} from '../watcher';
 import type {ExtensionManifest} from '../util/manifest';
+import type {FileFilterCreatorFn} from '../util/file-filter';
 
 const log = createLogger(__filename);
 
@@ -139,25 +143,34 @@ export type BuildCmdParams = {|
   sourceDir: string,
   artifactsDir: string,
   asNeeded?: boolean,
+  ignoreFiles?: Array<string>,
 |};
 
 export type BuildCmdOptions = {|
   manifestData?: ExtensionManifest,
   fileFilter?: FileFilter,
   onSourceChange?: OnSourceChangeFn,
   packageCreator?: PackageCreatorFn,
-  showReadyMessage?: boolean
+  showReadyMessage?: boolean,
+  createFileFilter?: FileFilterCreatorFn,
 |};
 
 export default async function build(
-  {sourceDir, artifactsDir, asNeeded = false}: BuildCmdParams,
+  {sourceDir, artifactsDir, asNeeded = false, ignoreFiles = []}: BuildCmdParams,
   {
-    manifestData, fileFilter = new FileFilter(),
+    manifestData,
+    createFileFilter = defaultFileFilterCreator,
+    fileFilter = createFileFilter({
+      sourceDir,
+      artifactsDir,
+      ignoreFiles,
+    }),
     onSourceChange = defaultSourceWatcher,
     packageCreator = defaultPackageCreator,
     showReadyMessage = true,
   }: BuildCmdOptions = {}
 ): Promise<ExtensionBuildResult> {
+
   const rebuildAsNeeded = asNeeded; // alias for `build --as-needed`
   log.info(`Building web extension from ${sourceDir}`);
 
@@ -185,42 +198,3 @@ export default async function build(
 
   return result;
 }
-
-
-// FileFilter types and implementation.
-
-export type FileFilterOptions = {|
-  filesToIgnore?: Array<string>,
-|};
-
-/*
- * Allows or ignores files when creating a ZIP archive.
- */
-export class FileFilter {
-  filesToIgnore: Array<string>;
-
-  constructor({filesToIgnore}: FileFilterOptions = {}) {
-    this.filesToIgnore = filesToIgnore || [
-      '**/*.xpi',
-      '**/*.zip',
-      '**/.*', // any hidden file
-      '**/node_modules',
-    ];
-  }
-
-  /*
-   * Returns true if the file is wanted for the ZIP archive.
-   *
-   * This is called by zipdir as wantFile(path, stat) for each
-   * file in the folder that is being archived.
-   */
-  wantFile(path: string): boolean {
-    for (const test of this.filesToIgnore) {
-      if (minimatch(path, test)) {
-        log.debug(`FileFilter: ignoring file ${path}`);
-        return false;
-      }
-    }
-    return true;
-  }
-}

src/cmd/lint.js

@@ -2,8 +2,11 @@
 import {createInstance as defaultLinterCreator} from 'addons-linter';
 
 import {createLogger} from '../util/logger';
-import {FileFilter} from './build';
-
+import {
+  createFileFilter as defaultFileFilterCreator,
+} from '../util/file-filter';
+// import flow types
+import type {FileFilterCreatorFn} from '../util/file-filter';
 
 const log = createLogger(__filename);
 
@@ -46,23 +49,27 @@ export type LintCmdParams = {|
   metadata?: boolean,
   pretty?: boolean,
   warningsAsErrors?: boolean,
+  ignoreFiles?: Array<string>,
+  artifactsDir?: string,
 |};
 
 export type LintCmdOptions = {|
   createLinter?: LinterCreatorFn,
-  fileFilter?: FileFilter,
+  createFileFilter?: FileFilterCreatorFn,
 |};
 
 export default function lint(
   {
     verbose, sourceDir, selfHosted, boring, output,
-    metadata, pretty, warningsAsErrors,
+    metadata, pretty, warningsAsErrors, ignoreFiles, artifactsDir,
   }: LintCmdParams,
   {
     createLinter = defaultLinterCreator,
-    fileFilter = new FileFilter(),
+    createFileFilter = defaultFileFilterCreator,
   }: LintCmdOptions = {}
 ): Promise<void> {
+  const fileFilter = createFileFilter({sourceDir, ignoreFiles, artifactsDir});
+
   log.debug(`Running addons-linter on ${sourceDir}`);
   const linter = createLinter({
     config: {

src/cmd/run.js

@@ -15,6 +15,9 @@ import {
 import {createLogger} from '../util/logger';
 import getValidatedManifest, {getManifestId} from '../util/manifest';
 import defaultSourceWatcher from '../watcher';
+import {
+  createFileFilter as defaultFileFilterCreator,
+} from '../util/file-filter';
 // Import objects that are only used as Flow types.
 import type {FirefoxPreferences} from '../firefox/preferences';
 import type {OnSourceChangeFn} from '../watcher';
@@ -26,6 +29,7 @@ import type {
   FirefoxRDPResponseAddon,
 } from '../firefox/remote';
 import type {ExtensionManifest} from '../util/manifest';
+import type {FileFilterCreatorFn} from '../util/file-filter';
 
 const log = createLogger(__filename);
 
@@ -38,18 +42,23 @@ export type WatcherCreatorParams = {|
   artifactsDir: string,
   onSourceChange?: OnSourceChangeFn,
   desktopNotifications?: typeof defaultDesktopNotifications,
+  ignoreFiles?: Array<string>,
+  createFileFilter?: FileFilterCreatorFn,
 |};
 
-
 export type WatcherCreatorFn = (params: WatcherCreatorParams) => Watchpack;
 
 export function defaultWatcherCreator(
   {
-    addonId, client, sourceDir, artifactsDir,
+    addonId, client, sourceDir, artifactsDir, ignoreFiles,
     onSourceChange = defaultSourceWatcher,
     desktopNotifications = defaultDesktopNotifications,
+    createFileFilter = defaultFileFilterCreator,
   }: WatcherCreatorParams
  ): Watchpack {
+  const fileFilter = createFileFilter(
+    {sourceDir, artifactsDir, ignoreFiles}
+  );
   return onSourceChange({
     sourceDir,
     artifactsDir,
@@ -67,6 +76,7 @@ export function defaultWatcherCreator(
           throw error;
         });
     },
+    shouldWatchFile: (file) => fileFilter.wantFile(file),
   });
 }
 
@@ -80,22 +90,25 @@ export type ReloadStrategyParams = {|
   profile: FirefoxProfile,
   sourceDir: string,
   artifactsDir: string,
+  ignoreFiles?: Array<string>,
 |};
 
 export type ReloadStrategyOptions = {|
   createWatcher?: WatcherCreatorFn,
+  createFileFilter?: FileFilterCreatorFn,
 |};
 
 export function defaultReloadStrategy(
   {
-    addonId, firefoxProcess, client, profile, sourceDir, artifactsDir,
+    addonId, firefoxProcess, client, profile,
+    sourceDir, artifactsDir, ignoreFiles,
   }: ReloadStrategyParams,
   {
     createWatcher = defaultWatcherCreator,
   }: ReloadStrategyOptions = {}
 ): void {
   const watcher: Watchpack = (
-    createWatcher({addonId, client, sourceDir, artifactsDir})
+    createWatcher({addonId, client, sourceDir, artifactsDir, ignoreFiles})
   );
 
   firefoxProcess.on('close', () => {
@@ -165,6 +178,7 @@ export type CmdRunParams = {|
   browserConsole: boolean,
   customPrefs?: FirefoxPreferences,
   startUrl?: string | Array<string>,
+  ignoreFiles?: Array<string>,
 |};
 
 export type CmdRunOptions = {|
@@ -177,7 +191,7 @@ export default async function run(
   {
     sourceDir, artifactsDir, firefox, firefoxProfile,
     preInstall = false, noReload = false,
-    browserConsole = false, customPrefs, startUrl,
+    browserConsole = false, customPrefs, startUrl, ignoreFiles,
   }: CmdRunParams,
   {
     firefoxApp = defaultFirefoxApp,
@@ -264,6 +278,7 @@ export default async function run(
         sourceDir,
         artifactsDir,
         addonId,
+        ignoreFiles,
       });
     }
   }

src/program.js

@@ -246,6 +246,15 @@ Example: $0 --help run.
       describe: 'Show verbose output',
       type: 'boolean',
     },
+    'ignore-files': {
+      alias: 'i',
+      describe: 'A list of glob patterns to define which files should be ' +
+                'ignored. (Example: --ignore-files=path/to/first.js ' +
+                'path/to/second.js "**/*.log")',
+      demand: false,
+      requiresArg: true,
+      type: 'array',
+    },
   });
 
   program

src/util/file-filter.js

@@ -0,0 +1,119 @@
+/* @flow */
+import path from 'path';
+
+import minimatch from 'minimatch';
+
+import {createLogger} from './logger';
+
+const log = createLogger(__filename);
+
+// Use this function to mimic path.resolve without resolving to absolute path.
+export const normalizeResolve = (file: string): string => {
+  // normalize
+  file = path.normalize(file);
+
+  // trim trailing slash
+  if (path.parse(file).base && file.endsWith(path.sep)) {
+    return file.slice(0, -1);
+  }
+  return file;
+};
+
+// FileFilter types and implementation.
+
+export type FileFilterOptions = {|
+  baseIgnoredPatterns?: Array<string>,
+  ignoreFiles?: Array<string>,
+  sourceDir?: string,
+  artifactsDir?: string,
+|};
+
+/*
+ * Allows or ignores files.
+ */
+export class FileFilter {
+  filesToIgnore: Array<string>;
+  sourceDir: ?string;
+
+  constructor({
+    baseIgnoredPatterns = [
+      '**/*.xpi',
+      '**/*.zip',
+      '**/.*', // any hidden file and folder
+      '**/.*/**/*', // and the content inside hidden folder
+      '**/node_modules',
+      '**/node_modules/**/*',
+    ],
+    ignoreFiles = [],
+    sourceDir,
+    artifactsDir,
+  }: FileFilterOptions = {}) {
+
+    this.filesToIgnore = [];
+    this.sourceDir = sourceDir;
+
+    this.addToIgnoreList(baseIgnoredPatterns);
+    if (ignoreFiles) {
+      this.addToIgnoreList(ignoreFiles);
+    }
+    if (artifactsDir) {
+      this.addToIgnoreList([
+        artifactsDir,
+        path.join(artifactsDir, '**', '*'),
+      ]);
+    }
+  }
+
+  /**
+   *  Resolve relative path to absolute path if sourceDir is setted.
+   */
+  resolve(file: string): string {
+    if (this.sourceDir) {
+      const resolvedPath = path.resolve(this.sourceDir, file);
+      log.debug(
+        `Resolved path ${file} with sourceDir ${this.sourceDir || ''} ` +
+        `to ${resolvedPath}`
+      );
+      return resolvedPath;
+    }
+    return normalizeResolve(file);
+  }
+
+  /**
+   *  Insert more files into filesToIgnore array.
+   */
+  addToIgnoreList(files: Array<string>) {
+    for (const file of files) {
+      this.filesToIgnore.push(this.resolve(file));
+    }
+  }
+
+  /*
+   * Returns true if the file is wanted.
+   *
+   * If path does not start with a slash, it will be treated as a path
+   * relative to sourceDir when matching it against all configured
+   * ignore-patterns.
+   *
+   * This is called by zipdir as wantFile(path, stat) for each
+   * file in the folder that is being archived.
+   */
+  wantFile(path: string): boolean {
+    path = this.resolve(path);
+    for (const test of this.filesToIgnore) {
+      if (minimatch(path, test)) {
+        log.debug(`FileFilter: ignoring file ${path} (it matched ${test})`);
+        return false;
+      }
+    }
+    return true;
+  }
+}
+
+// a helper function to make mocking easier
+
+export const createFileFilter = (
+  (params: FileFilterOptions): FileFilter => new FileFilter(params)
+);
+
+export type FileFilterCreatorFn = typeof createFileFilter;

src/watcher.js

@@ -3,7 +3,7 @@ import Watchpack from 'watchpack';
 import debounce from 'debounce';
 
 import {createLogger} from './util/logger';
-import {FileFilter} from './cmd/build';
+import {FileFilter} from './util/file-filter';
 
 
 const log = createLogger(__filename);