10.4.6 • Published 6 years ago

hops-build-config v10.4.6

Weekly downloads
1
License
MIT
Repository
github
Last release
6 years ago

Hops Build Config

npm

hops-build-config exposes webpack configurations for Node.js, browser and webpack-dev-server.

Installation

When you install hops-build, hops-build-config will be installed as a dependency as well - so you don't necessarily have to separately install hops-build-config.

However iff you want to use it in your app directly (for example to extend it), install it by running

npm install --save hops-build-config

Usage

Please find a list of the default configs below. You can override them to control your build using hops-config.

Available options

FieldTypeDescription
buildConfigStringPath to your Webpack build configuration file. Defaults to ./node_modules/hops-build-config/configs/build.js
developConfigStringPath to your Webpack development configuration file. Defaults to ./node_modules/hops-build-config/configs/develop.js
nodeConfigStringPath to your Webpack node/server-side rendering configuration file. Defaults to ./node_modules/hops-build-config/configs/node.js

Custom Webpack configuration

Webpack configurations can be nasty to handle, therefore we recommend using webpack-merge if you want to extend one of the existing Webpack configurations.

The following example shows how to overwrite / extend the webpack configurations:

package.json

"name": "my-application",
"version": "1.0.0",
"hops": {
  "buildConfig": "./path-to-my-custom-webpack-config/build.js",
  "developConfig": "./path-to-my-custom-webpack-config/develop.js",
  "nodeConfig": "./path-to-my-custom-webpack-config/node.js"
}

./path-to-my-custom-webpack-config/build.js

var webpack = require('webpack');
var hopsBuildConfig = require('hops-build-config/configs/build');
var merge = require('webpack-merge');

var myCustomBuildConfig = {
  plugins: [
    new webpack.EnvironmentPlugin({
      MY_CUSTOM_ENV: 'myFallbackValue',
    }),
  ],
};

module.exports = merge.strategy(
  { plugins: 'append' },
  hopsBuildConfig,
  myCustomBuildConfig
);

Please head over to the documentation of webpack-merge to see the full list of merge strategies to help you decide which one to use.

Default configuration

hops-build-config provides a minimal, yet convenient default configuration. Furthermore, when starting a development server, source maps will be generated.

Babel

PostCSS

PostCSS in Hops is configured to use cssnext and CSS modules by default.

Files/Assets

File typeLoader action
graphql gqlFiles of these types are interpreted as GraphQL. You need to manually install Hops' GraphQL for this to work
html svg otf ttf woff woff2 icoFiles of these types are emitted to the directory defined in assetPath
png gif jpeg jpg webpSame as above, except when a file of this type is smaller than 10kb in size. In that case, it will be converted to a base64-encoded data URL and embedded inline
jsonFiles of this type are loaded and their content is returned
tplFiles of this type are parsed by _.template and their content is returned as a function. By providing such a file, you can for example override the default template provided by hops-react