@roots/bud-cache 5.0.0-next.6 → 5.0.0

package/README.md

@@ -1,41 +1,25 @@
 <p align="center">
-  <img alt="Bud" src="https://cdn.roots.io/app/uploads/logo-bud.svg" height="100" />
+  <img src="https://cdn.roots.io/app/uploads/logo-bud.svg" height="100" alt="Bud" />
 </p>
 
 <p align="center">
-  <img
-    alt="MIT License"
-    src="https://img.shields.io/github/license/roots/bud?color=%23525ddc&style=flat-square"
-  />
-  <a href="https://app.fossa.com/projects/git%2Bgithub.com%2Froots%2Fbud?ref=badge_small" alt="FOSSA Status">
-    <img src="https://app.fossa.com/api/projects/git%2Bgithub.com%2Froots%2Fbud.svg?type=small"/>
-  </a>
-  <a href="https://www.npmjs.com/package/@roots/bud">
-    <img src="https://img.shields.io/npm/v/@roots/bud.svg?color=%23525ddc&style=flat-square" />
-  </a>
-  <a href="https://codecov.io/gh/roots/bud">
-    <img src="https://codecov.io/gh/roots/bud/branch/next/graph/badge.svg?token=DRJ28OD8XD"/>
-  </a>
-  <a href="https://twitter.com/rootswp">
-    <img
-      alt="Follow Roots"
-      src="https://img.shields.io/twitter/follow/rootswp.svg?color=%23525ddc&style=flat-square"
-    />
-  </a>
+  <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>
 
-> Config caching
+<p align="center">
+  Config caching
+</p>
+
 ## Installation
 
 Install **@roots/bud-cache** to your project.
 
 ```shell
-yarn add @roots/bud-cache
+yarn add @roots/bud-cache --dev
 ```
 
 ## Documentation
