added tests

Author: Gerald Yeo

.gitignore

@@ -60,3 +60,4 @@ typings/
 /lib
 /index.js
 temp
+/.spec_output/*

.npmignore

@@ -5,6 +5,7 @@
 .eslintrc.json
 .nyc_output
 .nycrc
+.spec_output
 .travis.yml
 
 /rollup.config.js

CONTRIBUTING.md

@@ -0,0 +1,48 @@
+# Contributing
+
+[![PRs Welcome][pr-welcome-badge]][pr-welcome-link]
+
+Thank you for opening (and reading) this document. :)
+We are open to, and grateful for, any contributions made.
+
+## Semantic Versioning
+
+This repository generally follows semantic versioning. We release patch versions for bug fixes, minor versions for new features, and major versions for any breaking changes.
+
+All releases to npm or any other supported distribution channels will corresponding to a tagged commit.
+
+## `yarn` vs `npm`
+
+This repository currently uses `yarn` as a development tool, but you may use `npm` instead.
+
+## Testing
+
+To only run linting:
+
+`yarn run lint`
+
+To run tests and coverage:
+
+`yarn test`
+
+To continuously watch and run tests, run the following:
+
+`yarn test:watch`
+
+## Sending a Pull Request
+
+If you send a pull request, please do it against the master branch.
+
+Please __do not__ bump the version and tag your pull request with a v\[number\] as it corresponds to a release.
+
+Before submitting a pull request, please make sure the following is done:
+
+-   Fork the repository and create your branch from master.
+-   If you've added code that should be tested, add tests!
+-   Ensure the test suite passes (`yarn test`).
+-   Make sure your code lints (`yarn lint`).
+
+Thank you for contributing!
+
+[pr-welcome-badge]: https://img.shields.io/badge/PRs-Welcome-ff69b4.svg?style=flat-square
+[pr-welcome-link]: https://github.com/yeojz/filter-chunk-webpack-plugin/blob/master/CONTRIBUTING.md

README.md

@@ -1,6 +1,6 @@
 # filter-chunk-webpack-plugin
 
-> Include or exclude files / chunks from the final output based on a list of patterns
+> Include or exclude files / chunks from the final webpack output based on a list of patterns
 
 [![npm][npm-badge]][npm-link]
 [![Build Status][circle-badge]][circle-link]
@@ -32,15 +32,15 @@ const webpackConfig = {
   entry: 'index.js',
   output: {
     path: path.join(__dirname, 'dist'),
-    filename: 'assets/app.[chunkhash].js',
-    chunkFilename: 'assets/[id].app.[chunkhash].js'
+    filename: 'assets/app.[chunkhash].js'
   },
   module: {
     rules: [{
       test: /\.svg$/,
       use: {
-        loader: 'file-loader?name=[path][name]_[hash].[ext]',
+        loader: 'file-loader',
         options: {
+          name: '[hash].[ext]',
           outputPath: 'assets/images/'
         }
       }
@@ -65,8 +65,6 @@ This should generate files like
 
 ```
 assets/app.12ab3c.js
-assets/1.app.3bcd45.js
-
 assets/css/css.98a5a.css
 ```
 
@@ -76,13 +74,14 @@ but not
 assets/images/a5b912cd3.svg
 ```
 
+For more info, check out the [usage.spec.js](./src/usage.spec.js) for more info.
+
 ## Options
 
-| 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                                           |
+| options  | type    | default | description                                                                                                                         |
+| -------- | ------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------- |
+| patterns | array   | `[]`    | A list of pattern types that are supported by [multimatch][multimatch-package]                                                      |
+| select   | boolean | `false` | By default, this plugin will omit the matched result. Setting this to true will include the matched result instead of omitting them |
 
 ## License
 
@@ -95,4 +94,3 @@ assets/images/a5b912cd3.svg
 [circle-link]: https://circleci.com/gh/yeojz/filter-chunk-webpack-plugin
 
 [multimatch-package]: https://github.com/sindresorhus/multimatch
-[ignore-plugin-package]: https://webpack.js.org/plugins/ignore-plugin/

circle.yml

@@ -0,0 +1,31 @@
+machine:
+  node:
+    version: "6"
+  environment:
+    PATH: "${PATH}:${HOME}/${CIRCLE_PROJECT_REPONAME}/node_modules/.bin"
+general:
+  branches:
+    ignore:
+      - gh-pages
+dependencies:
+  override:
+    - yarn
+  cache_directories:
+    - ~/.cache/yarn
+test:
+  pre:
+    - yarn run clean
+  override:
+    - yarn test
+    - yarn run lint
+    - yarn run coverage
+deployment:
+  release:
+    tag: /^v[0-9]+(\.[0-9]+)*$/
+    owner: yeojz
+    commands:
+      - yarn run clean
+      - yarn run build
+      - echo -e "$NPM_USER\n$NPM_PASS\n$NPM_EMAIL" | npm login
+      - npm publish
+      - npm logout

fixtures/app.js

@@ -0,0 +1,10 @@
+const png = require('./test.png');
+const svg = require('./test.svg');
+
+require('./style.css');
+
+function entry() {
+  return [png, svg];
+}
+
+module.exports = entry;

fixtures/style.css

@@ -0,0 +1,5 @@
+html,
+body {
+  margin: 0;
+  padding: 0;
+}

package.json

@@ -1,10 +1,13 @@
 {
   "name": "filter-chunk-webpack-plugin",
   "version": "0.0.0",
-  "description": "Include or exclude files / chunks from the final output based on a list of patterns",
+  "description": "Include or exclude files / chunks from the final webpack output based on a list of patterns",
   "main": "index.js",
   "scripts": {
     "build": "babel src/index.js --out-file index.js",
+    "clean": "rimraf index.js coverage .spec_output/it-* .nyc_output",
+    "coverage:upload": "codecov",
+    "lint": "eslint --ext js src",
     "test": "jest --coverage",
     "test:watch": "jest --coverage --watch"
   },
@@ -29,15 +32,14 @@
     "babel-cli": "^6.26.0",
     "babel-core": "^6.26.0",
     "babel-preset-es2015": "^6.24.1",
-    "babel-register": "^6.26.0",
+    "codecov": "^2.3.0",
     "css-loader": "^0.28.7",
     "eslint": "^4.6.1",
     "extract-text-webpack-plugin": "^3.0.0",
     "file-loader": "^0.11.2",
     "jest": "^21.0.2",
     "rimraf": "^2.6.2",
     "style-loader": "^0.18.2",
-    "url-loader": "^0.5.9",
     "webpack": "^3.5.6"
   },
   "dependencies": {

src/index.js

@@ -4,54 +4,27 @@ import pick from 'lodash.pick';
 
 class FilterChunkWebpackPlugin {
   constructor(options = {}) {
-    if (!Array.isArray(options.patterns)) {
+    if (typeof options.patterns !== 'undefined' && !Array.isArray(options.patterns)) {
       throw new Error('The "patterns" option should be an array');
     }
 
     this.options = Object.assign({
-      debug: this.log,
-      include: false,
+      select: 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';
-
-    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.select === true ? pick : omit;
+
     compiler.plugin('emit', (compilation, callback) => {
 
       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);
-        }
+        // eslint-disable-next-line no-param-reassign
+        compilation.assets = filter(compilation.assets, matchedFiles);
       }
 
       callback();

src/index.spec.js

@@ -1,7 +1,3 @@
-// import path from 'path';
-// import fs from 'fs';
-// import webpack from 'webpack';
-
 import FilterChunkWebpackPlugin from './index';
 
 describe('FilterChunkWebpackPlugin', function () {
@@ -13,6 +9,7 @@ describe('FilterChunkWebpackPlugin', function () {
       preview: true,
       patterns: ['**/**']
     });
+
     expect(plugin.options.include).toBe(true);
     expect(plugin.options.preview).toBe(true);
     expect(plugin.options.patterns).toEqual(['**/**']);
@@ -22,54 +19,7 @@ describe('FilterChunkWebpackPlugin', 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();
-  //     });
-  //   });
-  // });
 });