file-entry-cache 10.0.7 → 10.1.0

package/README.md

@@ -92,6 +92,7 @@ There have been many features added and changes made to the `file-entry-cache` c
 
 # FileEntryCache Options (FileEntryCacheOptions)
 - `currentWorkingDirectory?` - The current working directory. Used when resolving relative paths.
+- `useModifiedTime?` - If `true` it will use the modified time to determine if the file has changed. Default is `true`
 - `useCheckSum?` - If `true` it will use a checksum to determine if the file has changed. Default is `false`
 - `hashAlgorithm?` - The algorithm to use for the checksum. Default is `md5` but can be any algorithm supported by `crypto.createHash`
 - `cache.ttl?` - The time to live for the cache in milliseconds. Default is `0` which means no expiration
@@ -117,7 +118,7 @@ There have been many features added and changes made to the `file-entry-cache` c
 - `removeEntry(filePath: string): void` - Removes an entry from the cache. This can be `relative` or `absolute` paths.
 - `reconcile(): void` - Saves the cache to disk and removes any files that are no longer found.
 - `hasFileChanged(filePath: string): boolean` - Checks if the file has changed. This will return `true` if the file has changed.
-- `getFileDescriptor(filePath: string, options?: { useCheckSum?: boolean, currentWorkingDirectory?: string }): FileEntryDescriptor` - Gets the file descriptor for the file. Please refer to the entire section on `Get File Descriptor` for more information.
+- `getFileDescriptor(filePath: string, options?: { useModifiedTime?: boolean, useCheckSum?: boolean, currentWorkingDirectory?: string }): FileEntryDescriptor` - Gets the file descriptor for the file. Please refer to the entire section on `Get File Descriptor` for more information.
 - `normalizeEntries(entries: FileEntryDescriptor[]): FileEntryDescriptor[]` - Normalizes the entries to have the correct paths. This is used when loading the cache from disk.
 - `analyzeFiles(files: string[])` will return `AnalyzedFiles` object with `changedFiles`, `notFoundFiles`, and `notChangedFiles` as FileDescriptor arrays.
 - `getUpdatedFiles(files: string[])` will return an array of `FileEntryDescriptor` objects that have changed.

package/dist/index.cjs

