https://github.com/js-devtools/simplifyify
A simplified Browserify and Watchify CLI
https://github.com/js-devtools/simplifyify
browserify cli code-coverage cross-platform linux macos minify nodejs sourcemap watchify windows
Last synced: 7 months ago
JSON representation
A simplified Browserify and Watchify CLI
- Host: GitHub
- URL: https://github.com/js-devtools/simplifyify
- Owner: JS-DevTools
- License: mit
- Created: 2015-07-23T17:55:22.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2021-01-02T18:28:11.000Z (almost 5 years ago)
- Last Synced: 2025-05-11T12:48:50.532Z (8 months ago)
- Topics: browserify, cli, code-coverage, cross-platform, linux, macos, minify, nodejs, sourcemap, watchify, windows
- Language: JavaScript
- Homepage: https://jstools.dev/simplifyify/
- Size: 986 KB
- Stars: 37
- Watchers: 2
- Forks: 4
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Simplifyify
============================
#### A simplified Browserify and Watchify CLI
[](https://github.com/JS-DevTools/simplifyify/actions)
[](https://github.com/JS-DevTools/simplifyify/actions)
[](https://coveralls.io/github/JS-DevTools/simplifyify?branch=master)
[](https://david-dm.org/JS-DevTools/simplifyify)
[](https://www.npmjs.com/package/@jsdevtools/simplifyify)
[](LICENSE)
[](https://plant.treeware.earth/JS-DevTools/simplifyify)
I constantly find myself using the same Browserify plug-ins and transforms on every project, and I always end up writing pretty much the same Gulp script over and over again. Simplifyify is the solution to that problem.
Features
--------------------------
- Supports [globs](https://github.com/isaacs/node-glob#glob-primer), even on Windows
- Supports Browserify [transforms](#browserify-transforms) and [plugins](#browserify-plugins), such as Babel, CoffeeScript, TypeScript, etc.
- Built-in support for TypeScript. Enabled automatically if the entry file has a `.ts` or `.tsx` extension
- Has a programmatic [API](#api), for use with build tools like Grunt, Gulp, Broccoli, etc.
- Bundle everything into one big file, or create different bundles for each part of your app (see [examples below](#examples))
- Add a banner with version, date, license, etc. via [browserify-banner](https://www.npmjs.com/package/browserify-banner)
- One command creates all the files you need:
- `--bundle` bundles your code and nothing else. Useful during development
- `--debug` creates _external_ source-maps (`.map`) using [exorcist](https://www.npmjs.com/package/exorcist)
- `--minify` shrinks your code using [uglifyify](https://www.npmjs.com/package/uglifyify) _and_ [Uglify-ES](https://github.com/mishoo/UglifyJS2/tree/harmony)
- `--coverage` adds code-coverage instrumentation using [istanbul](https://istanbul.js.org/)
- `--watch` uses [watchify](https://www.npmjs.com/package/watchify) for _fast_ differential re-builds as files change
Related Projects
--------------------------
- [globify](https://jstools.dev/globify)
Run browserify and watchify with globs - even on Windows
- [sourcemapify](https://jstools.dev/sourcemapify)
Sourcemap plugin for Browserify
- [browserify-banner](https://jstools.dev/browserify-banner)
Add a comment (and/or code) to the top of your Browserify bundle
Installation
--------------------------
Install using [npm](https://docs.npmjs.com/about-npm/):
```bash
npm install @jsdevtools/simplifyify
```
Usage
--------------------------
```
Usage: simplifyify [options]
Options:
-b, --bundle Create a non-minified bundle (*.js) for each source file.
This is the default if no other output option is set.
-m, --minify Create a minified bundle (*.min.js) for each source file.
-c, --coverage Create a bundle with code-coverage instrumentation
(*.coverage.js) for each source file.
-d, --debug Create a source map (*.js.map) for each bundle
-w, --watch Watch source file(s) and rebuild the bundle(s) automatically
-o, --outfile The output file or directory.
May include a filename pattern (e.g. "*.bundle.js")
-x, --exclude File path or glob pattern to exclude.
Don't forget to put quotes around glob patterns
-s, --standalone Export as a named UMD bundle (e.g. "my.cool.module")
May include a wildcard (e.g. "MyLib.*")
Arguments:
One or more file paths and/or glob patterns.
Don't forget to put quotes around glob patterns.
A separate Browserify bundle will be created
for each source file.
```
Examples
--------------------------
#### One entry file --> one output file
In the simplest usage, you can use Simplifyify to bundle all of your code into a single file:
```bash
simplifyify src/index.js
src/index.js --> src/index.bundle.js # <-- unminified code
```
By default, the output file is at the same path as the entry file, but with a `.bundle.js` extension. You can customize this using the `--outfile` argument:
```bash
simplifyify src/index.js --outfile dist/my-package.js
src/index.js --> dist/my-package.js # <-- unminified code
```
If you want the bundled code to be minified, then add the `--minify` flag:
```bash
simplifyify src/index.js --outfile dist/my-package.js --minify
src/index.js --> dist/my-package.js # <-- minified code
```
What if you also want a source map (`.map`) file? Just add the `--debug` flag.
```bash
simplifyify src/index.js --outfile dist/my-package.js --minify --debug
src/index.js --> dist/my-package.js # <-- minified code
src/index.js --> dist/my-package.js.map # <-- source map
```
#### One entry file --> multiple output files
Simplifyify can output multiple bundles of your code in a single command. Let's say you want to create an unminified bundle for development (with a source map), a minified bundle for production (with a source map), and a test bundle (with code-coverage instrumentation) for testing:
```bash
simplifyify src/index.js --outfile dist/my-package.js --bundle --debug --minify --coverage
src/index.js --> dist/my-package.js # <-- unminified code
src/index.js --> dist/my-package.js.map # <-- source map
src/index.js --> dist/my-package.min.js # <-- minified code
src/index.js --> dist/my-package.min.js.map # <-- source map
src/index.js --> dist/my-package.coverage.js # <-- code-coverage
```
#### Multiple entry files --> multiple output files _for each_
In many applications, it doesn't make sense for _all_ of your code to be bundled into one huge file. Maybe you want to create separate bundles for each folder, or for each component or section of your app. Simplifyify makes this easy. It will create separate bundles for each entry file that you specify. For example:
```bash
simplifyify src/store.js src/cart.js src/checkout.js --outfile dist --bundle --minify --debug
src/store.js --> dist/store.js # <-- unminified code
src/store.js --> dist/store.js.map # <-- source map
src/store.js --> dist/store.min.js # <-- minified code
src/store.js --> dist/store.min.js.map # <-- source map
src/cart.js --> dist/cart.js # <-- unminified code
src/cart.js --> dist/cart.js.map # <-- source map
src/cart.js --> dist/cart.min.js # <-- minified code
src/cart.js --> dist/cart.min.js.map # <-- source map
src/checkout.js --> dist/checkout.js # <-- unminified code
src/checkout.js --> dist/checkout.js.map # <-- source map
src/checkout.js --> dist/checkout.min.js # <-- minified code
src/checkout.js --> dist/checkout.min.js.map # <-- source map
```
Specifying each entry file can quickly become cumbersome though. That's where [globs](https://github.com/isaacs/node-glob#glob-primer) come in. You can specify one or more globs, and Simplifyify will create a separate bundle for each file that matches the glob pattern. For example:
```bash
simplifyify "src/*/index.js" --outfile "dist/*.bundle.js" --bundle --minify --debug
src/store/index.js --> dist/store/index.bundle.js # <-- unminified code
src/store/index.js --> dist/store/index.bundle.js.map # <-- source map
src/store/index.js --> dist/store/index.bundle.min.js # <-- minified code
src/store/index.js --> dist/store/index.bundle.min.js.map # <-- source map
src/cart/index.js --> dist/cart/index.bundle.js # <-- unminified code
src/cart/index.js --> dist/cart/index.bundle.js.map # <-- source map
src/cart/index.js --> dist/cart/index.bundle.min.js # <-- minified code
src/cart/index.js --> dist/cart/index.bundle.min.js.map # <-- source map
src/checkout/index.js --> dist/checkout/index.bundle.js # <-- unminified code
src/checkout/index.js --> dist/checkout/index.bundle.js.map # <-- source map
src/checkout/index.js --> dist/checkout/index.bundle.min.js # <-- minified code
src/checkout/index.js --> dist/checkout/index.bundle.min.js.map # <-- source map
```
> **TIP:** Don't forget to put quotes around your glob patterns! Otherwise, some shells (e.g. Bash) will try to expand them themselves, which may or may not work
Browserify Transforms
--------------------------
Simplifyify honors the [`browserify.transform`](https://github.com/substack/node-browserify#browserifytransform) field in your `package.json` file. For example, the following configuration uses [Babelify](https://github.com/babel/babelify) to transform your ES6 code to ES5:
```json
{
"name": "my-package",
"version": "1.2.3",
"browserify": {
"transform": ["babelify"]
},
"devDependencies": {
"babelify": "^10.0.0"
}
}
```
You can also specify options for your transforms. The exact options depend on the transform you're using. Here's an example that configures [Babelify](https://github.com/babel/babelify) and also modifies Simplifyify's default config for [uglifyify](https://www.npmjs.com/package/uglifyify):
```json
{
"name": "my-package",
"version": "1.2.3",
"browserify": {
"transform": [
["babelify", {
"presets": ["@babel/preset-env"]
}],
["uglifyify", {
"mangle": true,
"compress": {
"sequences": true,
"dead_code": true,
"booleans": true,
"conditionals": true,
"if_return": false,
"drop_console": false,
"keep_fnames": true
},
"output": {
"comments": false
}
}]
]
},
"devDependencies": {
"@babel/preset-env": "^7.0.0",
"babelify": "^10.0.0"
}
}
```
Browserify Plugins
--------------------------
The same technique described above for Browserify transforms also works for Browserify plugins. Just add a `browserify.plugins` field to your `package.json` file. For example, the following configuration configures [TSify](https://github.com/TypeStrong/tsify/) to transpile your TypeScript code, and [browserify-banner](https://github.com/JS-DevTools/browserify-banner) to add a banner comment to the top of your output file(s).
```json
{
"name": "my-package",
"version": "1.2.3",
"browserify": {
"plugins": [
["browserify-banner", {
"template": "<%= pkg.name %> v<%= pkg.version %>"
}],
["tsify", {
"target": "esnext",
"module": "commonjs",
"moduleResolution": "node",
"jsx": "react"
}]
]
},
"devDependencies": {
"typescript": "^3.0.3"
}
}
```
API
--------------------------
Simplifyify also has a programmatic API, so you can use it directly in your build scripts (Gulp, Grunt, Broccoli, etc.)
[Here's the API definition](https://github.com/JS-DevTools/simplifyify/blob/6709bb5bbf59b327b4ced3e833078de8db006b5a/lib/index.js#L9-L28), and [here's a full example](https://github.com/JS-DevTools/simplifyify/blob/6709bb5bbf59b327b4ced3e833078de8db006b5a/bin/simplifyify.js#L71-L102). Just pass an array of strings (file paths and/or glob patterns) and an options param. You get back an [`EventEmitter`](https://nodejs.org/api/events.html#events_class_events_eventemitter), which fires all the Browserify & Watchify events.
```javascript
var simplifyify = require("@jsdevtools/simplifyify");
gulp.task("browserify", function(done) {
simplifyify("lib/*.module.js",
{
outfile: "dist/*.bundle.js",
debug: true,
minify: true
})
.on("end", function() {
// Finished successfully!
done();
})
.on("error", function(err) {
// Something went wrong
done(err);
});
});
```
Contributing
--------------------------
Contributions, enhancements, and bug-fixes are welcome! [Open an issue](https://github.com/JS-DevTools/simplifyify/issues) on GitHub and [submit a pull request](https://github.com/JS-DevTools/simplifyify/pulls).
#### Building
To build the project locally on your computer:
1. __Clone this repo__
`git clone https://github.com/JS-DevTools/simplifyify.git`
2. __Install dependencies__
`npm install`
3. __Run the tests__
`npm test`
License
--------------------------
Simplifyify is 100% free and open-source, under the [MIT license](LICENSE). Use it however you want.
This package is [Treeware](http://treeware.earth). If you use it in production, then we ask that you [**buy the world a tree**](https://plant.treeware.earth/JS-DevTools/simplifyify) to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.
Big Thanks To
--------------------------
Thanks to these awesome companies for their support of Open Source developers ❤
[](https://github.com/open-source)
[](https://www.npmjs.com/)
[](https://coveralls.io)
[](https://travis-ci.com)
[](https://saucelabs.com)