Noodles Practicing Medicine
    Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    booshjspublic

    boosh.js

    Circle CI Boosh.js on NPM

    A Webpack configuration generator and project boilerplate for building modern web applications

    This project is an evolution of my old React + Webpack boilerplate. I was further inspired to make this into its own module by hjs-webpack.

    Install

    $ npm install --save booshjs
    

    Usage

    // webpack.config.js
    var path = require('path');
    var boosh = require('booshjs');
    module.exports = boosh({
      in: 'src/app.js',
      out: path.resolve(__dirname, 'public'),
      isDev: true
    });

    API

    boosh([options])

    options

    in

    Type: string, array, object Default: null

    The path to the main entry point of your application or a configuration object specifying multiple entry points. For small apps passing a single string is usually enough, but as your app grows you may need multiple entry points. The in option is passed directly to Webpack's entry configuration.

    // String example
    {
      in: 'src/app.js',
    }
    
    // Object example with multiple entrypoints
    {
      in: {
        app: 'src/app.js',
        login: 'src/login.js',
      },
    }
    

    out

    Type: string Default: null

    cleanOnBuild

    Type: boolean Default: true

    If true, Boosh.js will clear the directory specified by the out option every time you build. This is recommended, as it encourages keeping source files and generated files separate.

    Defaults

    module.exports = boosh({
      in: null,
      out: null,
      cleanOnBuild: true,
    });
    

    Any standard Webpack arguments you supply will take precedence over the Boosh.js defaults.

    CLI Project Generator

    TODO...

    License

    MIT © Ian Sinnott

    install

    npm i booshjs

    Downloadsweekly downloads

    13

    version

    0.6.0

    license

    MIT

    repository

    githubgithub

    last publish

    collaborators

    • avatar