@@ -67,8 +51,4 @@ Help support our open-source development efforts by [becoming a patron](https://
 <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://www.c21redwood.com/"><img src="https://cdn.roots.io/app/uploads/c21redwood.svg" alt="C21 Redwood Realty" 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://icons8.com/"><img src="https://cdn.roots.io/app/uploads/icons8.svg" alt="Icons8" width="200" height="150"/></a>
-<a href="https://www.harnessup.com/"><img src="https://cdn.roots.io/app/uploads/harness-software.svg" alt="Harness Software" width="200" height="150"/></a>
-<a href="https://www.codersclan.com/"><img src="https://cdn.roots.io/app/uploads/coders-clan.svg" alt="Coders Clan" width="200" height="150"/></a>
-<a href="https://generodigital.com/"><img src="https://cdn.roots.io/app/uploads/genero.svg" alt="Genero" width="200" height="150"/></a>
-<a href="https://motto.ca/roots"><img src="https://cdn.roots.io/app/uploads/motto.svg" alt="Motto" 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>

package/lib/cjs/Cache/cache.dependencies.js

@@ -1,13 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.readFileSync = exports.createHash = exports.globby = exports.bind = exports.Bud = void 0;
+exports.Bud = exports.writeFile = exports.writeJson = exports.remove = exports.readJson = exports.readFile = exports.ensureFile = exports.createHash = exports.globby = exports.bind = void 0;
 const tslib_1 = require("tslib");
-exports.Bud = (0, tslib_1.__importStar)(require("@roots/bud-framework"));
+const Bud = (0, tslib_1.__importStar)(require("@roots/bud-framework"));
+exports.Bud = Bud;
 var bud_support_1 = require("@roots/bud-support");
 Object.defineProperty(exports, "bind", { enumerable: true, get: function () { return bud_support_1.bind; } });
 Object.defineProperty(exports, "globby", { enumerable: true, get: function () { return bud_support_1.globby; } });
 var crypto_1 = require("crypto");
 Object.defineProperty(exports, "createHash", { enumerable: true, get: function () { return crypto_1.createHash; } });
 const bud_support_2 = require("@roots/bud-support");
-exports.readFileSync = bud_support_2.fs.readFileSync;
+exports.ensureFile = bud_support_2.fs.ensureFile, exports.readFile = bud_support_2.fs.readFile, exports.readJson = bud_support_2.fs.readJson, exports.remove = bud_support_2.fs.remove, exports.writeJson = bud_support_2.fs.writeJson, exports.writeFile = bud_support_2.fs.writeFile;
 //# sourceMappingURL=cache.dependencies.js.map

package/lib/cjs/Cache/cache.dependencies.js.map

@@ -1 +1 @@
-{"version":3,"file":"cache.dependencies.js","sourceRoot":"","sources":["../../../src/Cache/cache.dependencies.ts"],"names":[],"mappings":";;;;AAAA,yEAA2C;AAC3C,kDAA+C;AAAvC,mGAAA,IAAI,OAAA;AAAE,qGAAA,MAAM,OAAA;AACpB,iCAAiC;AAAzB,oGAAA,UAAU,OAAA;AAElB,oDAAqC;AACvB,oBAAY,GAAI,gBAAE,cAAA"}
+{"version":3,"file":"cache.dependencies.js","sourceRoot":"","sources":["../../../src/Cache/cache.dependencies.ts"],"names":[],"mappings":";;;;AAAA,uEAA2C;AAanC,kBAAG;AAZX,kDAA+C;AAAvC,mGAAA,IAAI,OAAA;AAAE,qGAAA,MAAM,OAAA;AACpB,iCAAiC;AAAzB,oGAAA,UAAU,OAAA;AAElB,oDAAqC;AAEnC,kBAAU,GAMR,gBAAE,aALJ,gBAAQ,GAKN,gBAAE,WAJJ,gBAAQ,GAIN,gBAAE,WAHJ,cAAM,GAGJ,gBAAE,SAFJ,iBAAS,GAEP,gBAAE,YADJ,iBAAS,GACP,gBAAE,WAAA"}

package/lib/cjs/Cache/index.js

@@ -2,108 +2,104 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Cache = void 0;
 const tslib_1 = require("tslib");
+const fs_extra_1 = require("fs-extra");
+const helpful_decorators_1 = require("helpful-decorators");
+const lodash_1 = require("lodash");
 const cache_dependencies_1 = require("./cache.dependencies");
 /**
  * Cache service class
  *
- * @remarks
- * Interfaces with:
- *
- *  - {@link @roots/bud-framework#Project} to determine project dependencies for snapshotting/validation.
- *
- *  - {@link @roots/bud-framework#Build} via {@link @roots/bud-framework#Hooks} to update config.
- *
- * Facades:
- *
- *  - {@link @roots/bud-framework#Api} can toggle cache settings with {@link Bud.Persist}
- *
  * @public
  */
 class Cache extends cache_dependencies_1.Bud.Cache.Abstract {
     /**
-     * Service register event
+     * True if cache is enabled
      *
-     * @decorator `@bind`
+     * @public
      */
-    register(app) {
-        app.hooks
-            .on('build/cache', () => ({
-            type: app.hooks.filter('build/cache/type'),
-        }))
-            .hooks.on('build/cache/type', () => 'memory');
+    get enabled() {
+        this.log('info', {
+            message: `cache feature flag: ${this.app.store.get('features.cache')}`,
+        });
+        this.log('info', {
+            message: `--cache flag: ${this.app.store.get('cli.flags.cache')}`,
+        });
+        return this.app.store.get('features.cache') ? true : false;
     }
     /**
-     * Returns sha1 hash as a version string
+     * Type
      *
-     * @decorator `@bind`
+     * @public
      */
-    version() {
-        return (0, cache_dependencies_1.createHash)('sha1')
-            .update(this.hash())
-            .digest('base64')
-            .replace(/[^a-z0-9]/gi, '_')
-            .toLowerCase();
+    get type() {
+        const flags = this.app.store.get('cli.flags');
+        const cache = this.app.store.get('cache');
+        if (!(0, lodash_1.isUndefined)(flags['cache.type'])) {
+            this.log('log', {
+                message: '--cache.type flag',
+                suffix: flags['cache.type'],
+            });
+            return flags['cache.type'];
+        }
+        if (!(0, lodash_1.isUndefined)(cache.type)) {
+            this.log('log', {
+                message: 'bud.store',
+                suffix: cache.type,
+            });
+            return cache.type;
+        }
+        this.log('warn', 'no cache setting was passed from cli flags or from settings');
+        return false;
     }
     /**
-     * Returns cache storage directory
-     *
-     * @decorator `@bind`
+     * @public
      */
-    directory() {
-        return this.app.path('storage', 'cache');
+    boot() {
+        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+            this.version = yield this.hashFileContents();
+            if (this.enabled) {
+                this.app.api.call('persist', this.type);
+            }
+        });
     }
     /**
-     * Returns array of build dependency paths
-     *
-     * @remarks
-     * @see https://webpack.js.org/configuration/cache/#cachebuilddependencies
-     *
-     * @decorator `@bind`
+     * @public
      */
-    buildDependencies() {
-        return [
-            ...new Set(cache_dependencies_1.globby.globbySync([
-                this.app.path('project', `${this.app.name}.config.{js,ts,yml,json}`),
-                this.app.path('project', `${this.app.name}.${this.app.mode}.config.{js,ts.yml,json}`),
-                ...this.getFrameworkEntrypoints(),
-                this.app.path('storage', 'cache', '**', '*'),
-            ])),
-        ];
-    }
-    /**
-     * Cache location: framework entrypoints
-     *
-     * @see https://webpack.js.org/configuration/resolve
-     */
-    getFrameworkEntrypoints() {
-        var _a, _b, _c;
-        const project = (_a = this.app.project) !== null && _a !== void 0 ? _a : this.app.parent.project;
-        return ((_c = (_b = project.resolveFrom) === null || _b === void 0 ? void 0 : _b.map(dep => `${dep}/lib/cjs/index.js`)) !== null && _c !== void 0 ? _c : []);
-    }
-    /**
-     * Returns hash of all build dependencies and parsed CLI arguments
-     *
-     * @decorator `@bind`
-     */
-    hash() {
-        var _a;
-        return JSON.stringify((_a = this.buildDependencies().reduce((all, file) => all.concat((0, cache_dependencies_1.readFileSync)(file, 'utf8')), process.argv.slice(3).join(''))) !== null && _a !== void 0 ? _a : '{}');
+    hashFileContents() {
+        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+            const makeHash = (str) => (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+                return (0, cache_dependencies_1.createHash)('sha1')
+                    .update(str)
+                    .digest('base64')
+                    .replace(/[^a-z0-9]/gi, '_')
+                    .toLowerCase();
+            });
+            try {
+                const paths = this.app.project.get('dependencies');
+                const strings = yield Promise.all(paths.map((path) => (0, tslib_1.__awaiter)(this, void 0, void 0, function* () { return (0, fs_extra_1.readFile)(path, 'utf8'); })));
+                const hash = yield makeHash(`${strings}${JSON.stringify(this.app.project.get('cli'))}`);
+                this.log('info', {
+                    message: 'cache hash generated',
+                    suffix: hash,
+                });
+                this.app.hooks.async('event.project.write', (project) => (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+                    project.set('cache.hash', hash);
+                    return project;
+                }));
+                return hash;
+            }
+            catch (e) {
+                this.app.error('error hashing file contents for cache');
+                throw new Error(e);
+            }
+        });
     }
 }
 (0, tslib_1.__decorate)([
-    cache_dependencies_1.bind
-], Cache.prototype, "register", null);
-(0, tslib_1.__decorate)([
-    cache_dependencies_1.bind
-], Cache.prototype, "version", null);
-(0, tslib_1.__decorate)([
-    cache_dependencies_1.bind
-], Cache.prototype, "directory", null);
-(0, tslib_1.__decorate)([
-    cache_dependencies_1.bind
-], Cache.prototype, "buildDependencies", null);
+    helpful_decorators_1.bind
+], Cache.prototype, "boot", null);
 (0, tslib_1.__decorate)([
-    cache_dependencies_1.bind
-], Cache.prototype, "hash", null);
+    helpful_decorators_1.bind
+], Cache.prototype, "hashFileContents", null);
 exports.Cache = Cache;
 //# sourceMappingURL=index.js.map

