file-entry-cache 9.0.0 → 9.1.0

package/README.md

@@ -17,14 +17,16 @@ npm i --save file-entry-cache
 
 The module exposes two functions `create` and `createFromFile`.
 
-## `create(cacheName, [directory, useCheckSum])`
+## `create(cacheName, [directory, useCheckSum, currentWorkingDir])`
 - **cacheName**: the name of the cache to be created
 - **directory**: Optional the directory to load the cache from
 - **usecheckSum**: Whether to use md5 checksum to verify if file changed. If false the default will be to use the mtime and size of the file.
+- **currentWorkingDir**: Optional the current working directory to use when resolving relative paths
 
-## `createFromFile(pathToCache, [useCheckSum])`
+## `createFromFile(pathToCache, [useCheckSum, currentWorkingDir])`
 - **pathToCache**: the path to the cache file (this combines the cache name and directory)
 - **useCheckSum**: Whether to use md5 checksum to verify if file changed. If false the default will be to use the mtime and size of the file.
+- **currentWorkingDir**: Optional the current working directory to use when resolving relative paths
 
 ```js
 // loads the cache, if one does not exists for the given
@@ -109,6 +111,6 @@ In the worst case scenario all the files will be processed. In the best case sce
 
 ## License
 
-MIT
+MIT (c) Jared Wray
 
 

package/cache.js

@@ -1,16 +1,15 @@
 /* eslint-disable unicorn/no-this-assignment, func-names, no-multi-assign  */
 const path = require('node:path');
-const process = require('node:process');
 const crypto = require('node:crypto');
 
 module.exports = {
-	createFromFile(filePath, useChecksum) {
+	createFromFile(filePath, useChecksum, currentWorkingDir) {
 		const fname = path.basename(filePath);
 		const dir = path.dirname(filePath);
-		return this.create(fname, dir, useChecksum);
+		return this.create(fname, dir, useChecksum, currentWorkingDir);
 	},
 
-	create(cacheId, _path, useChecksum) {
+	create(cacheId, _path, useChecksum, currentWorkingDir) {
 		const fs = require('node:fs');
 		const flatCache = require('flat-cache');
 		const cache = flatCache.load(cacheId, _path);
@@ -21,7 +20,12 @@ module.exports = {
 			// Remove not found entries
 			for (const fPath of cachedEntries) {
 				try {
-					fs.statSync(fPath);
+					let filePath = fPath;
+					if (currentWorkingDir) {
+						filePath = path.join(currentWorkingDir, fPath);
+					}
+
+					fs.statSync(filePath);
 				} catch (error) {
 					if (error.code === 'ENOENT') {
 						cache.removeKey(fPath);
@@ -39,6 +43,12 @@ module.exports = {
        */
 			cache,
 
+			/**
+       * To enable relative paths as the key with current working directory
+       * @type {string}
+       */
+			currentWorkingDir: currentWorkingDir ?? undefined,
+
 			/**
        * Given a buffer, calculate md5 hash of its content.
        * @method getHash
@@ -99,10 +109,6 @@ module.exports = {
 				let fstat;
 
 				try {
-					if (!path.isAbsolute(file)) {
-						file = path.resolve(process.cwd(), file);
-					}
-
 					fstat = fs.statSync(file);
 				} catch (error) {
 					this.removeEntry(file);
@@ -116,8 +122,16 @@ module.exports = {
 				return this._getFileDescriptorUsingMtimeAndSize(file, fstat);
 			},
 
+			_getFileKey(file) {
+				if (this.currentWorkingDir) {
+					return file.split(this.currentWorkingDir).pop();
+				}
+
+				return file;
+			},
+
 			_getFileDescriptorUsingMtimeAndSize(file, fstat) {
-				let meta = cache.getKey(file);
+				let meta = cache.getKey(this._getFileKey(file));
 				const cacheExists = Boolean(meta);
 
 				const cSize = fstat.size;
@@ -133,8 +147,8 @@ module.exports = {
 					meta = {size: cSize, mtime: cTime};
 				}
 
-				const nEntry = (normalizedEntries[file] = {
-					key: file,
+				const nEntry = (normalizedEntries[this._getFileKey(file)] = {
+					key: this._getFileKey(file),
 					changed: !cacheExists || isDifferentDate || isDifferentSize,
 					meta,
 				});
@@ -143,7 +157,7 @@ module.exports = {
 			},
 
 			_getFileDescriptorUsingChecksum(file) {
-				let meta = cache.getKey(file);
+				let meta = cache.getKey(this._getFileKey(file));
 				const cacheExists = Boolean(meta);
 
 				let contentBuffer;
@@ -162,8 +176,8 @@ module.exports = {
 					meta = {hash};
 				}
 
-				const nEntry = (normalizedEntries[file] = {
-					key: file,
+				const nEntry = (normalizedEntries[this._getFileKey(file)] = {
+					key: this._getFileKey(file),
 					changed: !cacheExists || isDifferent,
 					meta,
 				});
@@ -213,12 +227,8 @@ module.exports = {
        * @param entryName
        */
 			removeEntry(entryName) {
-				if (!path.isAbsolute(entryName)) {
-					entryName = path.resolve(process.cwd(), entryName);
-				}
-
-				delete normalizedEntries[entryName];
-				cache.removeKey(entryName);
+				delete normalizedEntries[this._getFileKey(entryName)];
+				cache.removeKey(this._getFileKey(entryName));
 			},
 
 			/**
@@ -238,7 +248,12 @@ module.exports = {
 			},
 
 			_getMetaForFileUsingCheckSum(cacheEntry) {
-				const contentBuffer = fs.readFileSync(cacheEntry.key);
+				let filePath = cacheEntry.key;
+				if (this.currentWorkingDir) {
+					filePath = path.join(this.currentWorkingDir, filePath);
+				}
+
+				const contentBuffer = fs.readFileSync(filePath);
 				const hash = this.getHash(contentBuffer);
 				const meta = Object.assign(cacheEntry.meta, {hash});
 				delete meta.size;
@@ -247,7 +262,12 @@ module.exports = {
 			},
 
 			_getMetaForFileUsingMtimeAndSize(cacheEntry) {
-				const stat = fs.statSync(cacheEntry.key);
+				let filePath = cacheEntry.key;
+				if (currentWorkingDir) {
+					filePath = path.join(currentWorkingDir, filePath);
+				}
+
+				const stat = fs.statSync(filePath);
 				const meta = Object.assign(cacheEntry.meta, {
 					size: stat.size,
 					mtime: stat.mtime.getTime(),
@@ -281,7 +301,7 @@ module.exports = {
 						const meta = useChecksum
 							? me._getMetaForFileUsingCheckSum(cacheEntry)
 							: me._getMetaForFileUsingMtimeAndSize(cacheEntry);
-						cache.setKey(entryName, meta);
+						cache.setKey(this._getFileKey(entryName), meta);
 					} catch (error) {
 						// If the file does not exists we don't save it
 						// other errors are just thrown

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "file-entry-cache",
-  "version": "9.0.0",
+  "version": "9.1.0",
   "description": "Super simple cache for file metadata, useful for process that work o a given series of files and that only need to repeat the job on the changed ones since the previous run of the process",
   "repository": "jaredwray/file-entry-cache",
   "license": "MIT",
@@ -17,8 +17,9 @@
   },
   "scripts": {
     "clean": "rimraf ./coverage /node_modules ./package-lock.json ./yarn.lock ./pnpm-lock.yaml",
-    "test": "xo --fix && c8 mocha -R spec test/specs",
-    "test:ci": "xo && c8 --reporter=lcov mocha -R spec test/specs",
+    "test": "xo --fix && c8 mocha -R spec test/specs/cache.js test/relative.js",
+    "test:relative": "rimraf ./rfixtures ./tfixtures && mocha test/relative.js",
+    "test:ci": "xo && c8 --reporter=lcov mocha -R spec test/specs/cache.js test/relative.js",
     "perf": "node perf.js"
   },
   "prepush": [
@@ -36,12 +37,12 @@
     "cache"
   ],
   "devDependencies": {
-    "c8": "^9.1.0",
+    "c8": "^10.1.2",
     "chai": "^4.3.10",
     "glob-expand": "^0.2.1",
-    "mocha": "^10.4.0",
+    "mocha": "^10.5.1",
     "rimraf": "^5.0.7",
-    "webpack": "^5.91.0",
+    "webpack": "^5.92.1",
     "write": "^2.0.0",
     "xo": "^0.58.0"
   },