@dosomething/webpack-config

Shared Webpack config for DoSomething.org projects.

Stats

StarsIssuesVersionUpdatedCreatedSize
@dosomething/webpack-config
6.0.02 years ago6 years agoMinified + gzip package size for @dosomething/webpack-config in KB

Readme

webpack-config

This is our shared Webpack config used for front-end projects at DoSomething.org. It compiles JavaScript with Babel, SCSS with LibSass, and CSS with Autoprefixer. It is also configured to add hashes to filenames for easy caching, and inlines images and fonts as Data URIs if small enough.

Getting Started

Install this package and Webpack via NPM:

npm install webpack @dosomething/webpack-config --save-dev

Add some scripts to your package.json:

{
  // ...
  "scripts": {
    "start": "webpack --env=development --hide-modules --watch",
    "build:dev": "webpack --env=development --hide-modules",
    "build": "webpack --env=production",
  }
}

Create a webpack.config.js in your project directory, and set it up like so:

// webpack.config.js

var webpack = require('webpack');
var configure = require('@dosomething/webpack-config');

module.exports = configure({
  entry: {
    // Add your bundles here, so in this case
    // ./src/app.js ==> ./dist/app-[hash].js
    app: './src/app.js',
  },

  // Override any other Webpack settings here!
  // see: https://webpack.js.org/configuration/
});

This package uses PostCSS to post-process your stylesheets, so you will need to create a postcss.config.js in your project directory:

// postcss.config.js

module.exports = {
  sourceMap: true,
  plugins: [require('tailwindcss'), require('autoprefixer')],
};

For example, the above configuration post-processes your CSS with TailwindCSS and Autoprefixer.

Now you can run npm start to build with source maps and watch for changes, and npm run build to build optimized assets for production! If you need to further customize your build, you can pass any overrides in to the configure function.

License

© DoSomething.org. Our Webpack config is free software, and may be redistributed under the terms specified in the LICENSE file. The name and logo for DoSomething.org are trademarks of Do Something, Inc and may not be used without permission.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.