# booshjs

**Repository Path**: mirrors_iansinnott/booshjs

## Basic Information

- **Project Name**: booshjs
- **Description**: A simpler way to configure Webpack for use with Babel, React and Stylus
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-08
- **Last Updated**: 2026-05-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# boosh.js 

[![Circle CI](https://img.shields.io/circleci/project/iansinnott/booshjs.svg)](https://circleci.com/gh/iansinnott/booshjs)
[![Boosh.js on NPM](https://img.shields.io/npm/v/booshjs.svg)](https://www.npmjs.com/package/booshjs)


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][].

[React + Webpack boilerplate]: https://github.com/iansinnott/react-boilerplate
[hjs-webpack]: https://github.com/HenrikJoreteg/hjs-webpack/

## Install

```
$ npm install --save booshjs
```


## Usage

```js
// 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](http://iansinnott.com)