package/lib/cjs/Cache/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Cache/index.ts"],"names":[],"mappings":";;;;AAEA,6DAM6B;AAE7B;;;;;;;;;;;;;;;GAeG;AACH,MAAa,KACX,SAAQ,wBAAG,CAAC,KAAK,CAAC,QAAQ;IAG1B;;;;OAIG;IAEI,QAAQ,CAAC,GAAc;QAC5B,GAAG,CAAC,KAAK;aACN,EAAE,CAAC,aAAa,EAAE,GAAG,EAAE,CAAC,CAAC;YACxB,IAAI,EAAE,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,kBAAkB,CAAC;SAC3C,CAAC,CAAC;aACF,KAAK,CAAC,EAAE,CAAC,kBAAkB,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,CAAA;IACjD,CAAC;IAED;;;;OAIG;IAEI,OAAO;QACZ,OAAO,IAAA,+BAAU,EAAC,MAAM,CAAC;aACtB,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;aACnB,MAAM,CAAC,QAAQ,CAAC;aAChB,OAAO,CAAC,aAAa,EAAE,GAAG,CAAC;aAC3B,WAAW,EAAE,CAAA;IAClB,CAAC;IAED;;;;OAIG;IAEI,SAAS;QACd,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAA;IAC1C,CAAC;IAED;;;;;;;OAOG;IAEI,iBAAiB;QACtB,OAAO;YACL,GAAG,IAAI,GAAG,CACR,2BAAM,CAAC,UAAU,CAAC;gBAChB,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,SAAS,EACT,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,0BAA0B,CAC3C;gBAED,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,SAAS,EACT,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,0BAA0B,CAC5D;gBAED,GAAG,IAAI,CAAC,uBAAuB,EAAE;gBAEjC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,CAAC;aAC7C,CAAC,CACH;SACU,CAAA;IACf,CAAC;IAED;;;;OAIG;IACI,uBAAuB;;QAC5B,MAAM,OAAO,GAAG,MAAA,IAAI,CAAC,GAAG,CAAC,OAAO,mCAAI,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAA;QAE3D,OAAO,CACL,MAAA,MAAA,OAAO,CAAC,WAAW,0CAAE,GAAG,CACtB,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,mBAAmB,CACjC,mCAAI,EAAE,CACR,CAAA;IACH,CAAC;IAED;;;;OAIG;IAEI,IAAI;;QACT,OAAO,IAAI,CAAC,SAAS,CACnB,MAAA,IAAI,CAAC,iBAAiB,EAAE,CAAC,MAAM,CAC7B,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,IAAA,iCAAY,EAAC,IAAI,EAAE,MAAM,CAAC,CAAC,EACrD,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAC/B,mCAAI,IAAI,CACV,CAAA;IACH,CAAC;CACF;AA5FC;IADC,yBAAI;qCAOJ;AAQD;IADC,yBAAI;oCAOJ;AAQD;IADC,yBAAI;sCAGJ;AAWD;IADC,yBAAI;8CAqBJ;AAuBD;IADC,yBAAI;iCAQJ;AArGH,sBAsGC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Cache/index.ts"],"names":[],"mappings":";;;;AAAA,uCAAiC;AACjC,2DAAuC;AACvC,mCAAkC;AAElC,6DAAoD;AAEpD;;;;GAIG;AACH,MAAa,KACX,SAAQ,wBAAG,CAAC,KAAK,CAAC,QAAQ;IAG1B;;;;OAIG;IACH,IAAW,OAAO;QAChB,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE;YACf,OAAO,EAAE,uBAAuB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAChD,gBAAgB,CACjB,EAAE;SACJ,CAAC,CAAA;QAEF,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE;YACf,OAAO,EAAE,iBAAiB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAC1C,iBAAiB,CAClB,EAAE;SACJ,CAAC,CAAA;QAEF,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAA;IAC5D,CAAC;IAED;;;;OAIG;IACH,IAAW,IAAI;QACb,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;QAC7C,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;QAEzC,IAAI,CAAC,IAAA,oBAAW,EAAC,KAAK,CAAC,YAAY,CAAC,CAAC,EAAE;YACrC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE;gBACd,OAAO,EAAE,mBAAmB;gBAC5B,MAAM,EAAE,KAAK,CAAC,YAAY,CAAC;aAC5B,CAAC,CAAA;YAEF,OAAO,KAAK,CAAC,YAAY,CAAC,CAAA;SAC3B;QAED,IAAI,CAAC,IAAA,oBAAW,EAAC,KAAK,CAAC,IAAI,CAAC,EAAE;YAC5B,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE;gBACd,OAAO,EAAE,WAAW;gBACpB,MAAM,EAAE,KAAK,CAAC,IAAI;aACnB,CAAC,CAAA;YAEF,OAAO,KAAK,CAAC,IAAI,CAAA;SAClB;QAED,IAAI,CAAC,GAAG,CACN,MAAM,EACN,6DAA6D,CAC9D,CAAA;QAED,OAAO,KAAK,CAAA;IACd,CAAC;IAYD;;OAEG;IAEU,IAAI;;YACf,IAAI,CAAC,OAAO,GAAG,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAA;YAE5C,IAAI,IAAI,CAAC,OAAO,EAAE;gBAChB,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,CAAA;aACxC;QACH,CAAC;KAAA;IAED;;OAEG;IAEU,gBAAgB;;YAC3B,MAAM,QAAQ,GAES,CAAM,GAAG,EAAC,EAAE;gBACjC,OAAA,IAAA,+BAAU,EAAC,MAAM,CAAC;qBACf,MAAM,CAAC,GAAG,CAAC;qBACX,MAAM,CAAC,QAAQ,CAAC;qBAChB,OAAO,CAAC,aAAa,EAAE,GAAG,CAAC;qBAC3B,WAAW,EAAE,CAAA;cAAA,CAAA;YAElB,IAAI;gBACF,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAA;gBAClD,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAC/B,KAAK,CAAC,GAAG,CAAC,CAAM,IAAI,EAAC,EAAE,6DAAC,OAAA,IAAA,mBAAQ,EAAC,IAAI,EAAE,MAAM,CAAC,CAAA,GAAA,CAAC,CAChD,CAAA;gBAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CACzB,GAAG,OAAO,GAAG,IAAI,CAAC,SAAS,CACzB,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAC5B,EAAE,CACJ,CAAA;gBAED,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE;oBACf,OAAO,EAAE,sBAAsB;oBAC/B,MAAM,EAAE,IAAI;iBACb,CAAC,CAAA;gBAEF,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAClB,qBAAqB,EACrB,CAAM,OAAO,EAAC,EAAE;oBACd,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,IAAI,CAAC,CAAA;oBAC/B,OAAO,OAAO,CAAA;gBAChB,CAAC,CAAA,CACF,CAAA;gBAED,OAAO,IAAI,CAAA;aACZ;YAAC,OAAO,CAAC,EAAE;gBACV,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,uCAAuC,CAAC,CAAA;gBACvD,MAAM,IAAI,KAAK,CAAC,CAAC,CAAC,CAAA;aACnB;QACH,CAAC;KAAA;CACF;AArDC;IADC,yBAAI;iCAOJ;AAMD;IADC,yBAAI;6CAyCJ;AA9HH,sBA+HC"}

