@roots/bud-cache 6.13.0 → 6.14.0

package/lib/index.d.ts

@@ -1,9 +1,7 @@
 /**
- * Caching service
+ * @roots/bud-cache
  *
  * @see {@link https://bud.js.org}
  * @see {@link https://github.com/roots/bud}
  */
-import './types.js';
-import Cache from './service/index.js';
-export default Cache;
+export { default } from './service/index.js';

package/lib/index.js

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

package/lib/service/index.d.ts

@@ -1,50 +1,55 @@
 import type { Bud } from '@roots/bud-framework';
+import type { Configuration } from '@roots/bud-framework/config';
+import type { Cache as BudCache } from '@roots/bud-framework/services';
 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 {
+export default class Cache extends Service implements BudCache {
     /**
-     * Enabled
+     * {@link BudCache.enabled}
      */
     enabled: boolean;
     /**
-     * Type
-     */
-    get name(): string;
-    set name(name: string);
-    /**
-     * Type
+     * {@link Extension.boot}
      */
-    get type(): 'memory' | 'filesystem';
-    set type(type: 'memory' | 'filesystem');
+    boot?(bud: Bud): Promise<void>;
     /**
-     * version
+     *{@link BudCache.buildDependencies}
      */
-    get version(): string;
-    set version(version: string);
+    get buildDependencies(): Record<string, Array<string>>;
+    set buildDependencies(dependencies: Record<string, Array<string>>);
     /**
-     * Cache directory
+     * {@link BudCache.cacheDirectory}
      */
     get cacheDirectory(): string;
     set cacheDirectory(directory: string);
     /**
-     * Cache dependencies
+     * {@link BudCache.configuration}
+     * @readonly
      */
-    get buildDependencies(): Record<string, Array<string>>;
-    set buildDependencies(dependencies: Record<string, Array<string>>);
+    get configuration(): Configuration[`cache`];
     /**
-     * Webpack configuration
+     * {@link BudCache.flush}
      */
-    get configuration(): Configuration[`cache`];
+    flush(): Promise<void>;
     /**
-     * {@link Extension.boot}
+     * {@link BudCache.name}
      */
-    boot(bud: Bud): Promise<void>;
+    get name(): string;
+    set name(name: string);
     /**
-     * Flush cache
+     * {@link BudCache.register}
      */
-    flush(): Promise<void>;
+    register?(bud: Bud): Promise<void>;
+    /**
+     * {@link BudCache.type}
+     */
+    get type(): 'filesystem' | 'memory';
+    set type(type: 'filesystem' | 'memory');
+    /**
+     * {@link BudCache.version}
+     */
+    get version(): string;
+    set version(version: string);
 }

package/lib/service/index.js

@@ -1,69 +1,32 @@
 import { __decorate, __metadata } from "tslib";
-import { createHash } from 'node:crypto';
 import { join } from 'node:path';
 import { Service } from '@roots/bud-framework/service';
 import { bind } from '@roots/bud-support/decorators/bind';
 import isString from '@roots/bud-support/lodash/isString';
-import { hash } from '@roots/bud-support/utilities/args';
-import InvalidateCacheExtension from '../invalidate-cache/index.js';
 /**
  * Cache service class
  */
 export default class Cache extends Service {
     /**
-     * Enabled
+     * {@link BudCache.enabled}
      */
-    enabled = true;
+    enabled;
     /**
-     * Type
-     */
-    get name() {
-        return this.app.hooks.filter(`build.cache.name`, this.app.hooks.filter(`build.name`, join(`webpack`, this.app.mode)));
-    }
-    set name(name) {
-        this.app.hooks.on(`build.cache.name`, name);
-    }
-    /**
-     * Type
-     */
-    get type() {
-        return this.app.hooks.filter(`build.cache.type`, isString(this.app.context.cache)
-            ? this.app.context.cache
-            : `filesystem`);
-    }
-    set type(type) {
-        this.app.hooks.on(`build.cache.type`, type);
-    }
-    /**
-     * version
-     */
-    get version() {
-        const version = createHash(`sha1`);
-        version.update(hash);
-        Object.values(this.app.context.files ?? {})
-            .filter(file => file?.bud || file?.name?.includes(`package.json`))
-            .map(({ sha1 }) => version.update(sha1));
-        return this.app.hooks.filter(`build.cache.version`, version.digest(`base64`));
-    }
-    set version(version) {
-        this.app.hooks.on(`build.cache.version`, version);
-    }
-    /**
-     * Cache directory
+     * {@link Extension.boot}
      */
-    get cacheDirectory() {
-        return this.app.hooks.filter(`build.cache.cacheDirectory`, this.app.path(`@storage`, this.app.label, `cache`));
-    }
-    set cacheDirectory(directory) {
-        this.app.hooks.on(`build.cache.cacheDirectory`, directory);
+    async boot(bud) {
+        if (bud.context.force === true) {
+            await this.flush();
+        }
+        this.enabled = bud.context.cache !== false;
     }
     /**
-     * Cache dependencies
+     *{@link BudCache.buildDependencies}
      */
     get buildDependencies() {
         return this.app.hooks.filter(`build.cache.buildDependencies`, {
             bud: [
-                this.app.context.files?.[`package.json`]?.path,
+                this.app.context.files[`package`]?.path,
                 ...Object.values(this.app.context.files)
                     .filter(({ bud }) => bud)
                     .map(({ path }) => path),
@@ -74,7 +37,17 @@ export default class Cache extends Service {
         this.app.hooks.on(`build.cache.buildDependencies`, dependencies);
     }
     /**
-     * Webpack configuration
+     * {@link BudCache.cacheDirectory}
+     */
+    get cacheDirectory() {
+        return this.app.hooks.filter(`build.cache.cacheDirectory`, this.app.path(`@storage`, this.app.label, `cache`));
+    }
+    set cacheDirectory(directory) {
+        this.app.hooks.on(`build.cache.cacheDirectory`, directory);
+    }
+    /**
+     * {@link BudCache.configuration}
+     * @readonly
      */
     get configuration() {
         if (this.enabled !== true)
@@ -82,38 +55,63 @@ export default class Cache extends Service {
         if (this.type === `memory`)
             return true;
         return {
-            name: this.name,
-            type: this.type,
-            store: `pack`,
             allowCollectingMemory: true,
             buildDependencies: this.buildDependencies,
             cacheDirectory: this.cacheDirectory,
-            idleTimeout: 10000,
+            compression: this.app.isDevelopment ? false : `brotli`,
+            hashAlgorithm: `xxhash64`,
+            idleTimeout: 100,
             idleTimeoutForInitialStore: 0,
+            managedPaths: [this.cacheDirectory, this.app.path(`@modules`)],
+            name: this.name,
             profile: this.app.context.debug === true,
-            version: this.app.hooks.filter(`build.cache.version`, this.version),
+            store: `pack`,
+            type: this.type,
         };
     }
     /**
-     * {@link Extension.boot}
+     * {@link BudCache.flush}
      */
-    async boot(bud) {
-        await bud.extensions.add(InvalidateCacheExtension);
-        this.logger.success(`cache initialized`);
+    async flush() {
+        await this.app.fs.remove(this.cacheDirectory);
     }
     /**
-     * Flush cache
+     * {@link BudCache.name}
      */
-    async flush() {
-        await this.app.fs.remove(this.cacheDirectory);
+    get name() {
+        return this.app.hooks.filter(`build.cache.name`, this.app.hooks.filter(`build.name`, join(this.app.mode, ...Object.values(this.app.context._ ?? {}))));
+    }
+    set name(name) {
+        this.app.hooks.on(`build.cache.name`, name);
+    }
+    /**
+     * {@link BudCache.register}
+     */
+    async register(bud) {
+        this.enabled = bud.context.cache !== false;
+        this.version = bud.context.bud.version;
+    }
+    /**
+     * {@link BudCache.type}
+     */
+    get type() {
+        return this.app.hooks.filter(`build.cache.type`, isString(this.app.context.cache)
+            ? this.app.context.cache
+            : `filesystem`);
+    }
+    set type(type) {
+        this.app.hooks.on(`build.cache.type`, type);
+    }
+    /**
+     * {@link BudCache.version}
+     */
+    get version() {
+        return this.app.hooks.filter(`build.cache.version`, undefined);
+    }
+    set version(version) {
+        this.app.hooks.on(`build.cache.version`, version);
     }
 }
-__decorate([
-    bind,
-    __metadata("design:type", Function),
-    __metadata("design:paramtypes", [Function]),
-    __metadata("design:returntype", Promise)
-], Cache.prototype, "boot", null);
 __decorate([
     bind,
     __metadata("design:type", Function),

package/package.json

@@ -1,19 +1,19 @@
 {
   "name": "@roots/bud-cache",
-  "version": "6.13.0",
+  "version": "6.14.0",
   "description": "Config caching",
   "engines": {
     "node": ">=16"
   },
   "contributors": [
     {
-      "name": "Kelly Mears",
       "email": "developers@tinypixel.dev",
+      "name": "Kelly Mears",
       "url": "https://github.com/kellymears"
     },
     {
-      "name": "Ben Word",
       "email": "ben@benword.com",
+      "name": "Ben Word",
       "url": "https://github.com/retlehs"
     },
     {
@@ -21,8 +21,8 @@
       "url": "https://github.com/QWp6t"
     },
     {
-      "name": "Brandon",
       "email": "brandon@tendency.me",
+      "name": "Brandon",
       "url": "https://github.com/Log1x"
     }
   ],
@@ -85,10 +85,10 @@
     "@skypack/package-check": "0.2.2"
   },
   "dependencies": {
-    "@roots/bud-framework": "6.13.0",
-    "@roots/bud-support": "6.13.0",
-    "strip-ansi": "7.0.1",
-    "tslib": "2.5.0"
+    "@roots/bud-framework": "6.14.0",
+    "@roots/bud-support": "6.14.0",
+    "strip-ansi": "7.1.0",
+    "tslib": "2.6.0"
   },
   "volta": {
     "extends": "../../../package.json"

package/src/index.ts

@@ -2,14 +2,10 @@
 // Licensed under the MIT license.
 
 /**
- * Caching service
+ * @roots/bud-cache
  *
  * @see {@link https://bud.js.org}
  * @see {@link https://github.com/roots/bud}
  */
 
-import './types.js'
-
-import Cache from './service/index.js'
-
-export default Cache
+export {default} from './service/index.js'

package/src/service/index.ts

@@ -1,96 +1,39 @@
-import {createHash} from 'node:crypto'
+import type {Bud} from '@roots/bud-framework'
+import type {Configuration} from '@roots/bud-framework/config'
+import type {Cache as BudCache} from '@roots/bud-framework/services'
+
 import {join} from 'node:path'
 
-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/bind'
 import isString from '@roots/bud-support/lodash/isString'
-import {hash} from '@roots/bud-support/utilities/args'
-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
-
+export default class Cache extends Service implements BudCache {
   /**
-   * Type
+   * {@link BudCache.enabled}
    */
-  public get name(): string {
-    return this.app.hooks.filter(
-      `build.cache.name`,
-      this.app.hooks.filter(`build.name`, join(`webpack`, this.app.mode)),
-    )
-  }
-  public set name(name: string) {
-    this.app.hooks.on(`build.cache.name`, name)
-  }
+  public enabled: boolean
 
   /**
-   * Type
-   */
-  public get type(): 'memory' | 'filesystem' {
-    return this.app.hooks.filter(
-      `build.cache.type`,
-      isString(this.app.context.cache)
-        ? this.app.context.cache
-        : `filesystem`,
-    )
-  }
-  public set type(type: 'memory' | 'filesystem') {
-    this.app.hooks.on(`build.cache.type`, type)
-  }
-
-  /**
-   * version
-   */
-  public get version(): string {
-    const version = createHash(`sha1`)
-    version.update(hash)
-
-    Object.values(this.app.context.files ?? {})
-      .filter(file => file?.bud || file?.name?.includes(`package.json`))
-      .map(({sha1}) => version.update(sha1))
-
-    return this.app.hooks.filter(
-      `build.cache.version`,
-      version.digest(`base64`),
-    )
-  }
-  public set version(version: string) {
-    this.app.hooks.on(`build.cache.version`, version)
-  }
-
-  /**
-   * Cache directory
+   * {@link Extension.boot}
    */
-  public get cacheDirectory(): string {
-    return this.app.hooks.filter(
-      `build.cache.cacheDirectory`,
-      this.app.path(`@storage`, this.app.label, `cache`),
-    )
-  }
-  public set cacheDirectory(directory: string) {
-    this.app.hooks.on(`build.cache.cacheDirectory`, directory)
+  public override async boot?(bud: Bud) {
+    if (bud.context.force === true) {
+      await this.flush()
+    }
+    this.enabled = bud.context.cache !== false
   }
 
   /**
-   * Cache dependencies
+   *{@link BudCache.buildDependencies}
    */
   public get buildDependencies(): Record<string, Array<string>> {
     return this.app.hooks.filter(`build.cache.buildDependencies`, {
       bud: [
-        this.app.context.files?.[`package.json`]?.path,
+        this.app.context.files[`package`]?.path,
         ...Object.values(this.app.context.files)
           .filter(({bud}) => bud)
           .map(({path}) => path),
@@ -104,40 +47,96 @@ export default class Cache
   }
 
   /**
-   * Webpack configuration
+   * {@link BudCache.cacheDirectory}
+   */
+  public get cacheDirectory(): string {
+    return this.app.hooks.filter(
+      `build.cache.cacheDirectory`,
+      this.app.path(`@storage`, this.app.label, `cache`),
+    )
+  }
+  public set cacheDirectory(directory: string) {
+    this.app.hooks.on(`build.cache.cacheDirectory`, directory)
+  }
+
+  /**
+   * {@link BudCache.configuration}
+   * @readonly
    */
   public get configuration(): Configuration[`cache`] {
     if (this.enabled !== true) return false
     if (this.type === `memory`) return true
 
     return {
-      name: this.name,
-      type: this.type,
-      store: `pack` as `pack`,
       allowCollectingMemory: true,
       buildDependencies: this.buildDependencies,
       cacheDirectory: this.cacheDirectory,
-      idleTimeout: 10000,
+      compression: this.app.isDevelopment ? false : `brotli`,
+      hashAlgorithm: `xxhash64`,
+      idleTimeout: 100,
       idleTimeoutForInitialStore: 0,
+      managedPaths: [this.cacheDirectory, this.app.path(`@modules`)],
+      name: this.name,
       profile: this.app.context.debug === true,
-      version: this.app.hooks.filter(`build.cache.version`, this.version),
+      store: `pack`,
+      type: this.type,
     }
   }
 
   /**
-   * {@link Extension.boot}
+   * {@link BudCache.flush}
    */
   @bind
-  public override async boot(bud: Bud) {
-    await bud.extensions.add(InvalidateCacheExtension)
-    this.logger.success(`cache initialized`)
+  public async flush(): Promise<void> {
+    await this.app.fs.remove(this.cacheDirectory)
   }
 
   /**
-   * Flush cache
+   * {@link BudCache.name}
    */
-  @bind
-  public async flush(): Promise<void> {
-    await this.app.fs.remove(this.cacheDirectory)
+  public get name(): string {
+    return this.app.hooks.filter(
+      `build.cache.name`,
+      this.app.hooks.filter(
+        `build.name`,
+        join(this.app.mode, ...Object.values(this.app.context._ ?? {})),
+      ),
+    )
+  }
+  public set name(name: string) {
+    this.app.hooks.on(`build.cache.name`, name)
+  }
+
+  /**
+   * {@link BudCache.register}
+   */
+  public override async register?(bud: Bud) {
+    this.enabled = bud.context.cache !== false
+    this.version = bud.context.bud.version
+  }
+
+  /**
+   * {@link BudCache.type}
+   */
+  public get type(): 'filesystem' | 'memory' {
+    return this.app.hooks.filter(
+      `build.cache.type`,
+      isString(this.app.context.cache)
+        ? this.app.context.cache
+        : `filesystem`,
+    )
+  }
+  public set type(type: 'filesystem' | 'memory') {
+    this.app.hooks.on(`build.cache.type`, type)
+  }
+
+  /**
+   * {@link BudCache.version}
+   */
+  public get version(): string {
+    return this.app.hooks.filter(`build.cache.version`, undefined)
+  }
+  public set version(version: string) {
+    this.app.hooks.on(`build.cache.version`, version)
   }
 }

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

@@ -1,21 +0,0 @@
-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;
-    /**
-     * {@link Extension.register}
-     */
-    register(bud: Bud): Promise<void>;
-}

package/lib/invalidate-cache/index.js

@@ -1,58 +0,0 @@
-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`);
-    }
-    /**
-     * {@link Extension.register}
-     */
-    async register(bud) {
-        const invalidate = await bud.fs?.exists(this.invalidationFile);
-        if (invalidate || bud.context.force) {
-            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;

package/lib/types.d.ts

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

package/lib/types.js

@@ -1,4 +0,0 @@
-/**
- * @package @roots/bud-cache
- */
-export {};

package/src/invalidate-cache/index.ts

@@ -1,56 +0,0 @@
-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`)
-  }
-
-  /**
-   * {@link Extension.register}
-   */
-  @bind
-  public override async register(bud: Bud) {
-    const invalidate = await bud.fs?.exists(this.invalidationFile)
-
-    if (invalidate || bud.context.force) {
-      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/types.ts

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