feat: adding back in useModifiedTime (#1400)

Author: jaredwray

packages/file-entry-cache/src/index.ts

@@ -47,6 +47,8 @@ export type FileEntryCacheOptions = {
 export type GetFileDescriptorOptions = {
 	/** Whether to use checksum for this specific file check instead of modified time (mtime) (overrides instance setting) */
 	useCheckSum?: boolean;
+	/** Whether to use file modified time for change detection (default: true) */
+	useModifiedTime?: boolean;
 };
 
 export type FileDescriptor = {
@@ -147,6 +149,7 @@ export class FileEntryCache {
 	private _restrictAccessToCwd = false;
 	private _logger?: ILogger;
 	private _useAbsolutePathAsKey = false;
+	private _useModifiedTime = true;
 
 	/**
 	 * Create a new FileEntryCache instance
@@ -169,6 +172,10 @@ export class FileEntryCache {
 			this._cwd = options.cwd;
 		}
 
+		if (options?.useModifiedTime !== undefined) {
+			this._useModifiedTime = options.useModifiedTime;
+		}
+
 		if (options?.restrictAccessToCwd !== undefined) {
 			this._restrictAccessToCwd = options.restrictAccessToCwd;
 		}
@@ -262,6 +269,22 @@ export class FileEntryCache {
 		this._cwd = value;
 	}
 
+	/**
+	 * Get whether to use modified time for change detection
+	 * @returns {boolean} Whether modified time (mtime) is used for change detection (default: true)
+	 */
+	public get useModifiedTime(): boolean {
+		return this._useModifiedTime;
+	}
+
+	/**
+	 * Set whether to use modified time for change detection
+	 * @param {boolean} value - The value to set
+	 */
+	public set useModifiedTime(value: boolean) {
+		this._useModifiedTime = value;
+	}
+
 	/**
 	 * Get whether to restrict paths to cwd boundaries
 	 * @returns {boolean} Whether strict path checking is enabled (default: true)
@@ -435,6 +458,13 @@ export class FileEntryCache {
 			"Using checksum setting",
 		);
 
+		const useModifiedTimeValue =
+			options?.useModifiedTime ?? this.useModifiedTime;
+		this._logger?.debug(
+			{ useModifiedTime: useModifiedTimeValue },
+			"Using modified time (mtime) setting",
+		);
+
 		try {
 			fstat = fs.statSync(absolutePath);
 			// Update the file stats while preserving existing meta properties
@@ -478,7 +508,7 @@ export class FileEntryCache {
 		}
 
 		// If the file is in the cache, check if the file has changed
-		if (useCheckSumValue === false && metaCache?.mtime !== result.meta?.mtime) {
+		if (useModifiedTimeValue && metaCache?.mtime !== result.meta?.mtime) {
 			result.changed = true;
 			this._logger?.debug(
 				{ filePath, oldMtime: metaCache.mtime, newMtime: result.meta.mtime },

packages/file-entry-cache/test/index.test.ts

@@ -55,6 +55,13 @@ describe("file-entry-cache with options", () => {
 		expect(fileEntryCache.restrictAccessToCwd).toBe(false);
 	});
 
+	test("should be able to get and set useModifiedTime", () => {
+		const fileEntryCache = new FileEntryCache({ useModifiedTime: false });
+		expect(fileEntryCache.useModifiedTime).toBe(false);
+		fileEntryCache.useModifiedTime = true;
+		expect(fileEntryCache.useModifiedTime).toBe(true);
+	});
+
 	test("create should initialize a file-entry-cache", () => {
 		const fileEntryCache = defaultFileEntryCache.create("test1");
 		expect(fileEntryCache).toBeDefined();

packages/file-entry-cache/test/relative-eslint.test.ts

@@ -18,6 +18,7 @@ describe("eslint tests scenarios", () => {
 		const cache = fileEntryCache.create(".eslintcache-foo43", cacheDirectory, {
 			useCheckSum,
 			cwd: path.resolve("./src"),
+			useModifiedTime: false,
 		});
 
 		if (cache.useAbsolutePathAsKey) {