@roots/bud-cache 0.0.0

package/LICENSE.md

@@ -0,0 +1,19 @@
+Copyright © Roots Software Foundation LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,84 @@
+<p align="center"><img src="https://cdn.roots.io/app/uploads/logo-bud.svg" height="100" alt="bud.js" /></p>
+
+<p align="center">
+  <img alt="MIT License" src="https://img.shields.io/github/license/roots/bud?color=%23525ddc&style=flat-square" />
+  <img alt="npm" src="https://img.shields.io/npm/v/@roots/bud.svg?color=%23525ddc&style=flat-square" />
+  <img alt="Follow Roots" src="https://img.shields.io/twitter/follow/rootswp.svg?color=%23525ddc&style=flat-square" />
+</p>
+
+<h1 align="center"><strong>@roots/bud-cache</strong></h1>
+
+<p align="center">
+  Config caching
+</p>
+
+---
+
+## Installation
+
+Install **@roots/bud-cache** to your project.
+
+Yarn:
+
+```sh
+yarn add @roots/bud-cache --dev
+```
+
+npm:
+
+```sh
+npm install @roots/bud-cache --save-dev
+```
+
+## Exports
+
+| Signifier                                     | Description                                           |
+| :-------------------------------------------- | :---------------------------------------------------- |
+| `@roots/bud-cache`                            | The `bud.cache` service                               |
+| `@roots/bud-cache/invalidate-cache-extension` | Extension which invalidates cache during build errors |
+
+## Contributing
+
+Contributions are welcome from everyone.
+
+We have [contribution guidelines](https://github.com/roots/guidelines/blob/master/CONTRIBUTING.md) to help you get started.
+
+## License
+
+@roots/bud-cache is licensed under MIT.
+
+## Community
+
+Keep track of development and community news.
+
+- Join us on Roots Slack by becoming a [GitHub
+  sponsor](https://github.com/sponsors/roots)
+- Participate on the [Roots Discourse](https://discourse.roots.io/)
+- Follow [@rootswp on Twitter](https://twitter.com/rootswp)
+- Read and subscribe to the [Roots Blog](https://roots.io/blog/)
+- Subscribe to the [Roots Newsletter](https://roots.io/subscribe/)
+
+## Sponsors
+
+**Bud** is an open source project and completely free to use.
+
+However, the amount of effort needed to maintain and develop new features and projects within the Roots ecosystem is not sustainable without proper financial backing. If you have the capability, please consider [sponsoring Roots](https://github.com/sponsors/roots).
+
+<a href="https://k-m.com/">
+<img src="https://cdn.roots.io/app/uploads/km-digital.svg" alt="KM Digital" width="200" height="150"/>
+</a>
+<a href="https://carrot.com/">
+<img src="https://cdn.roots.io/app/uploads/carrot.svg" alt="Carrot" width="200" height="150"/>
+</a>
+<a href="https://wordpress.com/">
+<img src="https://cdn.roots.io/app/uploads/wordpress.svg" alt="WordPress.com" width="200" height="150"/>
+</a>
+<a href="https://pantheon.io/">
+<img src="https://cdn.roots.io/app/uploads/pantheon.svg" alt="Pantheon" width="200" height="150"/>
+</a>
+<a href="https://worksitesafety.ca/careers/">
+<img src="https://cdn.roots.io/app/uploads/worksite-safety.svg" alt="Worksite Safety" width="200" height="150"/>
+</a>
+<a href="https://www.copiadigital.com/">
+<img src="https://cdn.roots.io/app/uploads/copia-digital.svg" alt="Copia Digital" width="200" height="150"/>
+</a>

package/docs/01-exports.md

@@ -0,0 +1,8 @@
+---
+title: Exports
+---
+
+| Signifier                                     | Description                                           |
+| :-------------------------------------------- | :---------------------------------------------------- |
+| `@roots/bud-cache`                            | The `bud.cache` service                               |
+| `@roots/bud-cache/invalidate-cache-extension` | Extension which invalidates cache during build errors |

package/lib/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Caching service
+ *
+ * @see {@link https://bud.js.org}
+ * @see {@link https://github.com/roots/bud}
+ *
+ * @packageDocumentation
+ */
+import './types.js';
+import Cache from './service/index.js';
+export default Cache;
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA;;;;;;;GAOG;AAEH,OAAO,YAAY,CAAA;AAEnB,OAAO,KAAK,MAAM,oBAAoB,CAAA;AAEtC,eAAe,KAAK,CAAA"}

package/lib/index.js

@@ -0,0 +1,14 @@
+// Copyright © Roots Software Foundation LLC
+// Licensed under the MIT license.
+/**
+ * Caching service
+ *
+ * @see {@link https://bud.js.org}
+ * @see {@link https://github.com/roots/bud}
+ *
+ * @packageDocumentation
+ */
+import './types.js';
+import Cache from './service/index.js';
+export default Cache;
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,4CAA4C;AAC5C,kCAAkC;AAElC;;;;;;;GAOG;AAEH,OAAO,YAAY,CAAA;AAEnB,OAAO,KAAK,MAAM,oBAAoB,CAAA;AAEtC,eAAe,KAAK,CAAA"}

package/lib/invalidate-cache/index.d.ts

@@ -0,0 +1,22 @@
+import type { Bud } from '@roots/bud-framework';
+import { Extension } from '@roots/bud-framework/extension';
+/**
+ * Cache invalidation extension
+ *
+ * @remarks
+ * Certain webpack components such as `eslint-webpack-plugin` and
+ * `ts-loader` have issues with fs caching. This extension writes a file
+ * to the cache directory which is used to invalidate the cache before
+ * webpack is invoked on subsequent builds
+ */
+export default class InvalidateCacheExtension extends Extension {
+    /**
+     * Invalidation file path
+     */
+    get invalidationFile(): string;
+    /**
+     * `register` callback
+     */
+    register(bud: Bud): Promise<void>;
+}
+//# sourceMappingURL=index.d.ts.map

package/lib/invalidate-cache/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/invalidate-cache/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAC,GAAG,EAAC,MAAM,sBAAsB,CAAA;AAC7C,OAAO,EAAC,SAAS,EAAC,MAAM,gCAAgC,CAAA;AAIxD;;;;;;;;GAQG;AAEH,MAAM,CAAC,OAAO,OAAO,wBAAyB,SAAQ,SAAS;IAC7D;;OAEG;IACH,IAAW,gBAAgB,IAAI,MAAM,CAEpC;IAED;;OAEG;IAEmB,QAAQ,CAAC,GAAG,EAAE,GAAG;CA0BxC"}

package/lib/invalidate-cache/index.js

@@ -0,0 +1,59 @@
+import { __decorate, __metadata } from "tslib";
+import { join } from 'node:path';
+import { Extension } from '@roots/bud-framework/extension';
+import { bind, label } from '@roots/bud-framework/extension/decorators';
+import stripAnsi from 'strip-ansi';
+/**
+ * Cache invalidation extension
+ *
+ * @remarks
+ * Certain webpack components such as `eslint-webpack-plugin` and
+ * `ts-loader` have issues with fs caching. This extension writes a file
+ * to the cache directory which is used to invalidate the cache before
+ * webpack is invoked on subsequent builds
+ */
+let InvalidateCacheExtension = class InvalidateCacheExtension extends Extension {
+    /**
+     * Invalidation file path
+     */
+    get invalidationFile() {
+        return join(this.app.cache.cacheDirectory, `error.json`);
+    }
+    /**
+     * `register` callback
+     */
+    async register(bud) {
+        const invalidate = await bud.fs?.exists(this.invalidationFile);
+        if (invalidate || (bud.isCLI() && bud.context.args.flush)) {
+            await bud.fs.remove(this.invalidationFile);
+            await bud.fs.remove(bud.cache.cacheDirectory);
+        }
+        bud.after(async () => {
+            bud.compiler.instance.hooks.done.tap(this.label, async (compiler) => {
+                try {
+                    if (!compiler.hasErrors())
+                        return;
+                    await bud.fs.json.write(this.invalidationFile, {
+                        hash: compiler.hash,
+                        errors: compiler.stats.flatMap(stats => stats
+                            .toString({ preset: `errors-warnings`, colors: false })
+                            .split(/\n/)
+                            .map(stripAnsi)),
+                    });
+                }
+                catch (e) { }
+            });
+        });
+    }
+};
+__decorate([
+    bind,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Function]),
+    __metadata("design:returntype", Promise)
+], InvalidateCacheExtension.prototype, "register", null);
+InvalidateCacheExtension = __decorate([
+    label(`@roots/bud-cache/invalidate-cache`)
+], InvalidateCacheExtension);
+export default InvalidateCacheExtension;
+//# sourceMappingURL=index.js.map

package/lib/invalidate-cache/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/invalidate-cache/index.ts"],"names":[],"mappings":";AAAA,OAAO,EAAC,IAAI,EAAC,MAAM,WAAW,CAAA;AAG9B,OAAO,EAAC,SAAS,EAAC,MAAM,gCAAgC,CAAA;AACxD,OAAO,EAAC,IAAI,EAAE,KAAK,EAAC,MAAM,2CAA2C,CAAA;AACrE,OAAO,SAAS,MAAM,YAAY,CAAA;AAElC;;;;;;;;GAQG;AAEY,IAAM,wBAAwB,GAA9B,MAAM,wBAAyB,SAAQ,SAAS;IAC7D;;OAEG;IACH,IAAW,gBAAgB;QACzB,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,cAAc,EAAE,YAAY,CAAC,CAAA;IAC1D,CAAC;IAED;;OAEG;IAEmB,AAAN,KAAK,CAAC,QAAQ,CAAC,GAAQ;QACrC,MAAM,UAAU,GAAG,MAAM,GAAG,CAAC,EAAE,EAAE,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;QAE9D,IAAI,UAAU,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;YACzD,MAAM,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;YAC1C,MAAM,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,cAAc,CAAC,CAAA;SAC9C;QAED,GAAG,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE;YACnB,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,EAAC,QAAQ,EAAC,EAAE;gBAChE,IAAI;oBACF,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE;wBAAE,OAAM;oBAEjC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,gBAAgB,EAAE;wBAC7C,IAAI,EAAE,QAAQ,CAAC,IAAI;wBACnB,MAAM,EAAE,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CACrC,KAAK;6BACF,QAAQ,CAAC,EAAC,MAAM,EAAE,iBAAiB,EAAE,MAAM,EAAE,KAAK,EAAC,CAAC;6BACpD,KAAK,CAAC,IAAI,CAAC;6BACX,GAAG,CAAC,SAAS,CAAC,CAClB;qBACF,CAAC,CAAA;iBACH;gBAAC,OAAO,CAAC,EAAE,GAAE;YAChB,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;IACJ,CAAC;CACF,CAAA;AA1BuB;IADrB,IAAI;;;;wDA0BJ;AArCkB,wBAAwB;IAD5C,KAAK,CAAC,mCAAmC,CAAC;GACtB,wBAAwB,CAsC5C;eAtCoB,wBAAwB"}

package/lib/service/index.d.ts

@@ -0,0 +1,46 @@
+import type { Bud } from '@roots/bud-framework';
+import { Service } from '@roots/bud-framework/service';
+import type * as Services from '@roots/bud-framework/services';
+import type { Configuration } from '@roots/bud-support/webpack';
+/**
+ * Cache service class
+ */
+export default class Cache extends Service implements Services.Cache.Service {
+    /**
+     * Enabled
+     */
+    enabled: boolean;
+    /**
+     * Type
+     */
+    get name(): string;
+    set name(name: string);
+    /**
+     * Type
+     */
+    get type(): 'memory' | 'filesystem';
+    set type(type: 'memory' | 'filesystem');
+    /**
+     * version
+     */
+    get version(): string;
+    set version(version: string);
+    /**
+     * Cache directory
+     */
+    get cacheDirectory(): string;
+    set cacheDirectory(directory: string);
+    /**
+     * Webpack configuration
+     */
+    get configuration(): Configuration[`cache`];
+    /**
+     * {@link Extension.booted}
+     */
+    booted?(bud: Bud): Promise<void>;
+    /**
+     * Flush cache
+     */
+    flush(): Promise<void>;
+}
+//# sourceMappingURL=index.d.ts.map

package/lib/service/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/service/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAC,GAAG,EAAC,MAAM,sBAAsB,CAAA;AAC7C,OAAO,EAAC,OAAO,EAAC,MAAM,8BAA8B,CAAA;AACpD,OAAO,KAAK,KAAK,QAAQ,MAAM,+BAA+B,CAAA;AAI9D,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,4BAA4B,CAAA;AAI7D;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,KACnB,SAAQ,OACR,YAAW,QAAQ,CAAC,KAAK,CAAC,OAAO;IAEjC;;OAEG;IACI,OAAO,EAAE,OAAO,CAAO;IAE9B;;OAEG;IACH,IAAW,IAAI,IAAI,MAAM,CAKxB;IACD,IAAW,IAAI,CAAC,IAAI,EAAE,MAAM,EAE3B;IAED;;OAEG;IACH,IAAW,IAAI,IAAI,QAAQ,GAAG,YAAY,CAOzC;IAED,IAAW,IAAI,CAAC,IAAI,EAAE,QAAQ,GAAG,YAAY,EAE5C;IAED;;OAEG;IACH,IAAW,OAAO,IAAI,MAAM,CAc3B;IACD,IAAW,OAAO,CAAC,OAAO,EAAE,MAAM,EAEjC;IAED;;OAEG;IACH,IAAW,cAAc,IAAI,MAAM,CAKlC;IACD,IAAW,cAAc,CAAC,SAAS,EAAE,MAAM,EAE1C;IAED;;OAEG;IACH,IAAW,aAAa,IAAI,aAAa,CAAC,OAAO,CAAC,CAejD;IAED;;OAEG;IAEmB,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG;IAKtC;;OAEG;IAEU,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAGpC"}

package/lib/service/index.js

@@ -0,0 +1,107 @@
+import { __decorate, __metadata } from "tslib";
+import { createHash } from 'node:crypto';
+import { Service } from '@roots/bud-framework/service';
+import { bind } from '@roots/bud-support/decorators';
+import isString from '@roots/bud-support/lodash/isString';
+import join from '@roots/bud-support/lodash/join';
+import InvalidateCacheExtension from '../invalidate-cache/index.js';
+/**
+ * Cache service class
+ */
+export default class Cache extends Service {
+    constructor() {
+        super(...arguments);
+        /**
+         * Enabled
+         */
+        this.enabled = true;
+    }
+    /**
+     * Type
+     */
+    get name() {
+        return this.app.hooks.filter(`build.cache.name`, this.app.hooks.filter(`build.name`, this.app.context.label));
+    }
+    set name(name) {
+        this.app.hooks.on(`build.cache.name`, name);
+    }
+    /**
+     * Type
+     */
+    get type() {
+        return this.app.hooks.filter(`build.cache.type`, this.app.isCLI() && isString(this.app.context.args.cache)
+            ? this.app.context.args.cache
+            : `filesystem`);
+    }
+    set type(type) {
+        this.app.hooks.on(`build.cache.type`, type);
+    }
+    /**
+     * version
+     */
+    get version() {
+        const args = this.app.fs.json.stringify(this.app.isCLI() ? this.app.context.args : {});
+        const files = Object.values(this.app.context.config ?? {}).filter(file => file?.bud && file.sha1);
+        return this.app.hooks.filter(`build.cache.version`, createHash(`sha1`)
+            .update(join(args, ...files.map(({ module: { sha1 } }) => sha1)))
+            .digest(`base64`));
+    }
+    set version(version) {
+        this.app.hooks.on(`build.cache.version`, version);
+    }
+    /**
+     * Cache directory
+     */
+    get cacheDirectory() {
+        return this.app.hooks.filter(`build.cache.cacheDirectory`, this.app.path(`@storage`, this.app.label, `cache`, this.app.mode));
+    }
+    set cacheDirectory(directory) {
+        this.app.hooks.on(`build.cache.cacheDirectory`, directory);
+    }
+    /**
+     * Webpack configuration
+     */
+    get configuration() {
+        if (this.enabled !== true)
+            return false;
+        return this.type === `memory`
+            ? true
+            : {
+                name: this.name,
+                type: this.type,
+                store: `pack`,
+                allowCollectingMemory: true,
+                cacheDirectory: this.cacheDirectory,
+                idleTimeout: 10000,
+                idleTimeoutForInitialStore: 0,
+                profile: true,
+                version: this.version,
+            };
+    }
+    /**
+     * {@link Extension.booted}
+     */
+    async booted(bud) {
+        await bud.extensions.add(InvalidateCacheExtension);
+        this.app.success(`cache initialized`);
+    }
+    /**
+     * Flush cache
+     */
+    async flush() {
+        await this.app.fs.remove(this.cacheDirectory);
+    }
+}
+__decorate([
+    bind,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Function]),
+    __metadata("design:returntype", Promise)
+], Cache.prototype, "booted", null);
+__decorate([
+    bind,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], Cache.prototype, "flush", null);
+//# sourceMappingURL=index.js.map

package/lib/service/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/service/index.ts"],"names":[],"mappings":";AAAA,OAAO,EAAC,UAAU,EAAC,MAAM,aAAa,CAAA;AAGtC,OAAO,EAAC,OAAO,EAAC,MAAM,8BAA8B,CAAA;AAEpD,OAAO,EAAC,IAAI,EAAC,MAAM,+BAA+B,CAAA;AAClD,OAAO,QAAQ,MAAM,oCAAoC,CAAA;AACzD,OAAO,IAAI,MAAM,gCAAgC,CAAA;AAGjD,OAAO,wBAAwB,MAAM,8BAA8B,CAAA;AAEnE;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,KACnB,SAAQ,OAAO;IADjB;;QAIE;;WAEG;QACI,YAAO,GAAY,IAAI,CAAA;IAsGhC,CAAC;IApGC;;OAEG;IACH,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAC1B,kBAAkB,EAClB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,YAAY,EAAE,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAC5D,CAAA;IACH,CAAC;IACD,IAAW,IAAI,CAAC,IAAY;QAC1B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,kBAAkB,EAAE,IAAI,CAAC,CAAA;IAC7C,CAAC;IAED;;OAEG;IACH,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAC1B,kBAAkB,EAClB,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC;YACvD,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK;YAC7B,CAAC,CAAC,YAAY,CACjB,CAAA;IACH,CAAC;IAED,IAAW,IAAI,CAAC,IAA6B;QAC3C,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,kBAAkB,EAAE,IAAI,CAAC,CAAA;IAC7C,CAAC;IAED;;OAEG;IACH,IAAW,OAAO;QAChB,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,CACrC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAC9C,CAAA;QACD,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,MAAM,CAC/D,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,IAAI,IAAI,CAAC,IAAI,CAC/B,CAAA;QAED,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAC1B,qBAAqB,EACrB,UAAU,CAAC,MAAM,CAAC;aACf,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,EAAC,MAAM,EAAE,EAAC,IAAI,EAAC,EAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;aAC5D,MAAM,CAAC,QAAQ,CAAC,CACpB,CAAA;IACH,CAAC;IACD,IAAW,OAAO,CAAC,OAAe;QAChC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAA;IACnD,CAAC;IAED;;OAEG;IACH,IAAW,cAAc;QACvB,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAC1B,4BAA4B,EAC5B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAClE,CAAA;IACH,CAAC;IACD,IAAW,cAAc,CAAC,SAAiB;QACzC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,4BAA4B,EAAE,SAAS,CAAC,CAAA;IAC5D,CAAC;IAED;;OAEG;IACH,IAAW,aAAa;QACtB,IAAI,IAAI,CAAC,OAAO,KAAK,IAAI;YAAE,OAAO,KAAK,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI,KAAK,QAAQ;YAC3B,CAAC,CAAC,IAAI;YACN,CAAC,CAAC;gBACE,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,KAAK,EAAE,MAAgB;gBACvB,qBAAqB,EAAE,IAAI;gBAC3B,cAAc,EAAE,IAAI,CAAC,cAAc;gBACnC,WAAW,EAAE,KAAK;gBAClB,0BAA0B,EAAE,CAAC;gBAC7B,OAAO,EAAE,IAAI;gBACb,OAAO,EAAE,IAAI,CAAC,OAAO;aACtB,CAAA;IACP,CAAC;IAED;;OAEG;IAEmB,AAAN,KAAK,CAAC,MAAM,CAAE,GAAQ;QACpC,MAAM,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAA;QAClD,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAA;IACvC,CAAC;IAED;;OAEG;IAEU,AAAN,KAAK,CAAC,KAAK;QAChB,MAAM,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;IAC/C,CAAC;CACF;AAZuB;IADrB,IAAI;;;;mCAIJ;AAMY;IADZ,IAAI;;;;kCAGJ"}

package/lib/types.d.ts

@@ -0,0 +1,7 @@
+import type InvalidateCacheExtension from './invalidate-cache/index.js';
+declare module '@roots/bud-framework' {
+    interface Modules {
+        '@roots/bud-cache/invalidate-cache': InvalidateCacheExtension;
+    }
+}
+//# sourceMappingURL=types.d.ts.map

package/lib/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,wBAAwB,MAAM,6BAA6B,CAAA;AAEvE,OAAO,QAAQ,sBAAsB,CAAC;IACpC,UAAU,OAAO;QACf,mCAAmC,EAAE,wBAAwB,CAAA;KAC9D;CACF"}

package/lib/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/lib/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,92 @@
+{
+  "name": "@roots/bud-cache",
+  "description": "Config caching",
+  "version": "0.0.0",
+  "homepage": "https://roots.io/bud",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/roots/bud.git",
+    "directory": "sources/@roots/bud-cache"
+  },
+  "contributors": [
+    {
+      "name": "Kelly Mears",
+      "email": "developers@tinypixel.dev",
+      "url": "https://github.com/kellymears"
+    },
+    {
+      "name": "Ben Word",
+      "email": "ben@benword.com",
+      "url": "https://github.com/retlehs"
+    },
+    {
+      "name": "QWp6t",
+      "url": "https://github.com/QWp6t"
+    }
+  ],
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/roots/bud/issues"
+  },
+  "funding": {
+    "type": "github sponsors",
+    "url": "https://github.com/sponsors/roots"
+  },
+  "keywords": [
+    "bud",
+    "bud-framework"
+  ],
+  "engines": {
+    "node": ">=16"
+  },
+  "files": [
+    "docs",
+    "lib",
+    "src"
+  ],
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "import": "./lib/index.js"
+    },
+    "./service": {
+      "types": "./lib/service/index.js",
+      "import": "./lib/service.js"
+    },
+    "./invalidate-cache": {
+      "types": "./lib/invalidate-cache/index.d.ts",
+      "import": "./lib/invalidate-cache/index.js"
+    },
+    "./types": {
+      "types": "./lib/types.d.ts",
+      "import": "./lib/types.js"
+    }
+  },
+  "typesVersions": {
+    "*": {
+      ".": [
+        "./lib/index.d.ts"
+      ],
+      "./service": [
+        "./lib/service.d.ts"
+      ],
+      "./types": [
+        "./lib/types.d.ts"
+      ]
+    }
+  },
+  "module": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "devDependencies": {
+    "@skypack/package-check": "0.2.2"
+  },
+  "dependencies": {
+    "@roots/bud-framework": "0.0.0",
+    "@roots/bud-support": "0.0.0",
+    "strip-ansi": "7.0.1"
+  },
+  "volta": {
+    "extends": "../../../package.json"
+  }
+}

package/src/index.ts

@@ -0,0 +1,17 @@
+// Copyright © Roots Software Foundation LLC
+// Licensed under the MIT license.
+
+/**
+ * Caching service
+ *
+ * @see {@link https://bud.js.org}
+ * @see {@link https://github.com/roots/bud}
+ *
+ * @packageDocumentation
+ */
+
+import './types.js'
+
+import Cache from './service/index.js'
+
+export default Cache

package/src/invalidate-cache/index.ts

@@ -0,0 +1,56 @@
+import {join} from 'node:path'
+
+import type {Bud} from '@roots/bud-framework'
+import {Extension} from '@roots/bud-framework/extension'
+import {bind, label} from '@roots/bud-framework/extension/decorators'
+import stripAnsi from 'strip-ansi'
+
+/**
+ * Cache invalidation extension
+ *
+ * @remarks
+ * Certain webpack components such as `eslint-webpack-plugin` and
+ * `ts-loader` have issues with fs caching. This extension writes a file
+ * to the cache directory which is used to invalidate the cache before
+ * webpack is invoked on subsequent builds
+ */
+@label(`@roots/bud-cache/invalidate-cache`)
+export default class InvalidateCacheExtension extends Extension {
+  /**
+   * Invalidation file path
+   */
+  public get invalidationFile(): string {
+    return join(this.app.cache.cacheDirectory, `error.json`)
+  }
+
+  /**
+   * `register` callback
+   */
+  @bind
+  public override async register(bud: Bud) {
+    const invalidate = await bud.fs?.exists(this.invalidationFile)
+
+    if (invalidate || (bud.isCLI() && bud.context.args.flush)) {
+      await bud.fs.remove(this.invalidationFile)
+      await bud.fs.remove(bud.cache.cacheDirectory)
+    }
+
+    bud.after(async () => {
+      bud.compiler.instance.hooks.done.tap(this.label, async compiler => {
+        try {
+          if (!compiler.hasErrors()) return
+
+          await bud.fs.json.write(this.invalidationFile, {
+            hash: compiler.hash,
+            errors: compiler.stats.flatMap(stats =>
+              stats
+                .toString({preset: `errors-warnings`, colors: false})
+                .split(/\n/)
+                .map(stripAnsi),
+            ),
+          })
+        } catch (e) {}
+      })
+    })
+  }
+}

package/src/service/index.ts

@@ -0,0 +1,125 @@
+import {createHash} from 'node:crypto'
+
+import type {Bud} from '@roots/bud-framework'
+import {Service} from '@roots/bud-framework/service'
+import type * as Services from '@roots/bud-framework/services'
+import {bind} from '@roots/bud-support/decorators'
+import isString from '@roots/bud-support/lodash/isString'
+import join from '@roots/bud-support/lodash/join'
+import type {Configuration} from '@roots/bud-support/webpack'
+
+import InvalidateCacheExtension from '../invalidate-cache/index.js'
+
+/**
+ * Cache service class
+ */
+export default class Cache
+  extends Service
+  implements Services.Cache.Service
+{
+  /**
+   * Enabled
+   */
+  public enabled: boolean = true
+
+  /**
+   * Type
+   */
+  public get name(): string {
+    return this.app.hooks.filter(
+      `build.cache.name`,
+      this.app.hooks.filter(`build.name`, this.app.context.label),
+    )
+  }
+  public set name(name: string) {
+    this.app.hooks.on(`build.cache.name`, name)
+  }
+
+  /**
+   * Type
+   */
+  public get type(): 'memory' | 'filesystem' {
+    return this.app.hooks.filter(
+      `build.cache.type`,
+      this.app.isCLI() && isString(this.app.context.args.cache)
+        ? this.app.context.args.cache
+        : `filesystem`,
+    )
+  }
+
+  public set type(type: 'memory' | 'filesystem') {
+    this.app.hooks.on(`build.cache.type`, type)
+  }
+
+  /**
+   * version
+   */
+  public get version(): string {
+    const args = this.app.fs.json.stringify(
+      this.app.isCLI() ? this.app.context.args : {},
+    )
+    const files = Object.values(this.app.context.config ?? {}).filter(
+      file => file?.bud && file.sha1,
+    )
+
+    return this.app.hooks.filter(
+      `build.cache.version`,
+      createHash(`sha1`)
+        .update(join(args, ...files.map(({module: {sha1}}) => sha1)))
+        .digest(`base64`),
+    )
+  }
+  public set version(version: string) {
+    this.app.hooks.on(`build.cache.version`, version)
+  }
+
+  /**
+   * Cache directory
+   */
+  public get cacheDirectory(): string {
+    return this.app.hooks.filter(
+      `build.cache.cacheDirectory`,
+      this.app.path(`@storage`, this.app.label, `cache`, this.app.mode),
+    )
+  }
+  public set cacheDirectory(directory: string) {
+    this.app.hooks.on(`build.cache.cacheDirectory`, directory)
+  }
+
+  /**
+   * Webpack configuration
+   */
+  public get configuration(): Configuration[`cache`] {
+    if (this.enabled !== true) return false
+    return this.type === `memory`
+      ? true
+      : {
+          name: this.name,
+          type: this.type,
+          store: `pack` as `pack`,
+          allowCollectingMemory: true,
+          cacheDirectory: this.cacheDirectory,
+          idleTimeout: 10000,
+          idleTimeoutForInitialStore: 0,
+          profile: true,
+          version: this.version,
+        }
+  }
+
+  /**
+   * {@link Extension.booted}
+   */
+  @bind
+  public override async booted?(bud: Bud) {
+    await bud.extensions.add(InvalidateCacheExtension)
+    this.app.success(`cache initialized`)
+  }
+
+  /**
+   * Flush cache
+   */
+  @bind
+  public async flush(): Promise<void> {
+    await this.app.fs.remove(this.cacheDirectory)
+  }
+}

package/src/types.ts

@@ -0,0 +1,7 @@
+import type InvalidateCacheExtension from './invalidate-cache/index.js'
+
+declare module '@roots/bud-framework' {
+  interface Modules {
+    '@roots/bud-cache/invalidate-cache': InvalidateCacheExtension
+  }
+}