first commit

node_modules/stylelint/lib/utils/FileCache.mjs

@@ -0,0 +1,94 @@
+import process from 'node:process';
+import { readFileSync } from 'node:fs';
+import { resolve } from 'node:path';
+
+import createDebug from 'debug';
+import fileEntryCache from 'file-entry-cache';
+
+import {
+	CACHE_STRATEGY_CONTENT,
+	CACHE_STRATEGY_METADATA,
+	DEFAULT_CACHE_LOCATION,
+	DEFAULT_CACHE_STRATEGY,
+} from '../constants.mjs';
+import getCacheFile from './getCacheFile.mjs';
+import hash from './hash.mjs';
+
+const debug = createDebug('stylelint:file-cache');
+
+const pkg = JSON.parse(readFileSync(new URL('../../package.json', import.meta.url), 'utf8'));
+
+/** @typedef {import('file-entry-cache').FileDescriptor["meta"] & { hashOfConfig?: string }} CacheMetadata */
+
+export default class FileCache {
+	constructor(
+		cacheLocation = DEFAULT_CACHE_LOCATION,
+		cacheStrategy = DEFAULT_CACHE_STRATEGY,
+		cwd = process.cwd(),
+	) {
+		if (![CACHE_STRATEGY_METADATA, CACHE_STRATEGY_CONTENT].includes(cacheStrategy)) {
+			throw new Error(
+				`"${cacheStrategy}" cache strategy is unsupported. Specify either "${CACHE_STRATEGY_METADATA}" or "${CACHE_STRATEGY_CONTENT}"`,
+			);
+		}
+
+		const cacheFile = resolve(getCacheFile(cacheLocation, cwd));
+		const useCheckSum = cacheStrategy === CACHE_STRATEGY_CONTENT;
+
+		debug(`Cache file is created at ${cacheFile}`);
+		this._fileCache = fileEntryCache.create(cacheFile, undefined, useCheckSum);
+		this._hashOfConfig = '';
+	}
+
+	/**
+	 * @param {import('stylelint').Config} config
+	 */
+	calcHashOfConfig(config) {
+		if (this._hashOfConfig) return;
+
+		const stylelintVersion = pkg.version;
+		const configString = JSON.stringify(config || {});
+
+		this._hashOfConfig = hash(`${stylelintVersion}_${configString}`);
+	}
+
+	/**
+	 * @param {string} absoluteFilepath
+	 * @returns {boolean}
+	 */
+	hasFileChanged(absoluteFilepath) {
+		// Get file descriptor compares current metadata against cached
+		// one and stores the result to "changed" prop.w
+		const descriptor = this._fileCache.getFileDescriptor(absoluteFilepath);
+		/** @type {CacheMetadata} */
+		const meta = descriptor.meta || {};
+		const changed = descriptor.changed || meta.hashOfConfig !== this._hashOfConfig;
+
+		if (!changed) {
+			debug(`Skip linting ${absoluteFilepath}. File hasn't changed.`);
+		}
+
+		// Mutate file descriptor object and store config hash to each file.
+		// Running lint with different config should invalidate the cache.
+		if (meta.hashOfConfig !== this._hashOfConfig) {
+			meta.hashOfConfig = this._hashOfConfig;
+		}
+
+		return changed;
+	}
+
+	reconcile() {
+		this._fileCache.reconcile();
+	}
+
+	destroy() {
+		this._fileCache.destroy();
+	}
+
+	/**
+	 * @param {string} absoluteFilepath
+	 */
+	removeEntry(absoluteFilepath) {
+		this._fileCache.removeEntry(absoluteFilepath);
+	}
+}