Add Encore.copyFiles() method to the public API

Author: Lyrkan

fixtures/images/symfony_logo_alt.png

@@ -404,6 +404,64 @@ class Encore {
         return this;
     }
 
+    /**
+     * Copy files or folders to the build directory.
+     *
+     * For example:
+     *
+     *      // Copy the content of a whole directory and its subdirectories
+     *      Encore.copyFiles({ from: './images' });
+     *
+     *      // Only copy files matching a given pattern
+     *      Encore.copyFiles({ from: './images', pattern: /\.(png|jpg|jpeg)$/ })
+     *
+     *      // Set the path the files are copied to
+     *      Encore.copyFiles({
+     *          from: './images',
+     *          pattern: /\.(png|jpg|jpeg)$/,
+     *          to: 'assets/images/[path][name].[ext]'
+     *      })
+     *
+     *      // Version files
+     *      Encore.copyFiles(
+     *          from: './images',
+     *          to: 'assets/images/[path][name].[hash:8].[ext]'
+     *      })
+     *
+     *      // Add multiple configs in a single call
+     *      Encore.copyFiles([
+     *          { from: './images' },
+     *          { from: './txt', pattern: /\.txt$/ },
+     *      ]);
+     *
+     * Notes:
+     *      * No transformation is applied to the copied files (for instance
+     *        copying a CSS file won't minify it)
+     *      * By default files won't be versioned even if enableVersioning()
+     *        has been called. In order to add a hash to your filenames you
+     *        must use the "[hash]" placeholder in the "to" option (see below)
+     *
+     * Supported options:
+     *      * {string} from (mandatory)
+     *              The path of the source directory (mandatory)
+     *      * {RegExp} pattern (default: all files)
+     *              A pattern that the filenames must match in order to be copied
+     *      * {string} to (default: [path][name].[ext])
+     *              Where the files must be copied to. You can add all the
+     *              placeholders supported by the file-loader.
+     *              https://github.com/webpack-contrib/file-loader#placeholders
+     *      * {boolean} includeSubdirectories (default: true)
+     *              Whether or not the copy should include subdirectories.
+     *
+     * @param {object|Array} configs
+     * @returns {Encore}
+     */
+    copyFiles(configs) {
+        webpackConfig.copyFiles(configs);
+
+        return this;
+    }
+
     /**
      * Tell Webpack to output a separate runtime.js file.
      *

index.js

@@ -69,6 +69,7 @@ class WebpackConfig {
         this.useHandlebarsLoader = false;
 
         // Features/Loaders options
+        this.copyFilesConfigs = [];
         this.sassOptions = {
             resolveUrlLoader: true
         };
@@ -365,6 +366,39 @@ class WebpackConfig {
         this.addEntry(name, file);
     }
 
+    copyFiles(configs = []) {
+        if (!Array.isArray(configs)) {
+            configs = [configs];
+        }
+
+        if (configs.some(elt => typeof elt !== 'object')) {
+            throw new Error('copyFiles() must be called with either a config object or an array of config objects.');
+        }
+
+        const defaultConfig = {
+            from: null,
+            pattern: /.*/,
+            to: '[path][name].[ext]',
+            includeSubdirectories: true
+        };
+
+        for (const config of configs) {
+            if (!config.from) {
+                throw new Error('Config objects passed to copyFiles() must have a "from" property.');
+            }
+
+            for (const configKey of Object.keys(config)) {
+                if (!(configKey in defaultConfig)) {
+                    throw new Error(`Invalid config option "${configKey}" passed to copyFiles(). Valid keys are ${Object.keys(defaultConfig).join(', ')}`);
+                }
+            }
+
+            this.copyFilesConfigs.push(
+                Object.assign({}, defaultConfig, config)
+            );
+        }
+    }
+
     enablePostCssLoader(postCssLoaderOptionsCallback = () => {}) {
         this.usePostCssLoader = true;
 

lib/WebpackConfig.js

@@ -41,6 +41,7 @@ const sharedEntryConcatPuginUtil = require('./plugins/shared-entry-concat');
 const PluginPriorities = require('./plugins/plugin-priorities');
 const applyOptionsCallback = require('./utils/apply-options-callback');
 const sharedEntryTmpName = require('./utils/sharedEntryTmpName');
+const copyEntryTmpName = require('./utils/copyEntryTmpName');
 const tmp = require('tmp');
 const fs = require('fs');
 const path = require('path');
@@ -140,6 +141,32 @@ class ConfigGenerator {
             entry[sharedEntryTmpName] = tmpFileObject.name;
         }
 
+        if (this.webpackConfig.copyFilesConfigs.length > 0) {
+            const tmpFileObject = tmp.fileSync();
+            fs.writeFileSync(
+                tmpFileObject.name,
+                this.webpackConfig.copyFilesConfigs.reduce((buffer, entry, index) => {
+                    const copyFrom = path.resolve(
+                        this.webpackConfig.getContext(),
+                        entry.from
+                    );
+
+                    const requireContextParam = `!${require.resolve('file-loader')}?context=${copyFrom}&name=${entry.to}!${copyFrom}`;
+
+                    return buffer + `
+                        const context_${index} = require.context(
+                            '${stringEscaper(requireContextParam)}',
+                            ${entry.includeSubdirectories},
+                            ${entry.pattern}
+                        );
+                        context_${index}.keys().forEach(context_${index});
+                    `;
+                }, '')
+            );
+
+            entry[copyEntryTmpName] = tmpFileObject.name;
+        }
+
         return entry;
     }
 

