diff --git a/README.md b/README.md index 67a76a67..c5fc5c4c 100644 --- a/README.md +++ b/README.md @@ -63,17 +63,28 @@ your webpack config: ```javascript // webpack.config.js -var filer = require('filer'); +var { FilerWebpackPlugin } = require('filer/webpack'); module.exports = { plugins: [ - new filer.FilerWebpackPlugin(), + new FilerWebpackPlugin(), ], } ``` +--- +**NOTE** + +Previously it was recommended to access the `FilerWebpackPlugin` class by importing the main filer module. This was depracated due [this issue](https://github.com/filerjs/filer/issues/790). For anyone using ***filer version 1.3.1 or earlier***, please import the plugin class like this: + +```javascript +var FilerWebpackPlugin = require('filer/src/webpack-plugin'); +``` + +--- + You can then import the node.js [fs](http://nodejs.org/api/fs.html) and [path](http://nodejs.org/api/path.html) -modules as normal and FilerWebpackPlugin will ensure that webpack will resolve references to these modules to +modules as normal and `FilerWebpackPlugin` will ensure that webpack will resolve references to these modules to the appropriate filer shims. You will then be able to use these modules as normal (with the exception of the synchronous fs methods e.g. `mkdirSync()`). diff --git a/src/index.js b/src/index.js index 8a77c737..0a25e255 100644 --- a/src/index.js +++ b/src/index.js @@ -9,6 +9,15 @@ module.exports = Filer = { path: require('./path.js'), Errors: require('./errors.js'), Shell: require('./shell/shell.js'), + /** + * @deprecated Importing filer from your webpack config is not recommended. + * + * The filer `FilerWebpackPlugin` class is exposed directly. + * + * ``` + * const { FilerWebpackPlugin } = require('filer/webpack'); + * ``` + */ FilerWebpackPlugin: require('./webpack-plugin'), }; diff --git a/webpack/index.js b/webpack/index.js new file mode 100644 index 00000000..7b353ccb --- /dev/null +++ b/webpack/index.js @@ -0,0 +1,3 @@ +module.exports = { + FilerWebpackPlugin: require('../src/webpack-plugin'), +};