@flint.fyi/rule-tester 0.18.0 → 0.19.1

package/dist/index.d.mts

@@ -1,5 +1,4 @@
 import { AnyOptionalSchema, AnyRule, InferredInputObject, RuleAbout } from "@flint.fyi/core";
-
 //#region src/types.d.ts
 interface InvalidTestCase<Options extends object | undefined = object | undefined> extends TestCase<Options> {
   output?: string;
@@ -47,6 +46,7 @@ interface RuleTesterDefaults {
   files?: Record<string, string>;
 }
 interface RuleTesterOptions {
+  assertNoLanguageReports?: boolean;
   defaults?: RuleTesterDefaults;
   describe?: TesterSetupDescribe;
   diskBackedFSRoot?: string;
@@ -63,19 +63,8 @@ type TesterSetupDescribe = (description: string, setup: () => void) => void;
 type TesterSetupIt = (description: string, setup: () => Promise<void>) => void;
 declare class RuleTester {
   #private;
-  constructor({
-    defaults,
-    describe,
-    diskBackedFSRoot,
-    it,
-    only,
-    scope,
-    skip
-  }?: RuleTesterOptions);
-  describe<OptionsSchema extends AnyOptionalSchema | undefined>(rule: AnyRule<RuleAbout, OptionsSchema>, {
-    invalid,
-    valid
-  }: TestCases<InferredInputObject<OptionsSchema>>): void;
+  constructor({ assertNoLanguageReports, defaults, describe, diskBackedFSRoot, it, only, scope, skip }?: RuleTesterOptions);
+  describe<OptionsSchema extends AnyOptionalSchema | undefined>(rule: AnyRule<RuleAbout, OptionsSchema>, { invalid, valid }: TestCases<InferredInputObject<OptionsSchema>>): void;
 }
 //#endregion
 export { type InvalidTestCase, RuleTester, type TestCase, type TestSuggestion, type TestSuggestionFileCase, type TestSuggestionForFile, type TestSuggestionForFiles, type ValidTestCase, type ValidTestCaseObject };

package/dist/index.mjs

@@ -123,7 +123,7 @@ function resolveReportedSuggestionForFiles(suggestionReported, testCaseNormalize
 }
 //#endregion
 //#region src/runTestCaseRule.ts
-async function runTestCaseRule(fileFactories, linterHost, { options, rule }, { code, fileName, files }) {
+async function runTestCaseRule(fileFactories, linterHost, { options, rule }, { code, fileName, files }, { collectLanguageReports = false } = {}) {
 	const filePathAbsolute = normalizePath(path.resolve(linterHost.getCurrentDirectory(), fileName));
 	const caseSensitive = linterHost.isCaseSensitiveFS();
 	const targetKey = pathKey(filePathAbsolute, caseSensitive);
@@ -152,7 +152,10 @@ async function runTestCaseRule(fileFactories, linterHost, { options, rule }, { c
 		rule.language.runFileVisitors(file, options, ruleRuntime);
 		await ruleRuntime.teardown?.();
 	}
-	return reports.toSorted((a, b) => a.range.begin.raw - b.range.begin.raw || a.range.end.raw - b.range.end.raw);
+	return {
+		languageReports: collectLanguageReports ? rule.language.getLanguageReports?.(file) ?? [] : [],
+		reports: reports.toSorted((a, b) => a.range.begin.raw - b.range.begin.raw || a.range.end.raw - b.range.end.raw)
+	};
 }
 //#endregion
 //#region src/RuleTester.ts
@@ -160,7 +163,7 @@ var RuleTester = class {
 	#fileFactories;
 	#linterHost;
 	#testerOptions;
-	constructor({ defaults = {}, describe, diskBackedFSRoot, it, only, scope = globalThis, skip } = {}) {
+	constructor({ assertNoLanguageReports = true, defaults = {}, describe, diskBackedFSRoot, it, only, scope = globalThis, skip } = {}) {
 		let baseHost = diskBackedFSRoot != null ? createEphemeralLinterHost(createDiskBackedLinterHost(path.resolve(process.cwd(), diskBackedFSRoot, "_flint-rule-tester-virtual"))) : void 0;
 		const { files: defaultFiles = {} } = defaults;
 		if (Object.keys(defaultFiles).length) {
@@ -179,6 +182,7 @@ var RuleTester = class {
 		if (!skip) throw new TypeError("RuleTester needs a `skip` function");
 		if (!only) throw new TypeError("RuleTester needs a `only` function");
 		this.#testerOptions = {
+			assertNoLanguageReports,
 			defaults,
 			describe: defaultTo(describe, scope, "describe"),
 			it,
@@ -200,10 +204,11 @@ var RuleTester = class {
 	#itInvalidCase(rule, testCase) {
 		const testCaseNormalized = normalizeTestCase(testCase, this.#testerOptions.defaults.fileName);
 		this.#itTestCase(testCaseNormalized, async () => {
-			const reports = await runTestCaseRule(this.#fileFactories, this.#linterHost, {
+			const { languageReports, reports } = await runTestCaseRule(this.#fileFactories, this.#linterHost, {
 				options: parseOptions(rule.options, testCase.options),
 				rule
-			}, testCaseNormalized);
+			}, testCaseNormalized, { collectLanguageReports: this.#testerOptions.assertNoLanguageReports });
+			assertNoLanguageReports(languageReports);
 			const actualSnapshot = createReportSnapshot(testCase.code, reports);
 			assert.equal(actualSnapshot, testCase.snapshot);
 			const actualOutput = createOutput(reports, testCaseNormalized);
@@ -214,8 +219,10 @@ var RuleTester = class {
 	}
 	#itTestCase(testCase, 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) {
+			if ("skip" in test && typeof test.skip === "function") test = test.skip;
+			else test = this.#testerOptions.skip;
+		}
 		test(testCase.name ?? ("files" in testCase ? JSON.stringify({
 			[testCase.fileName]: testCase.code,
 			...testCase.files
@@ -228,14 +235,18 @@ var RuleTester = class {
 		const testCase = typeof testCaseRaw === "string" ? { code: testCaseRaw } : testCaseRaw;
 		const testCaseNormalized = normalizeTestCase(testCase, this.#testerOptions.defaults.fileName);
 		this.#itTestCase(testCaseNormalized, async () => {
-			const reports = await runTestCaseRule(this.#fileFactories, this.#linterHost, {
+			const { languageReports, reports } = await runTestCaseRule(this.#fileFactories, this.#linterHost, {
 				options: parseOptions(rule.options, testCase.options),
 				rule
-			}, testCaseNormalized);
+			}, testCaseNormalized, { collectLanguageReports: this.#testerOptions.assertNoLanguageReports });
+			assertNoLanguageReports(languageReports);
 			if (reports.length) assert.deepStrictEqual(createReportSnapshot(testCaseNormalized.code, reports), testCaseNormalized.code);
 		});
 	}
 };
+function assertNoLanguageReports(languageReports) {
+	if (languageReports.length) assert.fail([`Expected no language reports, but found ${languageReports.length}:`, ...languageReports.map((languageReport) => languageReport.text)].join("\n\n"));
+}
 function defaultTo(provided, scope, scopeKey) {
 	if (provided) return provided;
 	if (scopeKey in scope && typeof scope[scopeKey] === "function") return scope[scopeKey];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flint.fyi/rule-tester",
-  "version": "0.18.0",
+  "version": "0.19.1",
   "description": "[Experimental] Rule unit tests for Flint.",
   "homepage": "https://flint.fyi",
   "repository": {
@@ -22,14 +22,14 @@
     "dist/"
   ],
   "dependencies": {
-    "cached-factory": "^0.3.0",
-    "@flint.fyi/core": "^0.25.0",
-    "@flint.fyi/utils": "^0.16.0"
+    "@flint.fyi/core": "^0.26.0",
+    "@flint.fyi/utils": "^0.16.0",
+    "cached-factory": "^0.3.0"
   },
   "devDependencies": {
-    "tsdown": "0.22.3",
-    "vitest": "4.1.0",
-    "@flint.fyi/build": "^0.1.0"
+    "@flint.fyi/build": "^0.1.0",
+    "tsdown": "0.22.14",
+    "vitest": "4.1.11"
   },
   "engines": {
     "node": ">=26.1.0"