Feature/typings

.babelrc

@@ -1,35 +1,40 @@
 {
   "presets": [
     [
-      "env",
+      "@babel/preset-env",
       {
-        "useBuiltIns": true,
         "targets": {
-          "node": "4.3"
-        },
-        "exclude": [
-          "transform-async-to-generator",
-          "transform-regenerator"
-        ]
-      }
-    ]
-  ],
-  "plugins": [
-    [
-      "transform-object-rest-spread",
-      {
-        "useBuiltIns": true
+          "esmodules": true
+        }
       }
     ]
   ],
-  "env": {
-    "test": {
+  "overrides": [
+    {
+      "test": "ts-out/es",
       "presets": [
-        "env"
-      ],
-      "plugins": [
-        "transform-object-rest-spread"
+        [
+          "@babel/preset-env",
+          {
+            "targets": {
+              "esmodules": true
+            }
+          }
+        ]
+      ]
+    },
+    {
+      "test": "ts-out/cjs",
+      "presets": [
+        [
+          "@babel/preset-env",
+          {
+            "targets": {
+              "node": "4.3"
+            }
+          }
+        ]
       ]
     }
-  }
-}
+  ]
+}

.gitignore

@@ -1,15 +1,24 @@
+# Tool-generated files
 logs
 *.log
 npm-debug.log*
 .eslintcache
+
+# Directories
 /coverage
-/dist
+/cjs
+/es
+/ts-out
 /local
 /reports
 /node_modules
+
+# System meta files
 .DS_Store
 Thumbs.db
+
+# Editors
 .idea
 .vscode
 *.sublime-project
-*.sublime-workspace
+*.sublime-workspace

.npmignore

@@ -0,0 +1,3 @@
+src
+test
+ts-out

README.md

@@ -13,6 +13,11 @@ npm i -D webpack-filter-warnings-plugin
 ```
 
 ## Usage
+
+Library supports both CommonJS and ES modules.
+
+### Using CommonJS
+
 ```js
 // webpack.config.js
 const FilterWarningsPlugin = require('webpack-filter-warnings-plugin');
@@ -27,8 +32,69 @@ module.exports = {
 }
 ```
 
-### Why not use the built in stats.warningsFilter option?
-Currently karma-webpack does not respect the stats.warningsFilter option. Also when excluding all warnings, webpack still says `Compiled with warnings.` when all warnings are filtere. Hopefully this plugin will no longer need to exist one day.
+### Using ES modules
+
+Library exposes special ES modules - compatible export. Use it if you are working in environment supporting those.
+Notice additional '/es' suffix in import string.
+
+```js
+// webpack.config.js
+import { FilterWarningsPlugin } from 'webpack-filter-warnings-plugin/es';
+```
+
+### Using with Typescript
+
+Webpack Filter Warnings Plugin is completely written in Typescript. As such, it exposes Typescript bindings (no `@types/` dependency needed for now).
+
+As exported module is CommonJS by default, one needs to use special Typescript syntax to import that module:
+
+```typescript
+// webpack.config.ts
+import FilterWarningsPlugin = require('webpack-filter-warnings-plugin');
+
+```
+
+The recommended way would be to use ES module residing in `webpack-filter-warnings-plugin/es`, though, as in former examples.
+
+## Options
+
+Library exposes only one option: `exclude`. It may be one of `RegExp`, `String` or `Function`.
+
+### String as `exclude` filter
+
+When passing string as exclude parameter, phrase is converted to wildcard and matches any phrase that contains it.
+
+```js
+// webpack.config.js
+module.exports = {
+  // ... rest of webpack config
+  plugins: [
+    new FilterWarningsPlugin({ 
+      exclude: 'hide me'
+    })
+  ]
+}
+
+```
+
+This config will match any of `Should hide me`, `Hide me, please`, `HiDe Me` (filter is case insensitive) etc.
+
+### Function as `exclude` filter
+
+```js
+// webpack.config.js
+module.exports = {
+  // ... rest of webpack config
+  plugins: [
+    new FilterWarningsPlugin({ 
+      exclude: (input) => /.*hide.*/.test(input),
+    })
+  ]
+}
+```
+
+## Why not use the built in stats.warningsFilter option?
+Currently karma-webpack does not respect the stats.warningsFilter option. Also when excluding all warnings, webpack still says `Compiled with warnings.` when all warnings are filtered. Hopefully this plugin will no longer need to exist one day.
 
 ## Licence
 MIT

build-tools/renameIndexes.ts

@@ -0,0 +1,40 @@
+import * as fs from 'fs';
+import glob from 'glob';
+import * as path from 'path';
+
+interface PathToReplace {
+  newPath: string;
+  originalPath: string;
+}
+
+/**
+ * Renames Typescript index files.
+ * As neither Typescript or Babel have capability of easily renaming files along transpiling,
+ * this one creates consistent file names that are easier to use for library consumers
+ */
+glob('ts-out/**/index.**', (err: Error | null, files: string[]) => {
+  const renameMap: PathToReplace[] = files.reduce((memo: PathToReplace[], file: string) => {
+    const newFilename: string = file.replace(/(.*\/index)\.(cjs|es)(\.d)*\.(ts|js)/, '$1$3.$4');
+
+    const originalPath: string = path.resolve(__dirname, '..', file);
+    const newPath: string = path.resolve(__dirname, '..', newFilename);
+
+    if (originalPath !== newPath) {
+      memo.push({
+        originalPath,
+        newPath,
+      });
+    }
+
+    return memo;
+  }, [] as PathToReplace[]);
+
+  if (renameMap.length > 0) {
+    console.log(`Found ${renameMap.length} index files to rename.`); // tslint:disable-line
+
+    renameMap.forEach((renameEntry: PathToReplace) => {
+      console.log(`Renaming ${renameEntry.originalPath} to ${path.basename(renameEntry.newPath)}`); // tslint:disable-line
+      fs.renameSync(renameEntry.originalPath, renameEntry.newPath);
+    });
+  }
+});

build-tools/tsconfig-cjs.json

@@ -0,0 +1,10 @@
+{
+  "extends": "../tsconfig.json",
+  "compilerOptions": {
+    "module": "commonjs",
+    "outDir": "../ts-out/cjs"
+  },
+  "include": [
+    "../src/**/*.cjs.ts"
+  ]
+}

build-tools/tsconfig-es.json

@@ -0,0 +1,10 @@
+{
+  "extends": "../tsconfig.json",
+  "compilerOptions": {
+    "module": "esnext",
+    "outDir": "../ts-out/es"
+  },
+  "include": [
+    "../src/**/*.es.ts"
+  ]
+}

jest.config.js

@@ -0,0 +1,30 @@
+module.exports = {
+  collectCoverageFrom: [
+    'build-tools/**/*.ts',
+    'src/**/*.ts'
+  ],
+  coverageDirectory: 'coverage',
+  coveragePathIgnorePatterns: [
+    '/node_modules/'
+  ],
+  coverageReporters: [
+    'lcov'
+  ],
+  globals: {
+    'ts-jest': {
+      tsConfig: '<rootDir>/test/tsconfig.json',
+    }
+  },
+  moduleDirectories: [
+    'node_modules',
+    'src',
+    'test/unit'
+  ],
+  preset: 'ts-jest',
+  roots: [
+    '<rootDir>/build-tools',
+    '<rootDir>/src',
+    '<rootDir>/test'
+  ],
+  testEnvironment: 'node'
+};