directory-metagen

Generates directory meta files for things such as including entire directories in requirejs.

Started as a feature request on requirejs-metagen but has grown beyond it (as it is no longer tied to requirejs).

Requires Node Version >= 4.3.2

API

directory-metagen takes an object with the following parameters:

Name	Description
`path`	The directory in which to look
`format`	The format function to use to generate the output
`output`	The relative destination file path (optional, defaults to `__all.js`)
`exclusions`	An array of minimatch glob for exclusion, see recursive-readdir for more info
`filter`	A function which will filter the matched files, typically to whitelist extensions. Defaults to `/.js

Customization

This library takes a custom format parameter, which is a function that recieves the (recursive) list of files in a directory and then generates an output file

Supported Formats

For each of the examples below, we will be running the metagen against the example directory tree below.

some_dependencies/
├── dependency-a/
│   ├── foo.js
├── dependency-b/
│   ├── bar.js
│   └── baz.js
└── dependency-empty/

amd

amd format is the traditional define([], function() { }) syntax. The generated object is a hash where the keys are the paths to the files without extensions, and the values are the required in modules

Example output

// some_dependencies/__all.js
define([
    'dependency-a/foo',
    'dependency-b/bar',
    'dependency-b/baz'
], function() {
    return {
        'dependency-a/foo': arguments[0],
        'dependency-b/bar': arguments[1],
        'dependency-b/baz': arguments[2]
    }
});

commonJS

commonJS format is the CommonJS sugar syntax supported by requirejs define(function(require) {}). The generated object is a hash where the keys are the paths to the files without extensions, and the values are the required in modules

Example output

// some_dependencies/__all.js
define(function(require) {
    return {
        'dependency-a/foo': require('./dependency-a/foo'),
        'dependency-b/bar': require('./dependency-b/bar'),
        'dependency-b/baz': require('./dependency-b/baz')
    };
});

deepAMD

deepAMD format is just like amd, except that the object is nested so directories have child properties corresponding to files (e.g. { a: { b: { c: file } } } instead of { 'a.b.c': file })

Example output

// some_dependencies/__all.js
define([
    'dependency-a/foo',
    'dependency-b/bar',
    'dependency-b/baz'
], function() {
    return {
        "dependency-a": {
            "foo": "arguments[0]"
        },
        "dependency-b": {
            "bar": "arguments[1]",
            "baz": "arguments[2]"
        }
    };
});

deepCommonJS

deepCommonJS format is just like commonJS, except that the object is nested so directories have child properties corresponding to files (e.g. { a: { b: { c: file } } } instead of { 'a.b.c': file })

Example output

// some_dependencies/__all.js
define(function(require) {
    return {
        "dependency-a": {
            "foo": require('./dependency-a/foo')
        },
        "dependency-b": {
            "baz": require('./dependency-b/baz'),
            "bar": require('./dependency-b/bar')
        }
    };
});

Usage with Gulp

Here's an example using with gulp including a watch mode:

// gulpfile.js
var gulp = require('gulp');
var Promise = require('bluebird');
var metagen = require('directory-metagen');
var metagenPaths = [{
    path: __dirname + '/public/someDir/',
    // exclusions: ['all.js'],
    format: metagen.formats.deepCommonJS
    //output: '__generated-all.js' // relative to path
}];
gulp.task('metagen', x => Promise.map(metagenPaths, metagen));
gulp.task('metagen-watch', function() {
    // Watch for files added and removed
    require('chokidar').watch(_.map(metagenPaths, 'path'))
        .on('add', x => gulp.start('metagen'))
        .on('unlink', x => gulp.start('metagen'));
});

agamemnus / directory-metagen Goto Github PK