igitscor/webpack-filesystem-plugin

Filesystem wrapper

Webpack filesystem plugin

Filesystem wrapper

Install Instructions

$ npm i webpack-filesystem-plugin

Note: This plugin needs NodeJS >= 6

Usage Instructions

Require webpack-filesystem-plugin

var WebpackFilesystem = require('webpack-filesystem-plugin')

Add the plugin to your plugin list

var config = {
  plugins: [
    new WebpackFilesystem({
      action: 'cp',
      source: 'test.txt',
      dist: 'awesome.txt',
    })
  ]
}

Options

Actions

• cp: Copy files or directories
• rm: Remove files or directories

Common options

• silent (bool): Display/hide info logs
• buildTrigger (string): Webpack build step (c.f plugin documentation). See below accepted steps:
  • after-emit
  • done
  • failed

Use silent mode

var config = {
  plugins: [
    new WebpackFilesystem({
      silent: true,
      action: 'cp',
      source: 'test.txt',
      dist: 'awesome.txt',
    })
  ]
}

logLevel

• Type: String
• Default: strict
• Allowed value: strict, log, none
  • strict: catch errors in an exception, the webpack build crashes
  • log: log errors in a log file (warning.log) and none behavior
  • none: show errors in console (when silent mode is off)

Specify behavior when the plugin fail.

Example:

var config = {
  plugins: [
    new WebpackFilesystem({
      silent: true,
      action: 'cp',
      source: 'test.txt',
      dist: 'awesome.txt',
      logLevel: 'log'
      ...
    })
  ]
}

Contributing

All contributions are welcome. Please make a pull request and make sure things still pass after running npm test

webpack-filesystem-plugin's Issues

Rename plugin class

Hi,

According to Webpack team:

3rd party Plugin names should be foo-webpack-plugin for pkg name and FooWebpackPlugin for class

The package will not be renamed for now but we have to change plugin class.
It should keep compatibility with previous class name.

Task list

• Add class alias
• Change documentation
• Write new test case

If you find another side effect, do not hesitate to correct it

Thank you

Testing in webpack workflow

Hello contributors,

The plugin is test covered as unit library.
We should add test in a webpack workflow.

Contribution

• Creation of a demo webpack build (1 html file, 1 css file)
• Use of this plugin
• Test the webpack build (the plugin result)

Tests

• cp command
• rm command