@flint.fyi/rule-tester 0.20.0 → 0.21.0

package/dist/index.d.mts

@@ -34,6 +34,10 @@ interface TestSuggestionForFile {
   updated: string;
 }
 interface TestSuggestionForFiles {
+  /**
+   * Expected edits keyed by paths relative to the test host's cwd, or absolute paths.
+   * Rules must report the corresponding absolute target paths.
+   */
   files: Record<string, TestSuggestionFileCase[]>;
   id: string;
 }

package/dist/index.mjs

@@ -2,7 +2,8 @@ import assert from "node:assert/strict";
 import { isDeepStrictEqual } from "node:util";
 import { CachedFactory } from "cached-factory";
 import { resolve } from "pathe";
-import { applyChangesToText, createDiskBackedLinterHost, createEphemeralLinterHost, createVFSLinterHost, formatReport, getPositionOfColumnAndLine, isSuggestionForFiles, parseOptions, processRuleReport, withRepositoryRoot } from "@flint.fyi/core";
+import { applyChangesToText, createEphemeralLinterHost, createVFSLinterHost, formatReport, getPositionOfColumnAndLine, isSuggestionForFiles, parseOptions, processRuleReport, withRepositoryRoot } from "@flint.fyi/core";
+import { createDiskBackedLinterHost, isFileSystemCaseSensitive } from "@flint.fyi/core/node";
 import { isTruthy, normalizePath, nullThrows, pathKey } from "@flint.fyi/utils";
 //#region src/createOutput.ts
 function createOutput(reports, testCaseNormalized) {
@@ -96,13 +97,13 @@ function isTestSuggestionForFiles(suggestion) {
 }
 //#endregion
 //#region src/resolveReportedSuggestions.ts
-function resolveReportedSuggestions(reports, testCaseNormalized) {
+function resolveReportedSuggestions(reports, testCaseNormalized, cwd) {
 	const suggestionsReported = reports.flatMap((report) => report.suggestions).filter(isTruthy);
 	if (!suggestionsReported.length) return;
 	return suggestionsReported.map((suggestionReported, index) => {
 		const suggestionExpected = testCaseNormalized.suggestions?.[index];
 		if (isSuggestionForFiles(suggestionReported)) return {
-			files: resolveReportedSuggestionForFiles(suggestionReported, suggestionExpected),
+			files: resolveReportedSuggestionForFiles(suggestionReported, suggestionExpected, cwd),
 			id: suggestionReported.id
 		};
 		if (suggestionExpected && isTestSuggestionForFiles(suggestionExpected)) throw new Error("This test case describes a suggestion across files, but the rule is only reporting changes to its own file.");
@@ -112,12 +113,12 @@ function resolveReportedSuggestions(reports, testCaseNormalized) {
 		};
 	});
 }
-function resolveReportedSuggestionForFiles(suggestionReported, suggestionExpected) {
+function resolveReportedSuggestionForFiles(suggestionReported, suggestionExpected, cwd) {
 	if (!suggestionExpected) return {};
 	if (!isTestSuggestionForFiles(suggestionExpected)) throw new Error("This test case describes a suggestion to its own file, but the rule is reporting changes across files.");
-	assert.deepStrictEqual(Object.keys(suggestionReported.files).sort(), Object.keys(suggestionExpected.files).sort(), "Reported suggestion target paths must exactly match expected target paths.");
+	assert.deepStrictEqual(Object.keys(suggestionReported.files).toSorted(), Object.keys(suggestionExpected.files).map((filePath) => resolve(cwd, filePath)).toSorted(), "Reported suggestion target paths must exactly match expected target paths.");
 	return Object.fromEntries(Object.entries(suggestionExpected.files).map(([filePath, suggestionCasesExpected]) => {
-		const changes = suggestionReported.files[filePath];
+		const changes = suggestionReported.files[resolve(cwd, filePath)];
 		assert.ok(changes, `Expected reported suggestion "${suggestionReported.id}" to provide changes for target "${filePath}".`);
 		return [filePath, suggestionCasesExpected.map((suggestionCaseExpected) => ({
 			original: suggestionCaseExpected.original,
@@ -163,7 +164,7 @@ async function runTestCaseRule(fileFactories, linterHost, { options, rule }, { c
 		await ruleRuntime.teardown?.();
 	}
 	return {
-		languageReports: collectLanguageReports ? rule.language.getLanguageReports?.(file) ?? [] : [],
+		languageReports: collectLanguageReports ? rule.language.getLanguageReports?.(file, linterHost) ?? [] : [],
 		reports: reports.toSorted((a, b) => a.range.begin.raw - b.range.begin.raw || a.range.end.raw - b.range.end.raw)
 	};
 }
@@ -174,18 +175,24 @@ var RuleTester = class {
 	#linterHost;
 	#testerOptions;
 	constructor({ assertNoLanguageReports = true, defaults = {}, describe, diskBackedFSRoot, it, only, scope = globalThis, skip } = {}) {
-		const virtualRoot = diskBackedFSRoot == null ? void 0 : resolve(process.cwd(), diskBackedFSRoot, "_flint-rule-tester-virtual");
-		let baseHost = virtualRoot != null ? createEphemeralLinterHost(withRepositoryRoot(createDiskBackedLinterHost(virtualRoot), virtualRoot)) : void 0;
+		let host;
+		if (diskBackedFSRoot === void 0) host = createVFSLinterHost({
+			caseSensitive: isFileSystemCaseSensitive(),
+			cwd: "/"
+		});
+		else {
+			const cwd = resolve(process.cwd(), diskBackedFSRoot, "_flint-rule-tester-virtual");
+			host = createVFSLinterHost({ baseHost: createEphemeralLinterHost(withRepositoryRoot(createDiskBackedLinterHost(cwd), cwd)) });
+		}
 		const { files: defaultFiles = {} } = defaults;
 		if (Object.keys(defaultFiles).length) {
-			const vfs = createVFSLinterHost(baseHost == null ? { cwd: process.cwd() } : { baseHost });
 			for (const [name, content] of Object.entries(defaultFiles)) {
-				const filePath = resolve(vfs.getCurrentDirectory(), name);
-				vfs.vfsUpsertFile(filePath, content);
+				const filePath = resolve(host.getCurrentDirectory(), name);
+				host.vfsUpsertFile(filePath, content);
 			}
-			baseHost = vfs;
+			host = createVFSLinterHost({ baseHost: host });
 		}
-		this.#linterHost = createVFSLinterHost(baseHost == null ? { cwd: process.cwd() } : { baseHost });
+		this.#linterHost = host;
 		this.#fileFactories = new CachedFactory((language) => language.createFileFactory(this.#linterHost));
 		it = defaultTo(it, scope, "it");
 		if (!skip && "skip" in it && typeof it.skip === "function") skip = it.skip;
@@ -226,16 +233,13 @@ var RuleTester = class {
 			assert.equal(actualSnapshot, testCase.snapshot);
 			const actualOutput = createOutput(reports, testCaseNormalized);
 			assert.equal(testCase.output, actualOutput, "Expected `output` property to equal:");
-			const actualSuggestions = resolveReportedSuggestions(reports, testCaseNormalized);
+			const actualSuggestions = resolveReportedSuggestions(reports, testCaseNormalized, this.#linterHost.getCurrentDirectory());
 			assert.deepStrictEqual(actualSuggestions, testCase.suggestions);
 		});
 	}
 	#itTestCase(testCase, seenTestCases, setup) {
 		let test = testCase.only ? this.#testerOptions.only : this.#testerOptions.it;
-		if (testCase.skip) {
-			if ("skip" in test && typeof test.skip === "function") test = test.skip;
-			else test = this.#testerOptions.skip;
-		}
+		if (testCase.skip) test = "skip" in test && typeof test.skip === "function" ? test.skip : this.#testerOptions.skip;
 		test(testCase.name ?? ("files" in testCase ? JSON.stringify({
 			[testCase.fileName]: testCase.code,
 			...testCase.files

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flint.fyi/rule-tester",
-  "version": "0.20.0",
+  "version": "0.21.0",
   "description": "[Experimental] Rule unit tests for Flint.",
   "homepage": "https://flint.fyi",
   "repository": {
@@ -16,21 +16,22 @@
   "sideEffects": false,
   "type": "module",
   "exports": {
-    ".": "./dist/index.mjs"
+    ".": "./dist/index.mjs",
+    "./package.json": "./package.json"
   },
   "files": [
     "dist/"
   ],
   "dependencies": {
-    "@flint.fyi/core": "^0.27.0",
-    "@flint.fyi/utils": "^0.16.0",
+    "@flint.fyi/core": "^0.29.0",
+    "@flint.fyi/utils": "^0.17.0",
     "cached-factory": "^0.3.0",
     "pathe": "^2.0.3"
   },
   "devDependencies": {
     "@flint.fyi/build": "^0.1.0",
     "tsdown": "0.23.0",
-    "vitest": "5.0.1"
+    "vitest": "5.0.3"
   },
   "engines": {
     "node": ">=26.1.0"