@@ -70,12 +70,20 @@ var FileEntryDefault = class {
 var FileEntryCache = class {
   _cache = new import_flat_cache.FlatCache({ useClone: false });
   _useCheckSum = false;
+  _useModifiedTime = true;
   _currentWorkingDirectory;
   _hashAlgorithm = "md5";
+  /**
+   * Create a new FileEntryCache instance
+   * @param options - The options for the FileEntryCache
+   */
   constructor(options) {
     if (options?.cache) {
       this._cache = new import_flat_cache.FlatCache(options.cache);
     }
+    if (options?.useModifiedTime) {
+      this._useModifiedTime = options.useModifiedTime;
+    }
     if (options?.useCheckSum) {
       this._useCheckSum = options.useCheckSum;
     }
@@ -86,27 +94,73 @@ var FileEntryCache = class {
       this._hashAlgorithm = options.hashAlgorithm;
     }
   }
+  /**
+   * Get the cache
+   * @returns {FlatCache} The cache
+   */
   get cache() {
     return this._cache;
   }
+  /**
+   * Set the cache
+   * @param {FlatCache} cache - The cache to set
+   */
   set cache(cache) {
     this._cache = cache;
   }
+  /**
+   * Use the hash to check if the file has changed
+   * @returns {boolean} if the hash is used to check if the file has changed
+   */
   get useCheckSum() {
     return this._useCheckSum;
   }
+  /**
+   * Set the useCheckSum value
+   * @param {boolean} value - The value to set
+   */
   set useCheckSum(value) {
     this._useCheckSum = value;
   }
+  /**
+   * Use the modified time to check if the file has changed
+   * @returns {boolean} if the modified time is used to check if the file has changed
+   */
+  get useModifiedTime() {
+    return this._useModifiedTime;
+  }
+  /**
+   * Set the useModifiedTime value
+   * @param {boolean} value - The value to set
+   */
+  set useModifiedTime(value) {
+    this._useModifiedTime = value;
+  }
+  /**
+   * Get the hash algorithm
+   * @returns {string} The hash algorithm
+   */
   get hashAlgorithm() {
     return this._hashAlgorithm;
   }
+  /**
+   * Set the hash algorithm
+   * @param {string} value - The value to set
+   */
   set hashAlgorithm(value) {
     this._hashAlgorithm = value;
   }
+  /**
+   * Get the current working directory
+   * @returns {string | undefined} The current working directory
+   */
   get currentWorkingDirectory() {
     return this._currentWorkingDirectory;
   }
+  /**
+   * Set the current working directory
+   * @param {string | undefined} value - The value to set
+   */
   set currentWorkingDirectory(value) {
     this._currentWorkingDirectory = value;
   }
@@ -222,6 +276,7 @@ var FileEntryCache = class {
     result.meta = this._cache.getKey(result.key) ?? {};
     filePath = this.getAbsolutePath(filePath, { currentWorkingDirectory: options?.currentWorkingDirectory });
     const useCheckSumValue = options?.useCheckSum ?? this._useCheckSum;
+    const useModifiedTimeValue = options?.useModifiedTime ?? this._useModifiedTime;
     try {
       fstat = import_node_fs.default.statSync(filePath);
       result.meta = {
@@ -254,7 +309,10 @@ var FileEntryCache = class {
     if (result.meta.data === void 0) {
       result.meta.data = metaCache.data;
     }
-    if (metaCache?.mtime !== result.meta?.mtime || metaCache?.size !== result.meta?.size) {
+    if (useModifiedTimeValue && metaCache?.mtime !== result.meta?.mtime) {
+      result.changed = true;
+    }
+    if (metaCache?.size !== result.meta?.size) {
       result.changed = true;
     }
     if (useCheckSumValue && metaCache?.hash !== result.meta?.hash) {

package/dist/index.d.cts

@@ -2,12 +2,14 @@ import { FlatCacheOptions, FlatCache } from 'flat-cache';
 
 type FileEntryCacheOptions = {
     currentWorkingDirectory?: string;
+    useModifiedTime?: boolean;
     useCheckSum?: boolean;
     hashAlgorithm?: string;
     cache?: FlatCacheOptions;
 };
 type GetFileDescriptorOptions = {
     useCheckSum?: boolean;
+    useModifiedTime?: boolean;
     currentWorkingDirectory?: string;
 };
 type FileDescriptor = {
@@ -37,16 +39,63 @@ declare class FileEntryDefault {
 declare class FileEntryCache {
     private _cache;
     private _useCheckSum;
+    private _useModifiedTime;
     private _currentWorkingDirectory;
     private _hashAlgorithm;
+    /**
+     * Create a new FileEntryCache instance
+     * @param options - The options for the FileEntryCache
+     */
     constructor(options?: FileEntryCacheOptions);
+    /**
+     * Get the cache
+     * @returns {FlatCache} The cache
+     */
     get cache(): FlatCache;
+    /**
+     * Set the cache
+     * @param {FlatCache} cache - The cache to set
+     */
     set cache(cache: FlatCache);
+    /**
+     * Use the hash to check if the file has changed
+     * @returns {boolean} if the hash is used to check if the file has changed
+     */
     get useCheckSum(): boolean;
+    /**
+     * Set the useCheckSum value
+     * @param {boolean} value - The value to set
+     */
     set useCheckSum(value: boolean);
+    /**
+     * Use the modified time to check if the file has changed
+     * @returns {boolean} if the modified time is used to check if the file has changed
+     */
+    get useModifiedTime(): boolean;
+    /**
+     * Set the useModifiedTime value
+     * @param {boolean} value - The value to set
+     */
+    set useModifiedTime(value: boolean);
+    /**
+     * Get the hash algorithm
+     * @returns {string} The hash algorithm
+     */
     get hashAlgorithm(): string;
+    /**
+     * Set the hash algorithm
+     * @param {string} value - The value to set
+     */
     set hashAlgorithm(value: string);
+    /**
+     * Get the current working directory
+     * @returns {string | undefined} The current working directory
+     */
     get currentWorkingDirectory(): string | undefined;
+    /**
+     * Set the current working directory
+     * @param {string | undefined} value - The value to set
+     */
     set currentWorkingDirectory(value: string | undefined);
     /**
      * Given a buffer, calculate md5 hash of its content.

package/dist/index.d.ts

@@ -2,12 +2,14 @@ import { FlatCacheOptions, FlatCache } from 'flat-cache';
 
 type FileEntryCacheOptions = {
     currentWorkingDirectory?: string;
+    useModifiedTime?: boolean;
     useCheckSum?: boolean;
     hashAlgorithm?: string;
     cache?: FlatCacheOptions;
 };
 type GetFileDescriptorOptions = {
     useCheckSum?: boolean;
+    useModifiedTime?: boolean;
     currentWorkingDirectory?: string;
 };
 type FileDescriptor = {
@@ -37,16 +39,63 @@ declare class FileEntryDefault {
 declare class FileEntryCache {
     private _cache;
     private _useCheckSum;
+    private _useModifiedTime;
     private _currentWorkingDirectory;
     private _hashAlgorithm;
+    /**
+     * Create a new FileEntryCache instance
+     * @param options - The options for the FileEntryCache
+     */
     constructor(options?: FileEntryCacheOptions);
+    /**
+     * Get the cache
+     * @returns {FlatCache} The cache
+     */
     get cache(): FlatCache;
+    /**
+     * Set the cache
+     * @param {FlatCache} cache - The cache to set
+     */
     set cache(cache: FlatCache);
+    /**
+     * Use the hash to check if the file has changed
+     * @returns {boolean} if the hash is used to check if the file has changed
+     */
     get useCheckSum(): boolean;
+    /**
+     * Set the useCheckSum value
+     * @param {boolean} value - The value to set
+     */
     set useCheckSum(value: boolean);
+    /**
+     * Use the modified time to check if the file has changed
+     * @returns {boolean} if the modified time is used to check if the file has changed
+     */
+    get useModifiedTime(): boolean;
+    /**
+     * Set the useModifiedTime value
+     * @param {boolean} value - The value to set
+     */
+    set useModifiedTime(value: boolean);
+    /**
+     * Get the hash algorithm
+     * @returns {string} The hash algorithm
+     */
     get hashAlgorithm(): string;
+    /**
+     * Set the hash algorithm
+     * @param {string} value - The value to set
+     */
     set hashAlgorithm(value: string);
+    /**
+     * Get the current working directory
+     * @returns {string | undefined} The current working directory
+     */
     get currentWorkingDirectory(): string | undefined;
+    /**
+     * Set the current working directory
+     * @param {string | undefined} value - The value to set
+     */
     set currentWorkingDirectory(value: string | undefined);
     /**
      * Given a buffer, calculate md5 hash of its content.

package/dist/index.js

@@ -33,12 +33,20 @@ var FileEntryDefault = class {
 var FileEntryCache = class {
   _cache = new FlatCache({ useClone: false });
   _useCheckSum = false;
+  _useModifiedTime = true;
   _currentWorkingDirectory;
   _hashAlgorithm = "md5";
+  /**
+   * Create a new FileEntryCache instance
+   * @param options - The options for the FileEntryCache
+   */
   constructor(options) {
     if (options?.cache) {
       this._cache = new FlatCache(options.cache);
     }
+    if (options?.useModifiedTime) {
+      this._useModifiedTime = options.useModifiedTime;
+    }
     if (options?.useCheckSum) {
       this._useCheckSum = options.useCheckSum;
     }
@@ -49,27 +57,73 @@ var FileEntryCache = class {
       this._hashAlgorithm = options.hashAlgorithm;
     }
   }
+  /**
+   * Get the cache
+   * @returns {FlatCache} The cache
+   */
   get cache() {
     return this._cache;
   }
+  /**
+   * Set the cache
+   * @param {FlatCache} cache - The cache to set
+   */
   set cache(cache) {
     this._cache = cache;
   }
+  /**
+   * Use the hash to check if the file has changed
+   * @returns {boolean} if the hash is used to check if the file has changed
+   */
   get useCheckSum() {
     return this._useCheckSum;
   }
+  /**
+   * Set the useCheckSum value
+   * @param {boolean} value - The value to set
+   */
   set useCheckSum(value) {
     this._useCheckSum = value;
   }
+  /**
+   * Use the modified time to check if the file has changed
+   * @returns {boolean} if the modified time is used to check if the file has changed
+   */
+  get useModifiedTime() {
+    return this._useModifiedTime;
+  }
+  /**
+   * Set the useModifiedTime value
+   * @param {boolean} value - The value to set
+   */
+  set useModifiedTime(value) {
+    this._useModifiedTime = value;
+  }
+  /**
+   * Get the hash algorithm
+   * @returns {string} The hash algorithm
+   */
   get hashAlgorithm() {
     return this._hashAlgorithm;
   }
+  /**
+   * Set the hash algorithm
+   * @param {string} value - The value to set
+   */
   set hashAlgorithm(value) {
     this._hashAlgorithm = value;
   }
+  /**
+   * Get the current working directory
+   * @returns {string | undefined} The current working directory
+   */
   get currentWorkingDirectory() {
     return this._currentWorkingDirectory;
   }
+  /**
+   * Set the current working directory
+   * @param {string | undefined} value - The value to set
+   */
   set currentWorkingDirectory(value) {
     this._currentWorkingDirectory = value;
   }
@@ -185,6 +239,7 @@ var FileEntryCache = class {
     result.meta = this._cache.getKey(result.key) ?? {};
     filePath = this.getAbsolutePath(filePath, { currentWorkingDirectory: options?.currentWorkingDirectory });
     const useCheckSumValue = options?.useCheckSum ?? this._useCheckSum;
+    const useModifiedTimeValue = options?.useModifiedTime ?? this._useModifiedTime;
     try {
       fstat = fs.statSync(filePath);
       result.meta = {
@@ -217,7 +272,10 @@ var FileEntryCache = class {
     if (result.meta.data === void 0) {
       result.meta.data = metaCache.data;
     }
-    if (metaCache?.mtime !== result.meta?.mtime || metaCache?.size !== result.meta?.size) {
+    if (useModifiedTimeValue && metaCache?.mtime !== result.meta?.mtime) {
+      result.changed = true;
+    }
+    if (metaCache?.size !== result.meta?.size) {
       result.changed = true;
     }
     if (useCheckSumValue && metaCache?.hash !== result.meta?.hash) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "file-entry-cache",
-  "version": "10.0.7",
+  "version": "10.1.0",
   "description": "A lightweight cache for file metadata, ideal for processes that work on a specific set of files and only need to reprocess files that have changed since the last run",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -29,16 +29,16 @@
     "cache"
   ],
   "devDependencies": {
-    "@types/node": "^22.13.9",
-    "@vitest/coverage-v8": "^3.0.7",
+    "@types/node": "^22.15.8",
+    "@vitest/coverage-v8": "^3.1.3",
     "rimraf": "^6.0.1",
     "tsup": "^8.4.0",
-    "typescript": "^5.8.2",
-    "vitest": "^3.0.7",
+    "typescript": "^5.8.3",
+    "vitest": "^3.1.3",
     "xo": "^0.60.0"
   },
   "dependencies": {
-    "flat-cache": "^6.1.7"
+    "flat-cache": "^6.1.9"
   },
   "files": [
     "dist",