https://github.com/ember-cli/broccoli-caching-writer
https://github.com/ember-cli/broccoli-caching-writer
broccoli
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ember-cli/broccoli-caching-writer
- Owner: ember-cli
- License: mit
- Created: 2014-04-26T15:48:26.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2018-10-26T13:01:40.000Z (about 7 years ago)
- Last Synced: 2025-08-02T04:53:04.361Z (6 months ago)
- Topics: broccoli
- Language: JavaScript
- Size: 167 KB
- Stars: 17
- Watchers: 10
- Forks: 29
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Broccoli Caching Writer
[](https://travis-ci.org/ember-cli/broccoli-caching-writer)
[![Build status][appveyor-badge]][appveyor-badge-url]
Drop-in-replacement for
[broccoli-plugin](https://github.com/broccolijs/broccoli-plugin) 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
```js
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](https://github.com/broccolijs/broccoli-plugin#new-plugininputnodes-options);
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:
```javascript
npm install
npm test
```
## License
This project is distributed under the MIT license.
[appveyor-badge]: https://ci.appveyor.com/api/projects/status/ocfp2hqo7hyhyy80?svg=true
[appveyor-badge-url]: https://ci.appveyor.com/project/embercli/broccoli-caching-writer/branch/master