start tests

Author: Gerald Yeo

README.md

@@ -5,15 +5,13 @@
 [![npm][npm-badge]][npm-link]
 [![Build Status][circle-badge]][circle-link]
 
-This is a webpack plugin that allows you to filter the final output files
-before they are being written to disk. This is useful if you're creating
-multiple output bundles with common assets. As such, you can use this
-to omit it in other runs.
+This webpack plugin allows you to filter the list of output files before
+they are being written / emitted to disk. It does not prevent files
+from `import` or `require` from being processed and bundled, keeping the
+file references like image assets in your bundled code.
 
-Unlike the [IgnorePlugin][ignore-plugin-package], this does not prevent
-an `import` or `require` from being bundled, but instead, omits certain
-files from being written to disk, ensuring that any update of references
-due to hashing or other processing will still happen.
+This is useful if you're creating multiple output bundles with common assets.
+As such, you can use this to omit it in other runs.
 
 ## Installation
 
@@ -35,18 +33,18 @@ const webpackConfig = {
   output: {
     path: path.join(__dirname, 'dist'),
     filename: 'assets/app.[chunkhash].js',
-    chunkFilename: 'assets/[id].app.[chunkhash].js',
+    chunkFilename: 'assets/[id].app.[chunkhash].js'
   },
   module: {
     rules: [{
-      test: /\.(svg|woff2?|ttf|eot|jpe?g|png|gif)(\?.*)?$/i,
+      test: /\.svg$/,
       use: {
         loader: 'file-loader?name=[path][name]_[hash].[ext]',
         options: {
-          outputPath: 'assets/images/',
+          outputPath: 'assets/images/'
         }
       }
-    }],
+    }]
   },
   plugins: [
     new ExtractTextPlugin({
@@ -55,7 +53,7 @@ const webpackConfig = {
     }),
     new FilterChunkWebpackPlugin({
       patterns: [
-        'assets/*'
+        'assets/*',
         '!assets/css/*'
       ]
     })
@@ -75,15 +73,16 @@ assets/css/css.98a5a.css
 but not
 
 ```
-assets/images/a5b912cd3.png
+assets/images/a5b912cd3.svg
 ```
 
 ## Options
 
-| option   | type    | default | description                                                                                                           |
-| -------- | ------- | ------- | --------------------------------------------------------------------------------------------------------------------- |
-| patterns | array   | `[]`    | a list of pattern types that are supported by [multimatch][multimatch-package]                                        |
-| include  | boolean | `false` | by default, this plugin will omit the matched result. Setting it to true will select only the matched result instead. |
+| options  | type    | defaults | description                                                                                                                  |
+| -------- | ------- | -------- | ---------------------------------------------------------------------------------------------------------------------------- |
+| patterns | array   | `[]`     | A list of pattern types that are supported by [multimatch][multimatch-package]                                               |
+| include  | boolean | `false`  | By default, this plugin will omit the matched result. Setting it to true will include the matched result instead of omitting |
+| preview  | boolean | `false`  | To print the list of chunks that matches the patterns without applying the changes                                           |
 
 ## License
 

fixtures/test.png

@@ -5,7 +5,8 @@
   "main": "index.js",
   "scripts": {
     "build": "babel src/index.js --out-file index.js",
-    "test": "exit 1"
+    "test": "jest --coverage",
+    "test:watch": "jest --coverage --watch"
   },
   "repository": {
     "type": "git",
@@ -28,6 +29,7 @@
     "babel-cli": "^6.26.0",
     "babel-core": "^6.26.0",
     "babel-preset-es2015": "^6.24.1",
+    "babel-register": "^6.26.0",
     "css-loader": "^0.28.7",
     "eslint": "^4.6.1",
     "extract-text-webpack-plugin": "^3.0.0",

fixtures/test.svg

@@ -3,39 +3,55 @@ import omit from 'lodash.omit';
 import pick from 'lodash.pick';
 
 class FilterChunkWebpackPlugin {
-  constructor(options) {
+  constructor(options = {}) {
     if (!Array.isArray(options.patterns)) {
-      throw new Error('[FilterChunkWebpackPlugin] The "patterns" option should be an array');
+      throw new Error('The "patterns" option should be an array');
     }
 
     this.options = Object.assign({
+      debug: this.log,
       include: false,
       patterns: [],
       preview: false
     }, options);
   }
-  
+
+  log(...args) {
+    // eslint-disable-next-line no-console
+    console.log(...args);
+  }
+
+  filter(...args) {
+    if (this.options.include === true) {
+      return pick(...args);
+    }
+
+    return omit(...args);
+  }
+
   previewMatchedFiles(matchedFiles) {
     const action = this.options.include === true ? 'included' : 'excluded';
 
-    console.log(`${matchedFiles.length} file(s) that will be ${action}`);
-    matchedFiles.forEach((file) => console.log('     %s', file));
-    console.log('');
+    this.options.debug(`${matchedFiles.length} file(s) that will be ${action}`);
+    matchedFiles.forEach((file) => {
+      this.options.debug(file);
+    });
+    this.options.debug('');
   }
 
   apply(compiler) {
-    const filter = this.options.include === true ? pick : omit;
-
-    
     compiler.plugin('emit', (compilation, callback) => {
-      const files = Object.keys(compilation.assets);
-      const matchedFiles = multimatch(files, this.options.patterns);
-
-      if (this.options.preview) {
-        this.previewMatchedFiles(matchedFiles);
-      } else {
-        // eslint-disable-next-line no-param-reassign
-        compilation.assets = filter(compilation.assets, matchedFiles);
+
+      if (this.options.patterns.length > 0) {
+        const files = Object.keys(compilation.assets);
+        const matchedFiles = multimatch(files, this.options.patterns);
+
+        if (this.options.preview) {
+          this.previewMatchedFiles(matchedFiles);
+        } else {
+          // eslint-disable-next-line no-param-reassign
+          compilation.assets = this.filter(compilation.assets, matchedFiles);
+        }
       }
 
       callback();

package.json

@@ -0,0 +1,75 @@
+// import path from 'path';
+// import fs from 'fs';
+// import webpack from 'webpack';
+
+import FilterChunkWebpackPlugin from './index';
+
+describe('FilterChunkWebpackPlugin', function () {
+  const PATTERN_ERROR = 'The "patterns" option should be an array';
+
+  it('should set options from constructor', function () {
+    const plugin = new FilterChunkWebpackPlugin({
+      include: true,
+      preview: true,
+      patterns: ['**/**']
+    });
+    expect(plugin.options.include).toBe(true);
+    expect(plugin.options.preview).toBe(true);
+    expect(plugin.options.patterns).toEqual(['**/**']);
+  });
+
+  it('should throw an Error when patterns is not array', function () {
+    const plugin = () => new FilterChunkWebpackPlugin({
+      patterns: 'test'
+    });
+    expect(plugin).toThrow(PATTERN_ERROR)
+  });
+
+  it('should throw an Error when options not set', function () {
+    const plugin = () => new FilterChunkWebpackPlugin();
+    expect(plugin).toThrow(PATTERN_ERROR)
+  });
+
+  // describe('when deleting files', () => {
+  //   let unlinkSync;
+  //   const outputPath = path.resolve(__dirname, 'assets');
+  //   const webpackConfig = {
+  //     entry: path.join(__dirname, 'entry.js'),
+  //     output: {
+  //       path: outputPath,
+  //       filename: 'bundle.js',
+  //     },
+  //   };
+
+  //   beforeEach(() => { unlinkSync = stub(fs, 'unlinkSync'); });
+  //   afterEach(() => { unlinkSync.restore(); });
+
+  //   it('should delete the extraneous files from the output path', (done) => {
+  //     const compiler = webpack({
+  //       ...webpackConfig,
+  //       plugins: [new WebpackCleanupPlugin({ quiet: true })],
+  //     });
+  //     compiler.run(() => {
+  //       expect(unlinkSync).to.have.been.calledWith(njoin(outputPath, 'a.txt'));
+  //       expect(unlinkSync).to.have.been.calledWith(njoin(outputPath, 'b.txt'));
+  //       expect(unlinkSync).to.not.have.been.calledWith(njoin(outputPath, 'bundle.js'));
+  //       expect(unlinkSync).to.have.been.calledWith(njoin(outputPath, 'foo.json'));
+  //       expect(unlinkSync).to.have.been.calledWith(njoin(outputPath, 'z.txt'));
+  //       done();
+  //     });
+  //   });
+
+  //   it('should not delete when previewing files', (done) => {
+  //     const compiler = webpack({
+  //       ...webpackConfig,
+  //       plugins: [
+  //         new WebpackCleanupPlugin({ preview: true }),
+  //       ],
+  //     });
+  //     compiler.run(() => {
+  //       expect(unlinkSync).to.not.have.been.called;
+  //       done();
+  //     });
+  //   });
+  // });
+});