Napoleon's Pixelated Mugshot

    broccoli-caching-writer

    3.0.3 • Public • Published

    Broccoli Caching Writer

    Build Status Build status

    Drop-in-replacement for broccoli-writer adding a thin caching layer based on the computed hash of the input directory trees. If any file in an input node has changed, the build method will be called, otherwise (if input is the same) the results of the last build call will be used instead.

    Example

    var Plugin = require('broccoli-caching-writer');
     
    MyPlugin.prototype = Object.create(Plugin.prototype);
    MyPlugin.prototype.constructor = MyPlugin;
    function MyPlugin(inputNodes, options) {
      options = options || {};
      // options.inputFiles === array of globs, to consider for the cache key
      Plugin.call(this, inputNodes, {
        annotation: options.annotation
      });
    }
     
    MyPlugin.prototype.build = function() {
      // cache has been busted
      // do anything, for example:
      //   1. read from this.inputPaths
      //   2. do something based on the result
      //   3. and then, write to this.outputPath
    };

    Documentation

    new CachingWriter(inputNodes, options)

    Call this base class constructor from your subclass constructor.

    • inputNodes: An array of input nodes.

    • options:

      • name, annotation, persistentOutput: Same as broccoli-plugin; see there.

      • cacheInclude (default: []): An array of regular expressions that files and directories in an input node must pass (match at least one pattern) in order to be included in the cache hash for rebuilds. In other words, a whitelist of patterns that identify which files and/or directories can trigger a rebuild.

      • cacheExclude (default: []): An array of regular expressions that files and directories in an input node cannot pass in order to be included in the cache hash for rebuilds. In other words, a blacklist of patterns that identify which files and/or directories will never trigger a rebuild.

        Note, in the case when a file or directory matches both an include and exlude pattern, the exclude pattern wins

    plugin.listFiles

    list files matched, helpful as it allows us avoid a second glob, lexicographically sorted by relativePath.

    plugin.listEntries

    list entries (stat objects) of files matched, helpful when further FS information is required on rebuild, lexicographically sorted by relativePath.

    ZOMG!!! TESTS?!?!!?

    I know, right?

    Running the tests:

    npm install
    npm test

    License

    This project is distributed under the MIT license.

    Install

    npm i broccoli-caching-writer

    DownloadsWeekly Downloads

    266,435

    Version

    3.0.3

    License

    MIT

    Last publish

    Collaborators

    • rwjblue
    • stefanpenner