@roots/bud-cache 2023.6.29-129 → 2023.7.5-148

package/lib/service/index.d.ts

@@ -7,20 +7,20 @@ import { Service } from '@roots/bud-framework/service';
  */
 export default class Cache extends Service implements BudCache {
     /**
-     * Enabled
+     * {@link BudCache.enabled}
      */
     enabled: boolean;
     /**
      * {@link Extension.boot}
      */
-    boot(bud: Bud): Promise<void>;
+    boot?(bud: Bud): Promise<void>;
     /**
      *{@link BudCache.buildDependencies}
      */
     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);
@@ -30,7 +30,7 @@ export default class Cache extends Service implements BudCache {
      */
     get configuration(): Configuration[`cache`];
     /**
-     * Flush cache
+     * {@link BudCache.flush}
      */
     flush(): Promise<void>;
     /**
@@ -38,14 +38,17 @@ export default class Cache extends Service implements BudCache {
      */
     get name(): string;
     set name(name: string);
-    register(bud: Bud): Promise<void>;
     /**
-     * Type
+     * {@link BudCache.register}
+     */
+    register?(bud: Bud): Promise<void>;
+    /**
+     * {@link BudCache.type}
      */
     get type(): 'filesystem' | 'memory';
     set type(type: 'filesystem' | 'memory');
     /**
-     * version
+     * {@link BudCache.version}
      */
     get version(): string;
     set version(version: string);

package/lib/service/index.js

@@ -1,14 +1,14 @@
 import { __decorate, __metadata } from "tslib";
+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 { join } from 'node:path';
 /**
  * Cache service class
  */
 export default class Cache extends Service {
     /**
-     * Enabled
+     * {@link BudCache.enabled}
      */
     enabled;
     /**
@@ -37,7 +37,7 @@ export default class Cache extends Service {
         this.app.hooks.on(`build.cache.buildDependencies`, dependencies);
     }
     /**
-     * Cache directory
+     * {@link BudCache.cacheDirectory}
      */
     get cacheDirectory() {
         return this.app.hooks.filter(`build.cache.cacheDirectory`, this.app.path(`@storage`, this.app.label, `cache`));
@@ -70,7 +70,7 @@ export default class Cache extends Service {
         };
     }
     /**
-     * Flush cache
+     * {@link BudCache.flush}
      */
     async flush() {
         await this.app.fs.remove(this.cacheDirectory);
@@ -84,12 +84,15 @@ export default class Cache extends Service {
     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;
     }
     /**
-     * Type
+     * {@link BudCache.type}
      */
     get type() {
         return this.app.hooks.filter(`build.cache.type`, isString(this.app.context.cache)
@@ -100,7 +103,7 @@ export default class Cache extends Service {
         this.app.hooks.on(`build.cache.type`, type);
     }
     /**
-     * version
+     * {@link BudCache.version}
      */
     get version() {
         return this.app.hooks.filter(`build.cache.version`, undefined);
@@ -109,21 +112,9 @@ export default class Cache extends Service {
         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),
     __metadata("design:paramtypes", []),
     __metadata("design:returntype", Promise)
 ], Cache.prototype, "flush", null);
-__decorate([
-    bind,
-    __metadata("design:type", Function),
-    __metadata("design:paramtypes", [Function]),
-    __metadata("design:returntype", Promise)
-], Cache.prototype, "register", null);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@roots/bud-cache",
-  "version": "2023.6.29-129",
+  "version": "2023.7.5-148",
   "description": "Config caching",
   "engines": {
     "node": ">=16"
@@ -85,10 +85,10 @@
     "@skypack/package-check": "0.2.2"
   },
   "dependencies": {
-    "@roots/bud-framework": "2023.6.29-129",
-    "@roots/bud-support": "2023.6.29-129",
+    "@roots/bud-framework": "2023.7.5-148",
+    "@roots/bud-support": "2023.7.5-148",
     "strip-ansi": "7.1.0",
-    "tslib": "2.5.3"
+    "tslib": "2.6.0"
   },
   "volta": {
     "extends": "../../../package.json"

package/src/service/index.ts

@@ -2,25 +2,25 @@ 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 {Service} from '@roots/bud-framework/service'
 import {bind} from '@roots/bud-support/decorators/bind'
 import isString from '@roots/bud-support/lodash/isString'
-import {join} from 'node:path'
 
 /**
  * Cache service class
  */
 export default class Cache extends Service implements BudCache {
   /**
-   * Enabled
+   * {@link BudCache.enabled}
    */
   public enabled: boolean
 
   /**
    * {@link Extension.boot}
    */
-  @bind
-  public override async boot(bud: Bud) {
+  public override async boot?(bud: Bud) {
     if (bud.context.force === true) {
       await this.flush()
     }
@@ -47,7 +47,7 @@ export default class Cache extends Service implements BudCache {
   }
 
   /**
-   * Cache directory
+   * {@link BudCache.cacheDirectory}
    */
   public get cacheDirectory(): string {
     return this.app.hooks.filter(
@@ -82,8 +82,9 @@ export default class Cache extends Service implements BudCache {
       type: this.type,
     }
   }
+
   /**
-   * Flush cache
+   * {@link BudCache.flush}
    */
   @bind
   public async flush(): Promise<void> {
@@ -106,14 +107,16 @@ export default class Cache extends Service implements BudCache {
     this.app.hooks.on(`build.cache.name`, name)
   }
 
-  @bind
-  public override async register(bud: Bud) {
+  /**
+   * {@link BudCache.register}
+   */
+  public override async register?(bud: Bud) {
     this.enabled = bud.context.cache !== false
     this.version = bud.context.bud.version
   }
 
   /**
-   * Type
+   * {@link BudCache.type}
    */
   public get type(): 'filesystem' | 'memory' {
     return this.app.hooks.filter(
@@ -128,7 +131,7 @@ export default class Cache extends Service implements BudCache {
   }
 
   /**
-   * version
+   * {@link BudCache.version}
    */
   public get version(): string {
     return this.app.hooks.filter(`build.cache.version`, undefined)