@roots/bud-cache 6.15.1 → 6.16.0

package/lib/helpers.d.ts

@@ -0,0 +1,2 @@
+import type { File } from '@roots/bud-framework/context';
+export declare const isBuildDependency: (file: File) => boolean;

package/lib/helpers.js

@@ -0,0 +1,9 @@
+export const isBuildDependency = (file) => [
+    `.npmrc`,
+    `.pnpmfile`,
+    `.yarnrc`,
+    `jsconfig`,
+    `package`,
+    `pnpm-workspace`,
+    `tsconfig`,
+].includes(file.name) || file.bud;

package/lib/service.d.ts

@@ -1,6 +1,6 @@
 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 type { Configuration, FileCacheOptions } from '@roots/bud-framework/config';
+import type { Cache as BudCache, CacheCallback as Callback } from '@roots/bud-framework/services/cache';
 import { Service } from '@roots/bud-framework/service';
 /**
  * {@link Bud.cache}
@@ -11,19 +11,39 @@ export default class Cache extends Service implements BudCache {
      */
     enabled: boolean;
     /**
-     * {@link Service.boot}
+     * {@link BudCache.allowCollectingMemory}
      */
-    boot?(bud: Bud): Promise<void>;
+    get allowCollectingMemory(): FileCacheOptions[`allowCollectingMemory`];
+    set allowCollectingMemory(value: Callback<FileCacheOptions[`allowCollectingMemory`]>);
     /**
      *{@link BudCache.buildDependencies}
      */
-    get buildDependencies(): Record<string, Array<string>>;
-    set buildDependencies(dependencies: Record<string, Array<string>>);
+    get buildDependencies(): FileCacheOptions[`buildDependencies`];
+    set buildDependencies(dependencies: Callback<FileCacheOptions[`buildDependencies`]>);
     /**
      * {@link BudCache.cacheDirectory}
      */
     get cacheDirectory(): string;
-    set cacheDirectory(directory: string);
+    set cacheDirectory(directory: Callback<FileCacheOptions[`cacheDirectory`]>);
+    /**
+     * {@link BudCache.name}
+     */
+    get name(): string;
+    set name(name: string);
+    /**
+     * {@link BudCache.type}
+     */
+    get type(): 'filesystem' | 'memory';
+    set type(type: Callback<FileCacheOptions[`type`]>);
+    /**
+     * {@link BudCache.version}
+     */
+    get version(): string | undefined;
+    set version(version: string);
+    /**
+     * {@link Service.boot}
+     */
+    boot?(bud: Bud): Promise<void>;
     /**
      * {@link BudCache.configuration}
      * @readonly
@@ -34,22 +54,41 @@ export default class Cache extends Service implements BudCache {
      */
     flush(): Promise<void>;
     /**
-     * {@link BudCache.name}
+     * Get {@link BudCache.allowCollectingMemory}
      */
-    get name(): string;
-    set name(name: string);
+    getAllowCollectingMemory(): boolean | undefined;
+    /**
+     * Get {@link BudCache.buildDependencies}
+     */
+    getBuildDependencies(): {
+        [index: string]: string[];
+    } | undefined;
+    /**
+     * Get {@link BudCache.cacheDirectory}
+     */
+    getCacheDirectory(): string;
+    /**
+     * Get {@link BudCache.type}
+     */
+    getType(): "filesystem" | "memory";
     /**
      * {@link BudCache.register}
      */
     register?(bud: Bud): Promise<void>;
     /**
-     * {@link BudCache.type}
+     * Set {@link BudCache.allowCollectingMemory}
      */
-    get type(): 'filesystem' | 'memory';
-    set type(type: 'filesystem' | 'memory');
+    setAllowCollectingMemory(value: Callback<FileCacheOptions[`allowCollectingMemory`]>): this;
     /**
-     * {@link BudCache.version}
+     * Set {@link BudCache.buildDependencies}
      */
-    get version(): string | undefined;
-    set version(version: string);
+    setBuildDependencies(dependencies: ((records?: Record<string, Array<string>>) => Record<string, Array<string>>) | Record<string, Array<string>>): this;
+    /**
+     * Set {@link BudCache.cacheDirectory}
+     */
+    setCacheDirectory(directory: Callback<FileCacheOptions[`cacheDirectory`]>): this;
+    /**
+     * Set {@link BudCache.type}
+     */
+    setType(type: Callback<FileCacheOptions[`type`]>): this;
 }

