Source Dependencies

A tool for automatically discovering and "sourcing" your dependency packages from Bower and NPM and any other packagers.

Install

1npm install --save-dev source-deps

Example Usage with Gulp

1var deps = require('source-deps'),
2    concat = require('gulp-concat');
3
4gulp.task('bundle', function () {
5  var depFiles = deps({
6    packagers: ['bower', 'npm'],
7    includeDevPackages: false,
8    logOutput: false,
9    overrides: {
10      angular: 'lib/angular.min.js'
11    },
12    ignore: ['normalize.css'],
13    order: [
14      'angular',
15      'angular-mocks'
16    ],
17    include: [
18      'some-package-apparently-not-listed-as-dependency'
19    ],
20    recursive: true // Pull in dependencies of dependencies (in proper order too :)
21  });
22  gulp.src(depFiles)
23  .pipe(concat(['src/**/*.js']))
24  .pipe(gulp.dest('all.js'));
25});

This example pulls in all production dependencies from package.json and bower.json.

Overrides

Overrides tells it where to find dist files for a library where the automatic guessing is not working.

It is very important that you make sure each dependency package has correct paths to the dist files.

Turning on logging

1deps({
2  packagers: ['bower', 'npm'],
3  logOutput: true
4})

This will show you how many files get pulled in as well as which packages are likely not being pulled properly.

Order

As of 0.2.5 you can control the ordering of your dependant files now! Very helpful, like so.

1var deps = require('source-deps'),
2    depFiles = deps({
3      packagers: ['bower'],
4      order: [
5        'angular',
6        'angular-mocks',
7        'angular-animate'
8      ]
9    });

This will happily prevent your dependencies from being loaded out of proper resolution order :)

Ignore

And now you can ignore certain packages by just adding them to the ignore option like so:

1
2var deps = require('source-deps'),
3    depFiles = deps({
4      packagers: ['bower'],
5      order: [
6        'angular',
7        'angular-mocks'
8      ],
9      ignore: [
10        'angular-animate'
11      ]
12    });

Include

This is for a number of odd situations where there is a package present that is either:

A) Not listed as a dependency

B) Ignored already

C) Ignored by a future feature that allows for exclusion patterns

... and needs to be included anyway. In other words it overrides any exclusions.

1
2depFiles = deps({
3  packagers: ['bower'],
4  ignore: ['said-package'],
5  include: ['said-package'] // Takes priority
6});
7

Recursive

Oh yeah... this does exactly what you think it does. Bye, bye RequireJS shims on the frontend.

1
2depFiles = deps({
3  packagers: ['bower'],
4  recursive: true
5});

• Pulls in all dependencies-of-dependencies
• Ignores duplicate occurences of dependencies (i.e. won't pull in JQuery 900 times ;)
• Respects order, ignore, and include.
• By default will load dependencies BEFORE the package that pulled them in, usually resulting in resolution order being met correctly.
• Use order to resolve anything that pulls in too early / too late as a result of overlapping secondaries amongst packages.