Install

1npm install filemanager-webpack-plugin --save-dev
2# or
3yarn add filemanager-webpack-plugin --dev

Usage

1// webpack.config.js:
2
3const FileManagerPlugin = require('filemanager-webpack-plugin');
4
5export default {
6  // ...rest of the config
7  plugins: [
8    new FileManagerPlugin({
9      events: {
10        onEnd: {
11          copy: [
12            { source: '/path/fromfile.txt', destination: '/path/tofile.txt' },
13            { source: '/path/**/*.js', destination: '/path' },
14          ],
15          move: [
16            { source: '/path/from', destination: '/path/to' },
17            { source: '/path/fromfile.txt', destination: '/path/tofile.txt' },
18          ],
19          delete: ['/path/to/file.txt', '/path/to/directory/'],
20          mkdir: ['/path/to/directory/', '/another/directory/'],
21          archive: [
22            { source: '/path/from', destination: '/path/to.zip' },
23            { source: '/path/**/*.js', destination: '/path/to.zip' },
24            { source: '/path/fromfile.txt', destination: '/path/to.zip' },
25            { source: '/path/fromfile.txt', destination: '/path/to.zip', format: 'tar' },
26            {
27              source: '/path/fromfile.txt',
28              destination: '/path/to.tar.gz',
29              format: 'tar',
30              options: {
31                gzip: true,
32                gzipOptions: {
33                  level: 1,
34                },
35                globOptions: {
36                  // https://github.com/Yqnn/node-readdir-glob#options
37                  dot: true,
38                },
39              },
40            },
41          ],
42        },
43      },
44    }),
45  ],
46};

Options

1new FileManagerPlugin({
2  events: {
3    onStart: {},
4    onEnd: {},
5  },
6  runTasksInSeries: false,
7  runOnceInWatchMode: false,
8});

File Events

• onStart: Commands to execute before Webpack begins the bundling process

Note:

OnStart might execute twice for file changes in webpack context.

1new webpack.WatchIgnorePlugin({
2  paths: [/copied-directory/],
3});

• onEnd: Commands to execute after Webpack has finished the bundling process

File Actions

Copy

Copy individual files or entire directories from a source folder to a destination folder. Also supports glob pattern.

1[
2  { source: '/path/from', destination: '/path/to' },
3  {
4    source: '/path/**/*.js',
5    destination: '/path',
6    options: {
7      flat: false,
8      preserveTimestamps: true,
9      overwrite: true,
10    },
11    globOptions: {
12      dot: true,
13    },
14  },
15  { source: '/path/fromfile.txt', destination: '/path/tofile.txt' },
16  { source: '/path/**/*.{html,js}', destination: '/path/to' },
17  { source: '/path/{file1,file2}.js', destination: '/path/to' },
18];

Options

• source[string] - a file or a directory or a glob
• destination[string] - a file or a directory.
• options [object] - copy options
• globOptions [object] - options to forward to glob options(See available options here)

Caveats

• if source is a glob, destination must be a directory
• if source is a file and destination is a directory, the file will be copied into the directory

Delete

Delete individual files or entire directories. Also supports glob pattern

1['/path/to/file.txt', '/path/to/directory/', '/another-path/to/directory/**.js'];

or

1[
2  {
3    source: '/path/to/file.txt',
4    options: {
5      force: true,
6    },
7  },
8];

Move

Move individual files or entire directories.

1[
2  { source: '/path/from', destination: '/path/to' },
3  { source: '/path/fromfile.txt', destination: '/path/tofile.txt' },
4];

Options

• source[string] - a file or a directory or a glob
• destination[string] - a file or a directory.

Mkdir

Create a directory path with given path

1['/path/to/directory/', '/another/directory/'];

Archive

Archive individual files or entire directories. Defaults to .zip unless 'format' and 'options' provided. Uses node-archiver

1[
2  { source: '/path/from', destination: '/path/to.zip' },
3  { source: '/path/**/*.js', destination: '/path/to.zip' },
4  { source: '/path/fromfile.txt', destination: '/path/to.zip' },
5  { source: '/path/fromfile.txt', destination: '/path/to.zip', format: 'tar' },
6  {
7    source: '/path/fromfile.txt',
8    destination: '/path/to.tar.gz',
9    format: 'tar', // optional
10    options: {
11      // see https://www.archiverjs.com/docs/archiver
12      gzip: true,
13      gzipOptions: {
14        level: 1,
15      },
16      globOptions: {
17        // https://github.com/Yqnn/node-readdir-glob#options
18        dot: true,
19      },
20    },
21  },
22];

• source[string] - a file or a directory or a glob
• destination[string] - a file.
• format[string] - Optional. Defaults to extension in destination filename.
• options[object] - Refer https://www.archiverjs.com/archiver

Order of execution

If you need to preserve the order in which operations will run you can set the onStart and onEnd events to be Arrays. In this example below, in the onEnd event the copy action will run first, and then the delete after:

1{
2  onEnd: [
3    {
4      copy: [{ source: './dist/bundle.js', destination: './newfile.js' }],
5    },
6    {
7      delete: ['./dist/bundle.js'],
8    },
9  ];
10}

Other Options

• runTasksInSeries [boolean] - Run tasks in series. Defaults to false
• runOnceInWatchMode [boolean] - The onStart event will be run only once in watch mode. Defaults to false

For Example, the following will run one after the other

1copy: [
2  { source: 'dist/index.html', destination: 'dir1/' },
3  { source: 'dir1/index.html', destination: 'dir2/' },
4];

• context [string] - The directory, an absolute path, for resolving files. Defaults to webpack context.