Skip to content
A webpack config maker for phrontend apps
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
test
utils
.editorconfig
.eslintignore
.eslintrc
.gitignore
.npmignore
.travis.yml
CODE_OF_CONDUCT.md
CONTRIBUTING.md
README.md
package.json

README.md

phrontend-webpack

Build Status Code Climate Test Coverage npm version

A webpack config maker

Install

npm install phrontend-webpack --save

in your phrontend application.

Options

src : String<Path>
  • The source directory for app. Usually it is __dirname/app or __dirname.
  • Must be an absolute path
dest : String<Path>
  • The destination/output directory
  • If relative, it is considered to be relative to src
library : String<Name>
  • Your exports from your entry will be available under this global
  • window.<library> = <exports>
publicPath : String
  • default: public/
  • make sure this matches dest
  • usually used to specify CDN base URL for prod
minimize : Boolean
  • cache busting + minification
  • true - minified JS, JS filenames contain hashes, css classnames are just hashes
  • false - long classnames for css - path, filename, classname, hash, JS filenames don't contain hashes
hot : Boolean
  • Enables react-hot-loader for modules
  • This is disabled for css when separateStyleSheet is enabled
separateStylesheet : Boolean
  • If true, it outputs a separate css file using extract-text-webpack-plugin
  • Uses inline stylesheets otherwise
transpile : String<PackageName> | Array<PackageName>
  • Transpile these packages present in node_modules directory
cssLocalImports : Boolean
  • By default(true) css can be imported into JS only from the current directory
  • If false, you can do import styles from '../../styles.css';
moduleDirectories : String<Path> | Array<Path>
  • Absolute paths are inserted as it is to resolve.root of webpack
  • If relative, it'll be considered relative to src
dedupe : Boolean
  • Use webpack dedupe plugin
debug : Boolean
  • Switch loaders to debug mode.
devtool : String
  • default: cheap-module-inline-source-map
browsers
  • options passed to autoprefixer's .browsers

Example

var path = require('path');
var makeConfig = require('phrontend-webpack');
var __PROD__ = process.env.NODE_ENV==='production';
var __DEV__  = !__PROD__;

module.exports = makeConfig({
  src: __dirname, // required
  dest: './dist',
  library: 'todoapp',
  publicPath: __DEV__ ? 'dist/' : 'https://cdn.server/path/to/bundleDir',
  minimize: __PROD__,
  hot: __DEV__,
  separateStylesheet: __PROD__,
  transpile: 'my-other-module',
  cssLocalImports: true,
  moduleDirectories: path.join(__dirname, 'components'),
  dedupe: __PROD__,
  debug: __DEV__,
  devtool: __PROD__ ? 'source-map' : 'cheap-module-inline-source-map',
  browsers: ['Chrome > 36']
});

LICENSE

Copyright 2015 Flipkart Internet Pvt. Ltd.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

You can’t perform that action at this time.