package/lib/service.js

@@ -1,5 +1,6 @@
 import { __decorate } from "tslib";
 import { join } from 'node:path';
+import { isBuildDependency } from '@roots/bud-cache/helpers';
 import { Service } from '@roots/bud-framework/service';
 import { bind } from '@roots/bud-support/decorators/bind';
 import isString from '@roots/bud-support/lodash/isString';
@@ -8,27 +9,31 @@ import isString from '@roots/bud-support/lodash/isString';
  */
 export default class Cache extends Service {
     /**
-     * {@link Service.boot}
+     * {@link BudCache.allowCollectingMemory}
      */
-    async boot(bud) {
-        if (bud.context.force === true) {
-            await this.flush();
-        }
-        this.enabled = bud.context.cache !== false;
+    get allowCollectingMemory() {
+        const fallback = true;
+        const value = this.app.hooks.filter(`build.cache.allowCollectingMemory`, fallback);
+        return typeof value === `boolean` ? value : fallback;
+    }
+    set allowCollectingMemory(value) {
+        this.app.hooks.on(`build.cache.allowCollectingMemory`, value);
     }
     /**
      *{@link BudCache.buildDependencies}
      */
     get buildDependencies() {
-        const baseDependencies = {
-            bud: [
-                this.app.context.files[`package`]?.path,
-                ...Object.values(this.app.context.files)
-                    .filter(({ bud }) => bud)
-                    .map(({ path }) => path),
-            ].filter(Boolean),
+        const dependencies = new Set([
+            this.app.context.files[`package`]?.path,
+            ...Object.values(this.app.context.files)
+                .filter(isBuildDependency)
+                .map(({ path }) => path),
+        ].filter(Boolean));
+        const records = {
+            bud: [...dependencies],
         };
-        return (this.app.hooks.filter(`build.cache.buildDependencies`, baseDependencies) ?? baseDependencies);
+        return (this.app.hooks.filter(`build.cache.buildDependencies`, records) ??
+            records);
     }
     set buildDependencies(dependencies) {
         this.app.hooks.on(`build.cache.buildDependencies`, dependencies);
@@ -37,11 +42,53 @@ export default class Cache extends Service {
      * {@link BudCache.cacheDirectory}
      */
     get cacheDirectory() {
-        return (this.app.hooks.filter(`build.cache.cacheDirectory`, this.app.path(`@storage`, this.app.label, `cache`)) ?? this.app.path(`@storage`, this.app.label, `cache`));
+        const fallback = this.app.path(`@storage`, this.app.label, `cache`);
+        return (this.app.hooks.filter(`build.cache.cacheDirectory`, fallback) ??
+            fallback);
     }
     set cacheDirectory(directory) {
         this.app.hooks.on(`build.cache.cacheDirectory`, directory);
     }
+    /**
+     * {@link BudCache.name}
+     */
+    get name() {
+        const fallback = join(this.app.mode, ...Object.values(this.app.context._ ?? {}));
+        return (this.app.hooks.filter(`build.cache.name`, this.app.hooks.filter(`build.name`, fallback)) ?? fallback);
+    }
+    set name(name) {
+        this.app.hooks.on(`build.cache.name`, name);
+    }
+    /**
+     * {@link BudCache.type}
+     */
+    get type() {
+        const fallback = isString(this.app.context.cache)
+            ? this.app.context.cache
+            : `filesystem`;
+        return this.app.hooks.filter(`build.cache.type`) ?? fallback;
+    }
+    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);
+    }
+    /**
+     * {@link Service.boot}
+     */
+    async boot(bud) {
+        if (bud.context.force === true) {
+            await this.flush();
+        }
+        this.enabled = bud.context.cache !== false;
+    }
     /**
      * {@link BudCache.configuration}
      * @readonly
@@ -52,7 +99,7 @@ export default class Cache extends Service {
         if (this.type === `memory`)
             return true;
         return {
-            allowCollectingMemory: true,
+            allowCollectingMemory: this.allowCollectingMemory,
             buildDependencies: this.buildDependencies,
             cacheDirectory: this.cacheDirectory,
             compression: this.app.isDevelopment ? false : `brotli`,
@@ -73,13 +120,28 @@ export default class Cache extends Service {
         await this.app.fs.remove(this.cacheDirectory);
     }
     /**
-     * {@link BudCache.name}
+     * Get {@link BudCache.allowCollectingMemory}
      */
-    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._ ?? {})))) ?? join(this.app.mode, ...Object.values(this.app.context._ ?? {})));
+    getAllowCollectingMemory() {
+        return this.allowCollectingMemory;
     }
