# bower-requirejs

> Automagically wire-up installed Bower components into your RequireJS config

Latest version **1.2.0** (published 2015-08-25) · BSD-2-Clause license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install bower-requirejs
pnpm add bower-requirejs
yarn add bower-requirejs
bun add bower-requirejs
```

Provides the command `bower-requirejs`.

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.2.0 |
| Published | 2015-08-25 |
| First published | 2013-09-07 |
| Weekly downloads | 0 |
| License | BSD-2-Clause |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 9 |
| Known vulnerabilities | 0 (+5 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 371 |
| Author | Sindre Sorhus |
| Maintainers | sindresorhus, robdodson, addyosmani, eddiemonge, passy, sboudrias, arthurvr |
| Keywords | bower, requirejs, rjs, config, wire, inject, install, component, package, module |

## Links

- npm: https://www.npmjs.com/package/bower-requirejs
- Repository: https://github.com/yeoman/bower-requirejs
- Homepage: https://github.com/yeoman/bower-requirejs#readme
- Issues: https://github.com/yeoman/bower-requirejs/issues
- npm.io page: https://npm.io/package/bower-requirejs

## Dependencies (9)

- [nopt](https://npm.io/package/nopt.md) ^3.0.0
- [chalk](https://npm.io/package/chalk.md) ^1.0.0
- [slash](https://npm.io/package/slash.md) ^1.0.0
- [lodash](https://npm.io/package/lodash.md) ^3.3.0
- [requirejs](https://npm.io/package/requirejs.md) ^2.1.5
- [file-utils](https://npm.io/package/file-utils.md) ^0.2.1
- [sudo-block](https://npm.io/package/sudo-block.md) ^1.0.0
- [object-assign](https://npm.io/package/object-assign.md) ^2.0.0
- [update-notifier](https://npm.io/package/update-notifier.md) ^0.3.0

## Alternatives

- [@progress/kendo-ooxml](https://npm.io/package/@progress/kendo-ooxml.md) — 152.1K weekly downloads
- [@progress/kendo-react-ripple](https://npm.io/package/@progress/kendo-react-ripple.md) — 8.0K weekly downloads
- [@progress/kendo-react-orgchart](https://npm.io/package/@progress/kendo-react-orgchart.md) — 4.3K weekly downloads
- [@praxisui/dynamic-fields](https://npm.io/package/@praxisui/dynamic-fields.md) — 2.4K weekly downloads
- [@progress/kendo-vue-listbox](https://npm.io/package/@progress/kendo-vue-listbox.md) — 932 weekly downloads

## Recent versions

- 1.2.0 (latest) — 2015-08-25
- 1.1.3 — 2015-02-24
- 1.1.2 — 2014-09-11
- 1.1.1 — 2014-09-04
- 1.1.0 — 2014-08-26
- 1.0.0 — 2014-08-02
- 0.11.0 — 2014-05-12
- 0.10.3 — 2014-03-08
- 0.10.2 — 2014-03-06
- 0.10.1 — 2014-03-06
- 0.10.0 — 2014-02-20
- 0.9.2 — 2014-02-06
- 0.9.1 — 2014-01-26
- 0.9.0 — 2014-01-16
- 0.8.6 — 2014-01-01
- … 5 more at https://npm.io/package/bower-requirejs/versions

## README

# bower-requirejs [![Build Status](https://secure.travis-ci.org/yeoman/bower-requirejs.svg?branch=master)](http://travis-ci.org/yeoman/bower-requirejs)

> Automagically wire-up installed Bower components into your RequireJS config


## Install

```sh
$ npm install --save bower-requirejs
```


## Usage

```
./node_modules/.bin/bower-requirejs -c path/to/config.js -e underscore -e jquery
```


## Options

```
-h, --help              # Print options and usage'
-v, --version           # Print the version number'
-c, --config            # Path to your RequireJS config file'
-e, --exclude           # Name of a dependency to be excluded from the process'
-b, --base-url          # Path which all dependencies will be relative to'
-t, --transitive        # Process transitive dependencies'
-s, --shim              # Shim dependencies'
-d, --exclude-dev       # Exclude devDependencies'
```


## Using Bower Hooks

Bower >=v1.3.1 includes [hooks](https://github.com/bower/bower/blob/master/HOOKS.md) for `preinstall`, `postinstall` and `preuninstall` actions. To run grunt-bower-requirejs after every bower install, add a `scripts` block to your `.bowerrc`.

```
{
  "scripts": {
    "postinstall": "bower-requirejs -c path/to/config.js"
  }
}
```


## Things to remember

### Config file

If you do not already have a `config.js` file at the location specified by the `--config` option then one will be generated for you. A basic `config.js` file looks like this:

``` js
requirejs.config({
  shim: {},
  paths: {}
});
```

You still need to create a path for *your* js files. This tool will only create paths for third party libraries specified in `bower.json`.

``` js
requirejs.config({
  shim: {},
  paths: {
    myComponent: 'js/myComponent.js'  // make sure to add your components!
  }
});
```

The tool does not overwrite the config file, it just adds additional paths to it. So paths you add will be preserved. Keep in mind that if you change or remove one of your Bower dependencies after you've run the task, that path will still exist in the config file and you'll need to manually remove it.


### Transitive option

If the transitive option is set to ```true```, then transitive dependencies will be also added to the require config.

For example, say we explicitly have an entry in our bower config for module ```myTotallyCoolModule```, which depends on ```jQuery``` and ```underscore```. If the transitive option is set to ```true```, there will be config entries for ```myTotallyCoolModule```, ```jQuery```, and ```underscore```. Otherwise, if the transitive option is set to ```false```, there will only be a config entry for ```myTotallyCoolModule```.

Each transitive dependency is only included once, even if the dependency is used multiple times.

### exclude-dev option

If the `exclude-dev` option is set to ```true```, then dev-dependencies will not be added to the require config.


### RequireJS component

## Package Support

If a dependency's `moduleType` is set to `node` in `bower.json` it will be treated as a [CommonJS Package](http://requirejs.org/docs/api.html#packages).

The following `bower.json` file:

``` js
{
  "name": "node-module-type-stub",
  "version": "0.0.1",
  "moduleType": ["node"],
  "main": "myMain.js"
}
```

Will generate this entry in your `config.js` file:

```
require.config({
  shim: {},
  packages: [
    {
      name: 'node-module-type-stub',
      main: 'myMain.js'
    }
  ],
  paths: {}
});
```

### Overriding the main file of a dependency

You can override the main file of a given dependency by specifying the `overrides.{dependency}.main` property
in your `bower.json` file:

```js
{  
  "overrides": {
     "jquery": {
       "main": "jquery.min.js"
     },
     "anima": {
       "main": "anima.min.js"
     }
   }
 }
