Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/js-devtools/globify
Run browserify and watchify with globs - even on Windows!
https://github.com/js-devtools/globify
browserify cli cross-platform glob-pattern globs linux macos nodejs windows
Last synced: 14 days ago
JSON representation
Run browserify and watchify with globs - even on Windows!
- Host: GitHub
- URL: https://github.com/js-devtools/globify
- Owner: JS-DevTools
- License: mit
- Created: 2015-06-11T21:27:05.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2020-07-16T13:55:23.000Z (over 4 years ago)
- Last Synced: 2024-10-30T17:07:56.916Z (14 days ago)
- Topics: browserify, cli, cross-platform, glob-pattern, globs, linux, macos, nodejs, windows
- Language: JavaScript
- Homepage: https://jstools.dev/globify/
- Size: 1.21 MB
- Stars: 16
- Watchers: 3
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Globify
============================
#### Run browserify and watchify with globs - even on Windows!
[](https://github.com/JS-DevTools/globify/actions)
[](https://github.com/JS-DevTools/globify/actions)
[](https://coveralls.io/github/JS-DevTools/globify)
[](https://david-dm.org/JS-DevTools/globify)
[](https://www.npmjs.com/package/@jsdevtools/globify)
[](LICENSE)
[](https://plant.treeware.earth/JS-DevTools/globify)
Features
--------------------------
* Supports [glob patterns](https://github.com/isaacs/node-glob#glob-primer) for entry files - even on Windows
* Optionally create separate browserify bundles for each entry file
Related Projects
--------------------------
- [simplifyify](https://jstools.dev/simplifyify)
A simplified Browserify and Watchify CLI
- [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/). Add the `-g` flag to install globally so you can use it from any terminal.
```bash
npm install -g @jsdevtools/globify
```
Usage
--------------------------
The command-line interface is identical to [browserify](https://github.com/substack/node-browserify#usage) and [watchify](https://github.com/substack/watchify#usage). In fact, globify simply passes your arguments straight to browserify or watchify (after expanding the glob pattern).
```
globify [options]
Options:
Glob pattern of entry files. Don't forget to wrap the glob pattern in quotes,
otherwise some shells (like bash) will pre-expand the glob.
--outfile=FILE, -o FILE
If outfile is a file, then a single bundle will be created. If it's a directory,
then separate bundles will be created for each entry file. You can also specify
an output filename pattern, like *.bundled.js
--exclude=GLOB, -u GLOB
Excludes files that are matched by the
--watch, -w
Call watchify instead of browserify.
```
Examples
--------------------------
For all of these examples, assume that we have a file structure like this:
```
lib/
|__ my-entry-file.js
|__ some-file.js
|__ other-file.js
|__ other-entry-file.js
|__ subdir/
|__ another-entry-file.js
|__ another-file.js
|__ yet-another-file.js
```
#### Multiple files in one bundle
We want to bundle all three entry files into a single bundle file. We can do that with the following command:
```
globify "lib/**/*-entry-file.js" --outfile=dist/my-bundle.js
```
Globify will call `browserify` once, passing it the three matching entry files and one bundle file:
```
browserify lib/my-entry-file.js lib/other-entry-file.js lib/subdir/another-entry-file.js --outfile=dist/my-bundle.js
```
#### Multiple files, multiple bundles
We want to create separate bundle files for each of the three entry files. We can do that with the following command:
```
globify "lib/**/*-entry-file.js" --outfile=dist
```
Globify will call `browserify` three times (once for each entry file), and create three corresponding bundles:
```
browserify lib/my-entry-file.js --outfile=dist/my-entry-file.js
browserify lib/other-entry-file.js --outfile=dist/other-entry-file.js
browserify lib/subdir/another-entry-file.js --outfile=dist/subdir/another-entry-file.js
```
#### Multiple files, multiple bundles with customized names
We want to create separate bundle files for each of the three entry files, but we weant each bundle file to have a `.bundled.js` suffix. We can do that with the following command:
```
globify "lib/**/*-entry-file.js" -o "dist/*.bundled.js"
```
Globify will call `browserify` three times (once for each entry file) and create three corresponding bundles:
```
browserify lib/my-entry-file.js -o dist/my-entry-file.bundled.js
browserify lib/other-entry-file.js -o dist/other-entry-file.bundled.js
browserify lib/subdir/another-entry-file.js -o dist/subdir/another-entry-file.bundled.js
```
#### Watchify, transforms, other options
Now, let's try it with watchify instead. Let's also add some extra options, and run the `uglifyify` transforms to minify the bundles. And let's give the bundles a `.bundled.min.js` suffix.
```
globify -g uglifyify "lib/**/*-entry-file.js" -w -v -d -o "dist/*.bundled.min.js"
```
Globify will call `watchify` (because of the `-w` option) three times with all of the specified options:
```
watchify -g uglifyify lib/my-entry-file.js -v -d -o dist/my-entry-file.bundled.min.js
watchify -g uglifyify lib/other-entry-file.js -v -d -o dist/other-entry-file.bundled.min.js
watchify -g uglifyify lib/subdir/another-entry-file.js -v -d -o dist/subdir/another-entry-file.bundled.min.js
```
Contributing
--------------------------
Contributions, enhancements, and bug-fixes are welcome! [Open an issue](https://github.com/JS-DevTools/globify/issues) on GitHub and [submit a pull request](https://github.com/JS-DevTools/globify/pulls).
#### Building/Testing
To build/test the project locally on your computer:
1. __Clone this repo__
`git clone https://github.com/JS-DevTools/globify.git`
2. __Install dependencies__
`npm install`
3. __Run the tests__
`npm test`
License
--------------------------
Globify 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/globify) 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://travis-ci.com)
[](https://saucelabs.com)
[](https://coveralls.io)