(former name brbower
)
Let browserify-bower
plugin require bower components for you when building bundles, then you can require
them as normal node modules in application codes.
You can also provide external config, to guide browserify-bower
to external some bower components, which is useful when when building multiple bundles.
With npm do:
npm install browserify-bower
In your task runner like gulp
, add this plugin to browserify
:
b.plugin('browserify-bower', {
require: ['*', 'base62/lib/base62'],
external: {
exclude: ['comp1', 'comp2']
}
});
p.s. of course, you can also configure this in node package.json
.
Then, in js or html codes, you can require it like normal node module:
// in xxx.js
var comp1 = require('comp1');
var comp2 = require('alias2');
...
// in xx.html
<div class="container-fluid">
...
</div>
<script type="text/javascript">
require('domready')(function() {
var comp1 = require('comp1');
...
});
</script>
Use conf file,
$ browserify entry.js -d -p [browserify-bower --conf conf.json] > bundle.js
Use a node of the conf json,
$ browserify entry.js -d -p [browserify-bower --conf conf.json --confnode aa.bbb] > bundle.js
By default, browserify-bower
will try to find the working bower components dir from the dir of process.cwd()
. But you can specify another one.
In programmatic API, pls use like b.plugin(browserifyBower.workdir(thedir), {..})
.
In command line, pls use parameter --workdir thedir
.
p.s. feel free to use it side by other plugins/transforms, since it's a standard
browserify
plugin, no hack, no change to your codes.
action: string, guide browserify-bower
to require/external specified bower components; available values: require
| external
, default require
action config: string array or map object, available config items: include
| exclude
| alias
, examples:
a) ['name1', 'name2', ...]
(p.s. will be treated as { include: [name1, name2, ...] }
)
b) { exclude: ['comp5', 'comp7'], alias: ['comp1:alias1'] }
Notes: name
format: name[:alias]
, and name can be component name or submodule like 'base62/lib/base62'.
- if options undefined,
{ require: [all bower dependency names] }
will be used - if options..include undefined,
[all bower dependency names]
will be used - if both include/exclude and alias declared an alias for a component, declaration in alias will be used
You need ensure related node modules (for browserify-bower
) and bower components (for test codes) installed, then run npm test
.
For first time, you can do it like this:
browserify-bower $ npm install
...
browserify-bower $ cd test
browserify-bower/test $ bower install
...
browserify-bower/test $ cd ..
browserify-bower $ npm test
> [email protected] test ~/repos/browserify-bower
> mocha
....
4 passing (580ms)
browserify-bower $
browserify-bower
and debowerify
try to resolve same problem, but by different ways.
(p.s. in fact, browserify-bower's test codes were copied and modified from debowerify
, thanks so much ^^)
debowerify's way: analyze every js files of the application, to find/replace require string for bower components with their real paths
browserify-bower's way: pre resolve specified bower components and require them to browserify, then when required, they're already there
browserify-bower | debowerify | |
---|---|---|
require submodules (in application codes) |
support (built-in) |
support (built-in) |
require ... in html/template files | OK | not OK (since it doesn't anaylze html/template files) |
individual require/external (in build scripts) |
easy (with options) |
not so easy (through bower-resolve ) |
extension type | plugin | transform |
work mode | synchronous | asynchronous (since it depends on bower's resolving results) |
performance | slight and quickly (~ 2s to build a project of mine) |
slowly (13 ~ 14s to build the same project) (since it analyzes every js files of the application) |
v0.4.0 (20-Dec-2014):
- add command line support
v0.3.0 (14-Aug-2014):
- built-in support for submodules
- enhancement: if bower.main undefined, check 'index.js' then 'compname'.js
v0.2.0 (25-July-2014):
- added tests
- document improvement
- logic change: include all components declared in
dependencies
anddevDependencies
of bower.json, not onlydependencies
, if options..include undefined - enhancement: allow to specify workdir, where to determine bower components' home dir; default
process.cwd()
v0.1.0 (22-July-2014):
- first release (works fine in my personal project)
MIT