TopGit tracks petehunt/webpack-howto on GitHub. The project has 10.0k stars.
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
This is a cookbook of how to get things done with webpack. This includes most things we use at Instagram and nothing we don't use.
My advice: start with this as your webpack docs, then look at the official docs for clarification.
Prerequisites
You know browserify, RequireJS or something similar
You see the value in:
Bundle splitting
Async loading
Packaging static assets like images and CSS
1. Why webpack?
It's like browserify but can split your app into multiple files. If you have multiple pages in a single-page app, the user only downloads code for just that page. If they go to another page, they don't redownload common code.
It often replaces grunt or gulp because it can build and bundle CSS, preprocessed CSS, compile-to-JS languages and images, among other things.
It supports AMD and CommonJS, among other module systems (Angular, ES6). If you don't know what to use, use CommonJS.
2. Webpack for Browserify people
These are equivalent:
browserify main.js > bundle.js
webpack main.js bundle.js
However, webpack is more powerful than Browserify, so you generally want to make a webpack.config.js to keep things organized:
This is just JS, so feel free to put Real Code in there.
3. How to invoke webpack
Switch to the directory containing webpack.config.js and run:
webpack for building once for development
webpack -p for building once for production (minification)
webpack --watch for continuous incremental build in development (fast!)
webpack -d to include source maps
4. Compile-to-JS languages
webpack's equivalent of browserify transforms and RequireJS plugins is a loader. Here's how you can teach webpack to load CoffeeScript and Facebook JSX+ES6 support (you must npm install babel-loader coffee-loader):
See also the babel-loader installation instructions for additional dependencies (tl;dr run npm install babel-core babel-preset-es2015 babel-preset-react).
First update your code to require() your static assets (named as they would with node's require()):
require('./bootstrap.css');
require('./myapp.less');
var img = document.createElement('img');
img.src = require('./glyph.png');
When you require CSS (or less, etc), webpack inlines the CSS as a string inside the JS bundle and require() will insert a <style> tag into the page. When you require images, webpack inlines a URL to the image into the bundle and returns it from require().
But you need to teach webpack to do this (again, with loaders):
// webpack.config.js
module.exports = {
entry: './main.js',
output: {
path: './build', // This is where images AND js will go
publicPath: 'http://mycdn.com/', // This is used to generate URLs to e.g. images
filename: 'bundle.js'
},
module: {
loaders: [
{ test: /\.less$/, loader: 'style-loader!css-loader!less-loader' }, // use ! to chain loaders
{ test: /\.css$/, loader: 'style-loader!css-loader' },
{ test: /\.(png|jpg)$/, loader: 'url-loader?limit=8192' } // inline base64 URLs for <=8k images, direct URLs for the rest
]
}
};
6. Feature flags
We have code we want to gate only to our dev environments (like logging) and our internal dogfooding servers (like unreleased features we're testing with employees). In your code, refer to magic globals:
if (__DEV__) {
console.warn('Extra logging');
}
// ...
if (__PRERELEASE__) {
showSecretFeature();
}
Then teach webpack those magic globals:
// webpack.config.js
// definePlugin takes raw strings and inserts them, so you can put strings of JS if you want.
var definePlugin = new webpack.DefinePlugin({
__DEV__: JSON.stringify(JSON.parse(process.env.BUILD_DEV || 'true')),
__PRERELEASE__: JSON.stringify(JSON.parse(process.env.BUILD_PRERELEASE || 'false'))
});
module.exports = {
entry: './main.js',
output: {
filename: 'bundle.js'
},
plugins: [definePlugin]
};
Then you can build with BUILD_DEV=1 BUILD_PRERELEASE=1 webpack from the console. Note that since webpack -p runs uglify dead-code elimination, anything wrapped in one of these blocks will be stripped out, so you won't leak secret features or strings.
7. Multiple entrypoints
Let's say you have a profile page and a feed page. You don't want to make the user download the code for the feed if they just want the profile. So make multiple bundles: create one "main module" (called an entrypoint) per page:
// webpack.config.js
module.exports = {
entry: {
Profile: './profile.js',
Feed: './feed.js'
},
output: {
path: 'build',
filename: '[name].js' // Template based on keys in entry above
}
};
For profile, insert <script src="build/Profile.js"></script> into your page. Do a similar thing for feed.
8. Optimizing common code
Feed and Profile share a lot in common (like React and the common stylesheets and components). webpack can figure out what they have in common and make a shared bundle that can be cached between pages:
// webpack.config.js
var webpack = require('webpack');
var commonsPlugin =
new webpack.optimize.CommonsChunkPlugin('common.js');
module.exports = {
entry: {
Profile: './profile.js',
Feed: './feed.js'
},
output: {
path: 'build',
filename: '[name].js' // Template based on keys in entry above
},
plugins: [commonsPlugin]
};
Add <script src="build/common.js"></script> before the script tag you added in the previous step and enjoy the free caching.
9. Async loading
CommonJS is synchronous but webpack provides a way to asynchronously specify dependencies. This is useful for client-side routers, where you want the router on every page, but you don't want to have to download features until you actually need them.
Specify the split point where you want to load asynchronously. For example:
if (window.location.pathname === '/feed') {
showLoadingState();
require.ensure([], function() { // this syntax is weird but it works
hideLoadingState();
require('./feed').show(); // when this function is called, the module is guaranteed to be synchronously available.
});
} else if (window.location.pathname === '/profile') {
showLoadingState();
require.ensure([], function() {
hideLoadingState();
require('./profile').show();
});
}
webpack will do the rest and generate extra chunk files and load them for you.
webpack will assume that those files are in your root directory when you load then into a html script tag for example. You can use output.publicPath to configure that.
// webpack.config.js
output: {
path: "/home/proj/public/assets", //path to where webpack will build your stuff
publicPath: "/assets/" //path that will be considered when requiring your files
}
Additional resources
Take a look at a real world example on how a successful team is leveraging webpack: http://youtu.be/VkTCL6Nqm6Y
This is Pete Hunt at OSCon talking about webpack at Instagram.com
FAQ
webpack doesn't seem modular
webpack is extremely modular. What makes webpack great is that it lets plugins inject themselves into more places in the build process when compared to alternatives like browserify and requirejs. Many things that may seem built into the core are just plugins that are loaded by default and can be overridden (i.e. the CommonJS require() parser).
How active is development on petehunt/webpack-howto?
The most recent commit recorded on petehunt/webpack-howto was 9.3 years ago, based on the GitHub push timestamp. The repository has 672 forks — one of the better signals of community interest.
How many stars does petehunt/webpack-howto have?
petehunt/webpack-howto has 10.0k GitHub stars — refresh the page for the live number, or check github.com/petehunt/webpack-howto. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
Is petehunt/webpack-howto open source?
TopGit's metadata for petehunt/webpack-howto does not record a license. Most public repositories on GitHub ARE open source, but the exact terms vary — verify by opening the LICENSE file directly.
What is petehunt/webpack-howto?
petehunt/webpack-howto (petehunt/webpack-howto) is a JavaScript project tracked by TopGit. The repository has 10.0k GitHub stars at the time of our last sync.
What language is petehunt/webpack-howto written in?
petehunt/webpack-howto is written primarily in JavaScript. GitHub's language field is based on the largest share of bytes in the default branch.
Where do I read more about petehunt/webpack-howto?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/petehunt/webpack-howto is the definitive source.
Read full README in the tab above.
Curious whether webpack-howto is right for you?
Let ChatGPT, Claude, or Perplexity look into it — click below and see what AI actually says about webpack-howto.