```

> The file path is relative to the dependency folder

## Programmatic API

### bowerRequireJS(options, callback)

- `options` — An [options object](https://github.com/yeoman/bower-requirejs#options) containing optional config, baseUrl, and exclude options. The `config` option specifies an output file to which the generated require.js config will be written. If a require.js config file already exists at this location, the generated config will be merged into this file.
- `callback` — A callback to execute when the task is finished. This callback will receive an object that contains the require.js configuration generated from bower components. Note that this includes *only* config elements representing bower components.

You can use `bower-requirejs` directly in your app if you prefer to not rely on the binary.

```js
var bowerRequireJS = require('bower-requirejs');

var options = {
  config: 'scripts/config.js',
  exclude: ['underscore', 'jquery'],
  transitive: true
};

bowerRequireJS(options, function (rjsConfigFromBower) {
  // all done!
});
```


### parse(pkg, name, baseUrl)

- `pkg` — A package object returned from `bower list`
- `name` — The name of the package
- `baseUrl` — A baseUrl to use when generating the path

If you would like to just receive a paths object you can do so with the `parse` module. If your package does not contain a `bower.json` file, or if the `bower.json` does not contain a `main` attribute then the parse module will try to use the `primary` module to find a primary, top-level js file.

```js
var bower = require('bower');
var _ = require('lodash');
var parse = require('bower-requirejs/lib/parse');

var baseUrl = './';

bower.commands.list()
  .on('end', function (data) {
    _.forOwn(data.dependencies, function (pkg, name) {
      if (name == 'jquery') {
        var pathObj = parse(pkg, name, baseUrl);
      }
    });
  });
```

### primary(name, canonicalDir, opts)

- `name` — The package name
- `canonicalDir` — The canonicalDir for the package, either returned by `bower list` or passed in manually
- `opts` — Use the ```opts.extraSearchDirs``` to specify other dirs to search, relative to the canonicalDir. By default this is ```['dist']```.

If you just want to look for the js file in a bower component's top-level directory or 'dist' directory you can use the `primary` module. The `primary` module will exclude gruntfiles and `min.js` files. It will also check if `package.json` specifies a `main` js file.

```js
var primary = require('bower-requirejs/lib/primary');

var name = 'backbone';
var dep = { canonicalDir: './bower_components/backbone' };

var primaryJS = primary(name, dep);
// returns backbone.js
```

### buildConfig(bowerDependencyGraph, options)

- `bowerDependencyGraph` — A bower dependency graph, as returned by a call to `bower.commands.list`
- `options` — An object containing `baseUrl`, `exclude`, and `transitive` options, as described above.

This module can be used to generate a requireJs config elements from bower components.

```js
var buildConfig = require('bower-requirejs/lib/build-config');

bower.commands.list({})
.on('end', function (dependencyGraph) {
  var configElementsFromBower = buildConfig(dependencyGraph, {
    baseUrl : '/some/base/url',
    exclude: ['underscore', 'jquery'],
    transitive: true
  });
});
```

## Credit

[![Sindre Sorhus](http://gravatar.com/avatar/d36a92237c75c5337c17b60d90686bf9?s=144)](http://sindresorhus.com) | [![Rob Dodson](http://gravatar.com/avatar/95c3a3b33ea51545229c625bef42e343?s=144)](http://robdodson.me)
:---:|:---:
[Sindre Sorhus](http://sindresorhus.com) (creator) | [Rob Dodson](http://robdodson.me) (maintainer)


## License

[BSD license](http://opensource.org/licenses/bsd-license.php) and copyright Google

---
_Source: https://npm.io/package/bower-requirejs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