package/lib/cjs/index.js

@@ -9,7 +9,7 @@ exports.Cache = void 0;
  * @see https://roots.io/bud
  * @see https://github.com/roots/bud
  *
- * @packageDocumentation @betaDocumentation
+ * @packageDocumentation
  */
 var Cache_1 = require("./Cache");
 Object.defineProperty(exports, "Cache", { enumerable: true, get: function () { return Cache_1.Cache; } });

package/lib/esm/Cache/cache.dependencies.js

@@ -1,6 +1,7 @@
-export * as Bud from '@roots/bud-framework';
+import * as Bud from '@roots/bud-framework';
 export { bind, globby } from '@roots/bud-support';
 export { createHash } from 'crypto';
 import { fs } from '@roots/bud-support';
-export const { readFileSync } = fs;
+export const { ensureFile, readFile, readJson, remove, writeJson, writeFile, } = fs;
+export { Bud };
 //# sourceMappingURL=cache.dependencies.js.map

package/lib/esm/Cache/cache.dependencies.js.map

@@ -1 +1 @@
-{"version":3,"file":"cache.dependencies.js","sourceRoot":"","sources":["../../../src/Cache/cache.dependencies.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,GAAG,MAAM,sBAAsB,CAAA;AAC3C,OAAO,EAAC,IAAI,EAAE,MAAM,EAAC,MAAM,oBAAoB,CAAA;AAC/C,OAAO,EAAC,UAAU,EAAC,MAAM,QAAQ,CAAA;AAEjC,OAAO,EAAC,EAAE,EAAC,MAAM,oBAAoB,CAAA;AACrC,MAAM,CAAC,MAAM,EAAC,YAAY,EAAC,GAAG,EAAE,CAAA"}
+{"version":3,"file":"cache.dependencies.js","sourceRoot":"","sources":["../../../src/Cache/cache.dependencies.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,GAAG,MAAM,sBAAsB,CAAA;AAC3C,OAAO,EAAC,IAAI,EAAE,MAAM,EAAC,MAAM,oBAAoB,CAAA;AAC/C,OAAO,EAAC,UAAU,EAAC,MAAM,QAAQ,CAAA;AAEjC,OAAO,EAAC,EAAE,EAAC,MAAM,oBAAoB,CAAA;AACrC,MAAM,CAAC,MAAM,EACX,UAAU,EACV,QAAQ,EACR,QAAQ,EACR,MAAM,EACN,SAAS,EACT,SAAS,GACV,GAAG,EAAE,CAAA;AACN,OAAO,EAAC,GAAG,EAAC,CAAA"}

package/lib/esm/Cache/index.js

@@ -1,105 +1,101 @@
-import { __decorate } from "tslib";
-import { bind, Bud, createHash, globby, readFileSync, } from './cache.dependencies';
+import { __awaiter, __decorate } from "tslib";
+import { readFile } from 'fs-extra';
+import { bind } from 'helpful-decorators';
+import { isUndefined } from 'lodash';
+import { Bud, createHash } from './cache.dependencies';
 /**
  * Cache service class
  *
- * @remarks
- * Interfaces with:
- *
- *  - {@link @roots/bud-framework#Project} to determine project dependencies for snapshotting/validation.
- *
- *  - {@link @roots/bud-framework#Build} via {@link @roots/bud-framework#Hooks} to update config.
- *
- * Facades:
- *
- *  - {@link @roots/bud-framework#Api} can toggle cache settings with {@link Bud.Persist}
- *
  * @public
  */
 export class Cache extends Bud.Cache.Abstract {
     /**
-     * Service register event
-     *
-     * @decorator `@bind`
-     */
-    register(app) {
-        app.hooks
-            .on('build/cache', () => ({
-            type: app.hooks.filter('build/cache/type'),
-        }))
-            .hooks.on('build/cache/type', () => 'memory');
-    }
-    /**
-     * Returns sha1 hash as a version string
-     *
-     * @decorator `@bind`
-     */
-    version() {
-        return createHash('sha1')
-            .update(this.hash())
-            .digest('base64')
-            .replace(/[^a-z0-9]/gi, '_')
-            .toLowerCase();
-    }
-    /**
-     * Returns cache storage directory
+     * True if cache is enabled
      *
-     * @decorator `@bind`
+     * @public
      */
-    directory() {
-        return this.app.path('storage', 'cache');
+    get enabled() {
+        this.log('info', {
+            message: `cache feature flag: ${this.app.store.get('features.cache')}`,
+        });
+        this.log('info', {
+            message: `--cache flag: ${this.app.store.get('cli.flags.cache')}`,
+        });
+        return this.app.store.get('features.cache') ? true : false;
     }
     /**
-     * Returns array of build dependency paths
-     *
-     * @remarks
-     * @see https://webpack.js.org/configuration/cache/#cachebuilddependencies
+     * Type
      *
-     * @decorator `@bind`
+     * @public
      */
-    buildDependencies() {
-        return [
-            ...new Set(globby.globbySync([
-                this.app.path('project', `${this.app.name}.config.{js,ts,yml,json}`),
-                this.app.path('project', `${this.app.name}.${this.app.mode}.config.{js,ts.yml,json}`),
-                ...this.getFrameworkEntrypoints(),
-                this.app.path('storage', 'cache', '**', '*'),
-            ])),
-        ];
+    get type() {
+        const flags = this.app.store.get('cli.flags');
+        const cache = this.app.store.get('cache');
+        if (!isUndefined(flags['cache.type'])) {
+            this.log('log', {
+                message: '--cache.type flag',
+                suffix: flags['cache.type'],
+            });
+            return flags['cache.type'];
+        }
+        if (!isUndefined(cache.type)) {
+            this.log('log', {
+                message: 'bud.store',
+                suffix: cache.type,
+            });
+            return cache.type;
+        }
+        this.log('warn', 'no cache setting was passed from cli flags or from settings');
+        return false;
     }
     /**
-     * Cache location: framework entrypoints
-     *
-     * @see https://webpack.js.org/configuration/resolve
+     * @public
      */
-    getFrameworkEntrypoints() {
-        var _a, _b, _c;
-        const project = (_a = this.app.project) !== null && _a !== void 0 ? _a : this.app.parent.project;
-        return ((_c = (_b = project.resolveFrom) === null || _b === void 0 ? void 0 : _b.map(dep => `${dep}/lib/cjs/index.js`)) !== null && _c !== void 0 ? _c : []);
+    boot() {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.version = yield this.hashFileContents();
+            if (this.enabled) {
+                this.app.api.call('persist', this.type);
+            }
+        });
     }
     /**
-     * Returns hash of all build dependencies and parsed CLI arguments
-     *
-     * @decorator `@bind`
+     * @public
      */
-    hash() {
-        var _a;
-        return JSON.stringify((_a = this.buildDependencies().reduce((all, file) => all.concat(readFileSync(file, 'utf8')), process.argv.slice(3).join(''))) !== null && _a !== void 0 ? _a : '{}');
+    hashFileContents() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const makeHash = (str) => __awaiter(this, void 0, void 0, function* () {
+                return createHash('sha1')
+                    .update(str)
+                    .digest('base64')
+                    .replace(/[^a-z0-9]/gi, '_')
+                    .toLowerCase();
+            });
+            try {
+                const paths = this.app.project.get('dependencies');
+                const strings = yield Promise.all(paths.map((path) => __awaiter(this, void 0, void 0, function* () { return readFile(path, 'utf8'); })));
+                const hash = yield makeHash(`${strings}${JSON.stringify(this.app.project.get('cli'))}`);
+                this.log('info', {
+                    message: 'cache hash generated',
+                    suffix: hash,
+                });
+                this.app.hooks.async('event.project.write', (project) => __awaiter(this, void 0, void 0, function* () {
+                    project.set('cache.hash', hash);
+                    return project;
+                }));
+                return hash;
+            }
+            catch (e) {
+                this.app.error('error hashing file contents for cache');
+                throw new Error(e);
+            }
+        });
     }
 }
 __decorate([
     bind
-], Cache.prototype, "register", null);
-__decorate([
-    bind
-], Cache.prototype, "version", null);
-__decorate([
-    bind
-], Cache.prototype, "directory", null);
-__decorate([
-    bind
-], Cache.prototype, "buildDependencies", null);
+], Cache.prototype, "boot", null);
 __decorate([
     bind
-], Cache.prototype, "hash", null);
+], Cache.prototype, "hashFileContents", null);
 //# sourceMappingURL=index.js.map

