webpack-blocks - webpack base configuration

This is the webpack block providing webpack core functionality. Also provides all @webpack-blocks/core exports for convenience.

Usage

const HtmlWebpackPlugin = require('html-webpack-plugin')
const {
  addPlugins,
  createConfig,
  entryPoint,
  env,
  setMode,
  setOutput,
  sourceMaps
} = require('@webpack-blocks/webpack')
const { css } = require('@webpack-blocks/assets')

module.exports = createConfig([
  setMode(process.env.NODE_ENV || 'development'),
  entryPoint('./src/main.js'),
  setOutput('./build/bundle.js'),
  css(),
  addPlugins([
    new HtmlWebpackPlugin({
      inject: true,
      template: './index.html'
    })
  ]),
  env('development', [
    // will only enable source maps if `NODE_ENV === 'development'`
    sourceMaps()
  ])
])

Exports

createConfig(configSetter: Function[]): object

Takes an array of config setters (the functions returned by invoked webpack blocks), invokes them and returns the resulting webpack config object.

Helpers

group(configSetters: Function[]): Function

Combines an array of blocks to a new joined block. Running this single block has the same effect as running all source blocks.

env(envName: string, configSetters: Function[]): Function

Applies an array of webpack blocks only if process.env.NODE_ENV matches the given envName. If no NODE_ENV is set, it will be treated as 'development'.

Use like this:

module.exports = createConfig([
  css(),
  env('production', [extractText()])
])

match(test: string|RegExp|Array, options: ?object, configSetters: Function[]): Function

State on which files to apply the loader blocks passed in this call. Works like group(), but adds the file matching information to the context that can be used by the child blocks. The options parameter is optional.

Use like this:

module.exports = createConfig([
  match(['*.scss', '!*node_modules*'], [
    sass(),
    extractText('css/[name].css')
  ])
])

To match multiple file patterns you can pass a pattern array:

module.exports = createConfig([
  match(['*.sass', '*.scss'], [
    /* blocks */
  ])
])

when(condition: boolean, configSetters: Function[]): Function

Applies an array of webpack blocks only if condition is true (or truthy).

Use like this:

module.exports = createConfig([
  when(process.env.CI, [reportBuildStatsPlugin()])
])

Shorthand setters

addPlugins(plugins: WebpackPlugin[])

Add custom plugins to the webpack configuration.

Example usage:

addPlugins([new HtmlWebpackPlugin()])

customConfig(webpackConfigSnippet: object)

Add some custom configuration to the webpack configuration. The object you pass will be merged into the webpack configuration object.

defineConstants(constants: object): Function

Replaces constants in your source code with a value (process.env.NODE_ENV for example) using the webpack.DefinePlugin. Pass an object containing your constant definitions: { [constantName: string]: <constantValue: any> }.

Every constant's value is JSON.stringify()-ed first, so you don't have to remember.

Using defineConstants multiple times results in a single DefinePlugin instance configured to do all the replacements.

setEnv(constants: string[]|object): Function

Replaces constants in your source code with a values from process.env using the webpack.EnvironmentPlugin.

Using setEnv multiple times results in a single EnvironmentPlugin instance configured to do all the replacements.

module.exports = createConfig([
  setEnv(['NODE_ENV']),
  setEnv({
    BABEL_ENV: 'development', // use 'development' unless process.env.BABEL_ENV is defined
    PORT: 3000
  })
])

entryPoint(entryPoint: string|string[]|object)

Adds one or multiple entry points. If the parameter is not an object the entry point(s) will be added to the default chunk named main. This way we make sure that the resulting https://webpack.github.io/docs/configuration.html#entry configuration property will always be an object.

optimization(optimizationOptions: object)

Set the optimization settings.

performance(perfBudgetOptions: object)

Set a performance budget. Performance budgets are custom limits (like max bundle size) you can set to make webpack warn you or throw an error if the application exceeds those limits.

Options object:

{
  maxAssetSize: number,         // File size limit in bytes
  maxEntrypointSize: number,    // Total size (of an entry point) limit in bytes
  hints: string                 // "warning" or "error"
}

resolve(config: object)

Sets resolve. Use it to manually override module resolution.

Example:

resolve({
  // resolve `import 'Utilities'` to correct path
  alias: { Utilities: path.resolve(__dirname, 'src/utilities/') },
  extensions: ['.js', '.json'],
  modules: [path.resolve(__dirname, 'src'), 'node_modules']
})

setContext(path: string)

Sets the webpack context. Not to be confused with the webpack-block's context object.

setDevTool(devtool: string)

Use it to manually set the webpack devtool property, like 'eval', 'source-map' and such.

setMode(mode: string)

Sets the webpack mode.

setOutput(output: string|object)

Sets the webpack output property. Use it to tell webpack where to save the output bundle(s).

You can either pass an object that complies to the format described in the webpack docs or just pass the destination file path.

Instead of passing the destination file path you can also

• Just pass a filename (not the complete path): The directory will default to ./build/.
• Just pass the path to a directory (trailing /): The filename will default to bundle.js.

sourceMaps(devtool: ?string)

Just a convenience wrapper to enable sourcemaps in an easier-to-read fashion than setDevTool(). Will set webpack's devtool to 'cheap-module-eval-source-map' if no explicit devtool is passed as parameter.

webpack-blocks

Check out the

👉 Main documentation

Released under the terms of the MIT license.