-    set name(name) {
-        this.app.hooks.on(`build.cache.name`, name);
+    /**
+     * Get {@link BudCache.buildDependencies}
+     */
+    getBuildDependencies() {
+        return this.buildDependencies;
+    }
+    /**
+     * Get {@link BudCache.cacheDirectory}
+     */
+    getCacheDirectory() {
+        return this.cacheDirectory;
+    }
+    /**
+     * Get {@link BudCache.type}
+     */
+    getType() {
+        return this.type;
     }
     /**
      * {@link BudCache.register}
@@ -89,24 +151,32 @@ export default class Cache extends Service {
         this.version = bud.context.bud.version;
     }
     /**
-     * {@link BudCache.type}
+     * Set {@link BudCache.allowCollectingMemory}
      */
-    get type() {
-        return (this.app.hooks.filter(`build.cache.type`, isString(this.app.context.cache)
-            ? this.app.context.cache
-            : `filesystem`) ?? `filesystem`);
+    setAllowCollectingMemory(value) {
+        this.allowCollectingMemory = value;
+        return this;
     }
-    set type(type) {
-        this.app.hooks.on(`build.cache.type`, type);
+    /**
+     * Set {@link BudCache.buildDependencies}
+     */
+    setBuildDependencies(dependencies) {
+        this.buildDependencies = dependencies;
+        return this;
     }
     /**
-     * {@link BudCache.version}
+     * Set {@link BudCache.cacheDirectory}
      */
-    get version() {
-        return this.app.hooks.filter(`build.cache.version`, undefined);
+    setCacheDirectory(directory) {
+        this.cacheDirectory = directory;
+        return this;
     }
-    set version(version) {
-        this.app.hooks.on(`build.cache.version`, version);
+    /**
+     * Set {@link BudCache.type}
+     */
+    setType(type) {
+        this.type = type;
+        return this;
     }
 }
 __decorate([

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@roots/bud-cache",
-  "version": "6.15.1",
+  "version": "6.16.0",
   "description": "Config caching",
   "engines": {
     "node": ">=16"
@@ -50,6 +50,7 @@
   "type": "module",
   "exports": {
     ".": "./lib/index.js",
+    "./helpers": "./lib/helpers.js",
     "./service": "./lib/service.js"
   },
   "typesVersions": {
@@ -57,6 +58,9 @@
       ".": [
         "./lib/index.d.ts"
       ],
+      "./helpers": [
+        "./lib/helpers.d.ts"
+      ],
       "service": [
         "./lib/service.d.ts"
       ]
@@ -68,10 +72,10 @@
     "@skypack/package-check": "0.2.2"
   },
   "dependencies": {
-    "@roots/bud-framework": "6.15.1",
-    "@roots/bud-support": "6.15.1",
+    "@roots/bud-framework": "6.16.0",
+    "@roots/bud-support": "6.16.0",
     "strip-ansi": "7.1.0",
-    "tslib": "2.6.1"
+    "tslib": "2.6.2"
   },
   "volta": {
     "extends": "../../../package.json"

package/src/helpers.ts

@@ -0,0 +1,12 @@
+import type {File} from '@roots/bud-framework/context'
+
+export const isBuildDependency = (file: File): boolean =>
+  [
+    `.npmrc`,
+    `.pnpmfile`,
+    `.yarnrc`,
+    `jsconfig`,
+    `package`,
+    `pnpm-workspace`,
+    `tsconfig`,
+  ].includes(file.name) || file.bud

package/src/service.ts

@@ -1,9 +1,16 @@
 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 type {
+  Configuration,
+  FileCacheOptions,
+} from '@roots/bud-framework/config'
+import type {
+  Cache as BudCache,
+  CacheCallback as Callback,
+} from '@roots/bud-framework/services/cache'
 
 import {join} from 'node:path'
 
+import {isBuildDependency} from '@roots/bud-cache/helpers'
 import {Service} from '@roots/bud-framework/service'
 import {bind} from '@roots/bud-support/decorators/bind'
 import isString from '@roots/bud-support/lodash/isString'
@@ -16,39 +23,47 @@ export default class Cache extends Service implements BudCache {
    * {@link BudCache.enabled}
    */
   public declare enabled: boolean
-
   /**
-   * {@link Service.boot}
+   * {@link BudCache.allowCollectingMemory}
    */
-  public override async boot?(bud: Bud) {
-    if (bud.context.force === true) {
-      await this.flush()
-    }
-    this.enabled = bud.context.cache !== false
+  public get allowCollectingMemory(): FileCacheOptions[`allowCollectingMemory`] {
+    const fallback = true
+
+    const value = this.app.hooks.filter(
+      `build.cache.allowCollectingMemory`,
+      fallback,
+    )
+    return typeof value === `boolean` ? value : fallback
+  }
+  public set allowCollectingMemory(
+    value: Callback<FileCacheOptions[`allowCollectingMemory`]>,
+  ) {
+    this.app.hooks.on(`build.cache.allowCollectingMemory`, value)
   }
 
   /**
    *{@link BudCache.buildDependencies}
    */
-  public get buildDependencies(): Record<string, Array<string>> {
-    const baseDependencies = {
-      bud: [
+  public get buildDependencies(): FileCacheOptions[`buildDependencies`] {
+    const dependencies = new Set(
+      [
         this.app.context.files[`package`]?.path,
         ...Object.values(this.app.context.files)
-          .filter(({bud}) => bud)
+          .filter(isBuildDependency)
           .map(({path}) => path),
       ].filter(Boolean),
+    )
+    const records = {
+      bud: [...dependencies],
     }
 
     return (
-      this.app.hooks.filter(
-        `build.cache.buildDependencies`,
-        baseDependencies,
-      ) ?? baseDependencies
+      this.app.hooks.filter(`build.cache.buildDependencies`, records) ??
+      records
     )
   }
   public set buildDependencies(
-    dependencies: Record<string, Array<string>>,
+    dependencies: Callback<FileCacheOptions[`buildDependencies`]>,
   ) {
     this.app.hooks.on(`build.cache.buildDependencies`, dependencies)
   }
@@ -57,17 +72,71 @@ export default class Cache extends Service implements BudCache {
    * {@link BudCache.cacheDirectory}
    */
   public get cacheDirectory(): string {
+    const fallback = this.app.path(`@storage`, this.app.label, `cache`)
     return (
-      this.app.hooks.filter(
-        `build.cache.cacheDirectory`,
-        this.app.path(`@storage`, this.app.label, `cache`),
-      ) ?? this.app.path(`@storage`, this.app.label, `cache`)
+      this.app.hooks.filter(`build.cache.cacheDirectory`, fallback) ??
+      fallback
     )
   }
-  public set cacheDirectory(directory: string) {
+  public set cacheDirectory(
+    directory: Callback<FileCacheOptions[`cacheDirectory`]>,
+  ) {
     this.app.hooks.on(`build.cache.cacheDirectory`, directory)
   }
 
+  /**
+   * {@link BudCache.name}
+   */
+  public get name(): string {
+    const fallback = join(
+      this.app.mode,
+      ...Object.values(this.app.context._ ?? {}),
+    )
+    return (
+      this.app.hooks.filter(
+        `build.cache.name`,
+        this.app.hooks.filter(`build.name`, fallback),
+      ) ?? fallback
+    )
+  }
+  public set name(name: string) {
+    this.app.hooks.on(`build.cache.name`, name)
+  }
+
+  /**
+   * {@link BudCache.type}
+   */
+  public get type(): 'filesystem' | 'memory' {
+    const fallback = isString(this.app.context.cache)
+      ? this.app.context.cache
+      : `filesystem`
+
+    return this.app.hooks.filter(`build.cache.type`) ?? fallback
+  }
+  public set type(type: Callback<FileCacheOptions[`type`]>) {
+    this.app.hooks.on(`build.cache.type`, type)
+  }
+
+  /**
+   * {@link BudCache.version}
+   */
+  public get version(): string | undefined {
+    return this.app.hooks.filter(`build.cache.version`, undefined)
+  }
+  public set version(version: string) {
+    this.app.hooks.on(`build.cache.version`, version)
+  }
+
+  /**
+   * {@link Service.boot}
+   */
+  public override async boot?(bud: Bud) {
+    if (bud.context.force === true) {
+      await this.flush()
+    }
+    this.enabled = bud.context.cache !== false
+  }
+
   /**
    * {@link BudCache.configuration}
    * @readonly
@@ -77,7 +146,7 @@ export default class Cache extends Service implements BudCache {
     if (this.type === `memory`) return true
 
     return {
-      allowCollectingMemory: true,
+      allowCollectingMemory: this.allowCollectingMemory,
       buildDependencies: this.buildDependencies,
       cacheDirectory: this.cacheDirectory,
       compression: this.app.isDevelopment ? false : `brotli`,
@@ -91,7 +160,6 @@ export default class Cache extends Service implements BudCache {
       type: this.type,
     }
   }
-
   /**
    * {@link BudCache.flush}
    */
@@ -101,21 +169,29 @@ export default class Cache extends Service implements BudCache {
   }
 
   /**
-   * {@link BudCache.name}
+   * Get {@link BudCache.allowCollectingMemory}
    */
-  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._ ?? {})),
-        ),
-      ) ?? join(this.app.mode, ...Object.values(this.app.context._ ?? {}))
-    )
+  public getAllowCollectingMemory() {
+    return this.allowCollectingMemory
   }
-  public set name(name: string) {
-    this.app.hooks.on(`build.cache.name`, name)
+  /**
+   * Get {@link BudCache.buildDependencies}
+   */
+  public getBuildDependencies() {
+    return this.buildDependencies
+  }
+
+  /**
+   * Get {@link BudCache.cacheDirectory}
+   */
+  public getCacheDirectory() {
+    return this.cacheDirectory
+  }
+  /**
+   * Get {@link BudCache.type}
+   */
+  public getType() {
+    return this.type
   }
 
   /**
@@ -125,31 +201,45 @@ export default class Cache extends Service implements BudCache {
     this.enabled = bud.context.cache !== false
     this.version = bud.context.bud.version
   }
-
   /**
-   * {@link BudCache.type}
+   * Set {@link BudCache.allowCollectingMemory}
    */
-  public get type(): 'filesystem' | 'memory' {
-    return (
-      this.app.hooks.filter(
-        `build.cache.type`,
-        isString(this.app.context.cache)
-          ? this.app.context.cache
-          : `filesystem`,
-      ) ?? `filesystem`
-    )
+  public setAllowCollectingMemory(
+    value: Callback<FileCacheOptions[`allowCollectingMemory`]>,
+  ): this {
+    this.allowCollectingMemory = value
+    return this
   }
-  public set type(type: 'filesystem' | 'memory') {
-    this.app.hooks.on(`build.cache.type`, type)
+
+  /**
+   * Set {@link BudCache.buildDependencies}
+   */
+  public setBuildDependencies(
+    dependencies:
+      | ((
+          records?: Record<string, Array<string>>,
+        ) => Record<string, Array<string>>)
+      | Record<string, Array<string>>,
+  ) {
+    this.buildDependencies = dependencies
+    return this
   }
 
   /**
-   * {@link BudCache.version}
+   * Set {@link BudCache.cacheDirectory}
    */
-  public get version(): string | undefined {
-    return this.app.hooks.filter(`build.cache.version`, undefined)
+  public setCacheDirectory(
+    directory: Callback<FileCacheOptions[`cacheDirectory`]>,
+  ) {
+    this.cacheDirectory = directory
+    return this
   }
-  public set version(version: string) {
-    this.app.hooks.on(`build.cache.version`, version)
+
+  /**
+   * Set {@link BudCache.type}
+   */
+  public setType(type: Callback<FileCacheOptions[`type`]>) {
+    this.type = type
+    return this
   }
 }