lib/config-generator.js

@@ -11,19 +11,22 @@
 
 const DeleteUnusedEntriesJSPlugin = require('../webpack/delete-unused-entries-js-plugin');
 const PluginPriorities = require('./plugin-priorities');
+const copyEntryTmpName = require('../utils/copyEntryTmpName');
 
 /**
  * @param {Array} plugins
  * @param {WebpackConfig} webpackConfig
  * @return {void}
  */
 module.exports = function(plugins, webpackConfig) {
+    const entries = [... webpackConfig.styleEntries.keys()];
+
+    if (webpackConfig.copyFilesConfigs.length > 0) {
+        entries.push(copyEntryTmpName);
+    }
 
     plugins.push({
-        plugin: new DeleteUnusedEntriesJSPlugin(
-            // transform into an Array
-            [... webpackConfig.styleEntries.keys()]
-        ),
+        plugin: new DeleteUnusedEntriesJSPlugin(entries),
         priority: PluginPriorities.DeleteUnusedEntriesJSPlugin
     });
 };

lib/plugins/delete-unused-entries.js

@@ -13,6 +13,7 @@ const EntryFilesManifestPlugin = require('../webpack/entry-files-manifest-plugin
 const PluginPriorities = require('./plugin-priorities');
 const path = require('path');
 const sharedEntryTmpName = require('../utils/sharedEntryTmpName');
+const copyEntryTmpName = require('../utils/copyEntryTmpName');
 const manifestKeyPrefixHelper = require('../utils/manifest-key-prefix-helper');
 
 /**
@@ -26,7 +27,7 @@ module.exports = function(plugins, webpackConfig) {
         plugin: new EntryFilesManifestPlugin(
             path.join(webpackConfig.outputPath, 'entrypoints.json'),
             manifestKeyPrefixHelper(webpackConfig),
-            [sharedEntryTmpName],
+            [sharedEntryTmpName, copyEntryTmpName],
             webpackConfig.styleEntries
         ),
         priority: PluginPriorities.EntryFilesManifestPlugin

lib/plugins/entry-files-manifest.js

@@ -13,6 +13,7 @@ const ManifestPlugin = require('webpack-manifest-plugin');
 const PluginPriorities = require('./plugin-priorities');
 const applyOptionsCallback = require('../utils/apply-options-callback');
 const sharedEntryTmpName = require('../utils/sharedEntryTmpName');
+const copyEntryTmpName = require('../utils/copyEntryTmpName');
 const manifestKeyPrefixHelper = require('../utils/manifest-key-prefix-helper');
 
 /**
@@ -26,7 +27,7 @@ module.exports = function(plugins, webpackConfig) {
         // always write a manifest.json file, even with webpack-dev-server
         writeToFileEmit: true,
         filter: (file) => {
-            return (!file.isChunk || file.chunk.id !== sharedEntryTmpName);
+            return (!file.isChunk || ![sharedEntryTmpName, copyEntryTmpName].includes(file.chunk.id));
         }
     };
 

lib/plugins/manifest.js

@@ -0,0 +1,12 @@
+/*
+ * This file is part of the Symfony Webpack Encore package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+'use strict';
+
+module.exports = '_tmp_copy';

lib/utils/copyEntryTmpName.js

@@ -359,6 +359,70 @@ describe('WebpackConfig object', () => {
         });
     });
 
+    describe('copyFiles', () => {
+        it('Calling it add files to be copied', () => {
+            const config = createConfig();
+
+            // With multiple config objects
+            config.copyFiles([
+                { from: './foo', pattern: /.*/ },
+                { from: './bar', pattern: /abc/, to: 'bar', includeSubdirectories: false },
+            ]);
+
+            // With a single config object
+            config.copyFiles({ from: './baz' });
+
+            expect(config.copyFilesConfigs).to.deep.equal([{
+                from: './foo',
+                pattern: /.*/,
+                to: '[path][name].[ext]',
+                includeSubdirectories: true
+            }, {
+                from: './bar',
+                pattern: /abc/,
+                to: 'bar',
+                includeSubdirectories: false
+            }, {
+                from: './baz',
+                pattern: /.*/,
+                to: '[path][name].[ext]',
+                includeSubdirectories: true
+            }]);
+        });
+
+        it('Calling it with an invalid parameter', () => {
+            const config = createConfig();
+
+            expect(() => {
+                config.copyFiles('foo');
+            }).to.throw('must be called with either a config object or an array of config objects');
+
+            expect(() => {
+                config.copyFiles([{ from: 'foo' }, 'foo']);
+            }).to.throw('must be called with either a config object or an array of config objects');
+        });
+
+        it('Calling it with a missing from key', () => {
+            const config = createConfig();
+
+            expect(() => {
+                config.copyFiles({ to: 'foo' });
+            }).to.throw('must have a "from" property');
+
+            expect(() => {
+                config.copyFiles([{ from: 'foo' }, { to: 'foo' }]);
+            }).to.throw('must have a "from" property');
+        });
+
+        it('Calling it with an unknown config property', () => {
+            const config = createConfig();
+
+            expect(() => {
+                config.copyFiles({ from: 'images', foo: 'foo' });
+            }).to.throw('Invalid config option "foo"');
+        });
+    });
+
     describe('autoProvideVariables', () => {
         it('Calling multiple times merges', () => {
             const config = createConfig();