Add various methods to configure default plugins #152
Conversation
Lyrkan
force-pushed
the
configure-plugins
branch
from
51bf683 to
7f1fcbd
Compare
Lyrkan
force-pushed
the
configure-plugins
branch
from
7f1fcbd to
90c8565
Compare
|
Just realized that maybe I should remove |
Hmm, yea, good catch. We should probably "get this right" now. I'm leaning towards using camelCase... so we would "fix" |
| return this; | ||
| }, | ||
|
|
||
| /** |
index.js
Outdated
| @@ -522,10 +618,20 @@ const publicApi = { | |||
| * If enabled, the output directory is emptied between | |||
| * each build (to remove old files). | |||
There was a problem hiding this comment.
It's not from your commit, but this could probably fit all on one line.
| * | ||
| * For example: | ||
| * | ||
| * Encore.cleanupOutputBeforeBuild(['*.js'], (options) => { |
There was a problem hiding this comment.
Maybe we should show the default ['**/*'] as the first option. The issue is that, if I only want to specify some options for the plugin... I need to know what this first value is by default, so I can repeat it. That kind of sucks... but I can't think of a good way around it (so showing the default here might make sense)
There was a problem hiding this comment.
I wanted to but '**/*' breaks the multi-line comment :(
There was a problem hiding this comment.
Ha! What a crazy edge case :p
lib/WebpackConfig.js
Outdated
| cleanupOutputBeforeBuild() { | ||
| cleanupOutputBeforeBuild(paths = ['**/*'], cleanWebpackPluginOptionsCallback = () => {}) { | ||
| if (!Array.isArray(paths)) { | ||
| throw new Error('Argument 1 to cleanupOutputBeforeBuild() must be an Array'); |
There was a problem hiding this comment.
What do you think about this:
... must be an Array of paths - e.g. ['**/*']
|
Thank you @Lyrkan! |
This PR was squashed before being merged into the master branch (closes #152). Discussion ---------- Add various methods to configure default plugins This PR adds some methods to configure default plugins (closes #148, closes #87 and closes #15): * `Encore.configureDefinePlugin(callback)` * `Encore.configureExtractTextPlugin(callback)` * `Encore.configureFriendlyErrorsPlugin(callback)` * `Encore.configureLoaderOptionsPlugin(callback)` * `Encore.configureUglifyJsPlugin(callback)` Other changes: * Allows the `clean-webpack-plugin` to be configured using `Encore.cleanupOutputBeforeBuild(paths, callback)` * Fixed a small mistake in the `Encore.configureManifestPlugin()` jsdoc * Reorganized flags/callbacks in the constructor of `webpack.config.js` since it was starting to be a bit hard to read. I'm not sure about the way I splitted things though, let me know what you think about it. * Renamed `common-chunks.js` to `commons-chunks.js` since the name of the plugin is `CommonsChunkPlugin` @weaverryan: Not directly related but while doing all of that I noticed that `sassOptions` uses snake-case whereas I used camel-case in #144 for `enablePreactPreset()` and in #115 for `configureRuntimeEnvironment()`, should we do something about that? ***Edit 1:** Added `Encore.configureCleanWebpackPlugin()`* ***Edit 2:** Removed `Encore.configureCleanWebpackPlugin()` to use `Encore.cleanupOutputBeforeBuild(paths, callback)` arguments instead* Commits ------- 286787a Minor text changes f72614b Remove configureCleanWebpackPlugin and use cleanupOutputBeforeBuild arguments instead 90c8565 Add various methods to configure default plugins
This PR was squashed before being merged into the master branch (closes #159). Discussion ---------- Replace "resolve_url_loader" by "resolveUrlLoader" This PR deprecates the `resolve_url_loader` option used by the `enableSassLoader` and replaces it by `resolveUrlLoader`. This is done to be consistent with other methods that use camel-case instead of snake-case (see [#152](#152 (comment))). `resolve_url_loader` will still work for now but will display the following deprecation message:  Commits ------- ff442a6 Add a logger.deprecation(message) method 9dac153 Replace sass option 'resolve_url_loader' by 'resolveUrlLoader'
This PR adds some methods to configure default plugins (closes #148, closes #87 and closes #15):
Encore.configureDefinePlugin(callback)Encore.configureExtractTextPlugin(callback)Encore.configureFriendlyErrorsPlugin(callback)Encore.configureLoaderOptionsPlugin(callback)Encore.configureUglifyJsPlugin(callback)Other changes:
clean-webpack-pluginto be configured usingEncore.cleanupOutputBeforeBuild(paths, callback)Encore.configureManifestPlugin()jsdocwebpack.config.jssince it was starting to be a bit hard to read. I'm not sure about the way I splitted things though, let me know what you think about it.common-chunks.jstocommons-chunks.jssince the name of the plugin isCommonsChunkPlugin@weaverryan: Not directly related but while doing all of that I noticed that
sassOptionsuses snake-case whereas I used camel-case in #144 forenablePreactPreset()and in #115 forconfigureRuntimeEnvironment(), should we do something about that?Edit 1: Added
Encore.configureCleanWebpackPlugin()Edit 2: Removed
Encore.configureCleanWebpackPlugin()to useEncore.cleanupOutputBeforeBuild(paths, callback)arguments instead