package/lib/esm/Cache/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Cache/index.ts"],"names":[],"mappings":";AAEA,OAAO,EACL,IAAI,EACJ,GAAG,EACH,UAAU,EACV,MAAM,EACN,YAAY,GACb,MAAM,sBAAsB,CAAA;AAE7B;;;;;;;;;;;;;;;GAeG;AACH,MAAM,OAAO,KACX,SAAQ,GAAG,CAAC,KAAK,CAAC,QAAQ;IAG1B;;;;OAIG;IAEI,QAAQ,CAAC,GAAc;QAC5B,GAAG,CAAC,KAAK;aACN,EAAE,CAAC,aAAa,EAAE,GAAG,EAAE,CAAC,CAAC;YACxB,IAAI,EAAE,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,kBAAkB,CAAC;SAC3C,CAAC,CAAC;aACF,KAAK,CAAC,EAAE,CAAC,kBAAkB,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,CAAA;IACjD,CAAC;IAED;;;;OAIG;IAEI,OAAO;QACZ,OAAO,UAAU,CAAC,MAAM,CAAC;aACtB,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;aACnB,MAAM,CAAC,QAAQ,CAAC;aAChB,OAAO,CAAC,aAAa,EAAE,GAAG,CAAC;aAC3B,WAAW,EAAE,CAAA;IAClB,CAAC;IAED;;;;OAIG;IAEI,SAAS;QACd,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAA;IAC1C,CAAC;IAED;;;;;;;OAOG;IAEI,iBAAiB;QACtB,OAAO;YACL,GAAG,IAAI,GAAG,CACR,MAAM,CAAC,UAAU,CAAC;gBAChB,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,SAAS,EACT,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,0BAA0B,CAC3C;gBAED,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,SAAS,EACT,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,0BAA0B,CAC5D;gBAED,GAAG,IAAI,CAAC,uBAAuB,EAAE;gBAEjC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,CAAC;aAC7C,CAAC,CACH;SACU,CAAA;IACf,CAAC;IAED;;;;OAIG;IACI,uBAAuB;;QAC5B,MAAM,OAAO,GAAG,MAAA,IAAI,CAAC,GAAG,CAAC,OAAO,mCAAI,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAA;QAE3D,OAAO,CACL,MAAA,MAAA,OAAO,CAAC,WAAW,0CAAE,GAAG,CACtB,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,mBAAmB,CACjC,mCAAI,EAAE,CACR,CAAA;IACH,CAAC;IAED;;;;OAIG;IAEI,IAAI;;QACT,OAAO,IAAI,CAAC,SAAS,CACnB,MAAA,IAAI,CAAC,iBAAiB,EAAE,CAAC,MAAM,CAC7B,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,EACrD,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAC/B,mCAAI,IAAI,CACV,CAAA;IACH,CAAC;CACF;AA5FC;IADC,IAAI;qCAOJ;AAQD;IADC,IAAI;oCAOJ;AAQD;IADC,IAAI;sCAGJ;AAWD;IADC,IAAI;8CAqBJ;AAuBD;IADC,IAAI;iCAQJ"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Cache/index.ts"],"names":[],"mappings":";AAAA,OAAO,EAAC,QAAQ,EAAC,MAAM,UAAU,CAAA;AACjC,OAAO,EAAC,IAAI,EAAC,MAAM,oBAAoB,CAAA;AACvC,OAAO,EAAC,WAAW,EAAC,MAAM,QAAQ,CAAA;AAElC,OAAO,EAAC,GAAG,EAAE,UAAU,EAAC,MAAM,sBAAsB,CAAA;AAEpD;;;;GAIG;AACH,MAAM,OAAO,KACX,SAAQ,GAAG,CAAC,KAAK,CAAC,QAAQ;IAG1B;;;;OAIG;IACH,IAAW,OAAO;QAChB,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE;YACf,OAAO,EAAE,uBAAuB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAChD,gBAAgB,CACjB,EAAE;SACJ,CAAC,CAAA;QAEF,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE;YACf,OAAO,EAAE,iBAAiB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAC1C,iBAAiB,CAClB,EAAE;SACJ,CAAC,CAAA;QAEF,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAA;IAC5D,CAAC;IAED;;;;OAIG;IACH,IAAW,IAAI;QACb,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;QAC7C,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;QAEzC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,EAAE;YACrC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE;gBACd,OAAO,EAAE,mBAAmB;gBAC5B,MAAM,EAAE,KAAK,CAAC,YAAY,CAAC;aAC5B,CAAC,CAAA;YAEF,OAAO,KAAK,CAAC,YAAY,CAAC,CAAA;SAC3B;QAED,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;YAC5B,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE;gBACd,OAAO,EAAE,WAAW;gBACpB,MAAM,EAAE,KAAK,CAAC,IAAI;aACnB,CAAC,CAAA;YAEF,OAAO,KAAK,CAAC,IAAI,CAAA;SAClB;QAED,IAAI,CAAC,GAAG,CACN,MAAM,EACN,6DAA6D,CAC9D,CAAA;QAED,OAAO,KAAK,CAAA;IACd,CAAC;IAYD;;OAEG;IAEU,IAAI;;YACf,IAAI,CAAC,OAAO,GAAG,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAA;YAE5C,IAAI,IAAI,CAAC,OAAO,EAAE;gBAChB,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,CAAA;aACxC;QACH,CAAC;KAAA;IAED;;OAEG;IAEU,gBAAgB;;YAC3B,MAAM,QAAQ,GAES,CAAM,GAAG,EAAC,EAAE;gBACjC,OAAA,UAAU,CAAC,MAAM,CAAC;qBACf,MAAM,CAAC,GAAG,CAAC;qBACX,MAAM,CAAC,QAAQ,CAAC;qBAChB,OAAO,CAAC,aAAa,EAAE,GAAG,CAAC;qBAC3B,WAAW,EAAE,CAAA;cAAA,CAAA;YAElB,IAAI;gBACF,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAA;gBAClD,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAC/B,KAAK,CAAC,GAAG,CAAC,CAAM,IAAI,EAAC,EAAE,gDAAC,OAAA,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA,GAAA,CAAC,CAChD,CAAA;gBAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CACzB,GAAG,OAAO,GAAG,IAAI,CAAC,SAAS,CACzB,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAC5B,EAAE,CACJ,CAAA;gBAED,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE;oBACf,OAAO,EAAE,sBAAsB;oBAC/B,MAAM,EAAE,IAAI;iBACb,CAAC,CAAA;gBAEF,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAClB,qBAAqB,EACrB,CAAM,OAAO,EAAC,EAAE;oBACd,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,IAAI,CAAC,CAAA;oBAC/B,OAAO,OAAO,CAAA;gBAChB,CAAC,CAAA,CACF,CAAA;gBAED,OAAO,IAAI,CAAA;aACZ;YAAC,OAAO,CAAC,EAAE;gBACV,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,uCAAuC,CAAC,CAAA;gBACvD,MAAM,IAAI,KAAK,CAAC,CAAC,CAAC,CAAA;aACnB;QACH,CAAC;KAAA;CACF;AArDC;IADC,IAAI;iCAOJ;AAMD;IADC,IAAI;6CAyCJ"}

package/lib/esm/index.js

@@ -6,7 +6,7 @@
  * @see https://roots.io/bud
  * @see https://github.com/roots/bud
  *
- * @packageDocumentation @betaDocumentation
+ * @packageDocumentation
  */
 export { Cache } from './Cache';
 //# sourceMappingURL=index.js.map