Security News
Bun 1.2 Released with 90% Node.js Compatibility and Built-in S3 Object Support
Bun 1.2 enhances its JavaScript runtime with 90% Node.js compatibility, built-in S3 and Postgres support, HTML Imports, and faster, cloud-first performance.
broccoli-caching-writer
Advanced tools
Broccoli plugin that allows simple caching (while still allowing N:N) based on the input tree hash.
The broccoli-caching-writer package is a Broccoli plugin that provides a base class for Broccoli plugins that need to cache their output. It helps in optimizing build times by caching the results of expensive operations and reusing them when the input hasn't changed.
Caching Output
This feature allows you to create a custom Broccoli plugin that caches its output. The `updateCache` method is where you perform your expensive operations, and the results are cached for future builds.
const CachingWriter = require('broccoli-caching-writer');
const fs = require('fs');
class MyCachingWriter extends CachingWriter {
updateCache(srcDir, destDir) {
// Perform expensive operations here
fs.writeFileSync(`${destDir}/output.txt`, 'Cached content');
}
}
module.exports = MyCachingWriter;
Handling Multiple Input Nodes
This feature allows you to handle multiple input nodes. The `updateCache` method receives an array of source directories, enabling you to process multiple inputs and cache their results.
const CachingWriter = require('broccoli-caching-writer');
const fs = require('fs');
class MultiInputCachingWriter extends CachingWriter {
constructor(inputNodes, options) {
super(inputNodes, options);
}
updateCache(srcDirs, destDir) {
// srcDirs is an array of input directories
srcDirs.forEach((srcDir, index) => {
fs.writeFileSync(`${destDir}/output${index}.txt`, `Cached content from ${srcDir}`);
});
}
}
module.exports = MultiInputCachingWriter;
Custom Cache Key
This feature allows you to define a custom cache key for your plugin. The `cacheKey` method generates a unique key that can be used to determine if the cache should be invalidated.
const CachingWriter = require('broccoli-caching-writer');
const fs = require('fs');
const crypto = require('crypto');
class CustomCacheKeyWriter extends CachingWriter {
constructor(inputNodes, options) {
super(inputNodes, options);
}
cacheKey() {
// Generate a custom cache key
return crypto.createHash('md5').update('custom-key').digest('hex');
}
updateCache(srcDir, destDir) {
fs.writeFileSync(`${destDir}/output.txt`, 'Cached content with custom key');
}
}
module.exports = CustomCacheKeyWriter;
The broccoli-plugin package provides a base class for Broccoli plugins, similar to broccoli-caching-writer but without built-in caching functionality. It is more general-purpose and can be extended to create various types of Broccoli plugins.
The broccoli-persistent-filter package is another Broccoli plugin base class that provides persistent caching. It is designed for plugins that need to filter files and cache the results, similar to broccoli-caching-writer but with a focus on filtering operations.
The broccoli-funnel package is used to funnel files from one Broccoli tree to another. While it doesn't provide caching, it is often used in conjunction with caching plugins to optimize build processes by selecting specific files or directories.
Adds a thin caching layer based on the computed hash of the input tree. If the input tree has changed,
the readNonCached
method will be called, otherwise (input is the same) the results of the last readNonCached
call will be used instead.
I know, right?
Running the tests:
npm install
npm test
This project is distributed under the MIT license.
FAQs
Broccoli plugin that allows simple caching (while still allowing N:N) based on the input tree hash.
The npm package broccoli-caching-writer receives a total of 186,035 weekly downloads. As such, broccoli-caching-writer popularity was classified as popular.
We found that broccoli-caching-writer demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Bun 1.2 enhances its JavaScript runtime with 90% Node.js compatibility, built-in S3 and Postgres support, HTML Imports, and faster, cloud-first performance.
Security News
Biden's executive order pushes for AI-driven cybersecurity, software supply chain transparency, and stronger protections for federal and open source systems.
Security News
Fluent Assertions is facing backlash after dropping the Apache license for a commercial model, leaving users blindsided and questioning contributor rights.