Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/igitscor/webpack-filesystem-plugin
Filesystem wrapper
https://github.com/igitscor/webpack-filesystem-plugin
firstpr-friendly webpack
Last synced: 12 days ago
JSON representation
Filesystem wrapper
- Host: GitHub
- URL: https://github.com/igitscor/webpack-filesystem-plugin
- Owner: iGitScor
- License: mit
- Created: 2017-01-26T10:33:47.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-06-12T06:50:41.000Z (over 7 years ago)
- Last Synced: 2024-12-31T10:04:47.750Z (24 days ago)
- Topics: firstpr-friendly, webpack
- Language: JavaScript
- Size: 16.6 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Webpack filesystem plugin
Filesystem wrapper
[![Build Status][build-badge]][build]
[![codecov][codecoverage-badge]][codecoverage]
[![Dependencies][dependencyci-badge]][dependencyci]
[![dependencies Status][dependencies-badge]][dependencies]
[![devDependencies Status][devDependencies-badge]][devDependencies]
[![MIT License][license-badge]][LICENSE]
## Install Instructions
```bash
$ npm i webpack-filesystem-plugin
```
Note: This plugin needs NodeJS >= 6
## Usage Instructions
**Require `webpack-filesystem-plugin`**
```javascript
var WebpackFilesystem = require('webpack-filesystem-plugin')
```
Add the plugin to your plugin list
```javascript
var config = {
plugins: [
new WebpackFilesystem({
action: 'cp',
source: 'test.txt',
dist: 'awesome.txt',
})
]
}
```
### Options
#### Actions
- [cp](docs/cp.md): Copy files or directories
- [rm](docs/rm.md): Remove files or directories
#### Common options
- `silent` _(bool)_: Display/hide info logs
- `buildTrigger` _(string)_: Webpack build step (c.f [plugin documentation](https://webpack.github.io/docs/plugins.html)). See below accepted steps:
- `after-emit`
- `done`
- `failed`
Use silent mode
```javascript
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:
```javascript
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`
[build-badge]: https://img.shields.io/travis/iGitScor/webpack-filesystem-plugin.svg?style=flat-square
[build]: https://travis-ci.org/iGitScor/webpack-filesystem-plugin
[codecoverage-badge]: https://codecov.io/gh/iGitScor/webpack-filesystem-plugin/branch/master/graph/badge.svg?style=flat-square
[codecoverage]: https://codecov.io/gh/iGitScor/webpack-filesystem-plugin
[dependencyci-badge]: https://dependencyci.com/github/iGitScor/webpack-filesystem-plugin/badge?style=flat-square
[dependencyci]: https://dependencyci.com/github/iGitScor/webpack-filesystem-plugin
[dependencies-badge]: https://david-dm.org/iGitScor/webpack-filesystem-plugin/status.svg?style=flat-square
[dependencies]: https://david-dm.org/iGitScor/webpack-filesystem-plugin
[devDependencies-badge]: https://david-dm.org/iGitScor/webpack-filesystem-plugin/dev-status.svg?style=flat-square
[devDependencies]: https://david-dm.org/iGitScor/webpack-filesystem-plugin?type=dev
[license-badge]: https://img.shields.io/npm/l/webpack-filesystem-plugin.svg?style=flat-square
[license]: https://github.com/iGitScor/webpack-filesystem-plugin/blob/master/LICENSE