@shivaedev/quality 0.3.1 → 0.4.0

package/src/rules/suppressions/biome-overrides.ts

@@ -1,43 +1,53 @@
 import { Effect, Schema } from "effect";
 import { defineRule, type Finding } from "../../rule.ts";
-import { biomeConfigs, type Config } from "./biome/configs.ts";
+import { biomeConfigs, type Chain } from "./biome/configs.ts";
+import { Declaration, matches, type Scoped, scoped, scopeText } from "./biome/declarations.ts";
 import { type Weakening, weakeningsOf } from "./biome/weakenings.ts";
 
-const Declaration = Schema.Struct({
-	rule: Schema.NonEmptyString,
-	includes: Schema.NonEmptyArray(Schema.NonEmptyString),
-	reason: Schema.String.check(Schema.isPattern(/\S/, { expected: "a reason that says why the scope needs the rule weakened" })),
-});
-
-type Declaration = typeof Declaration.Type;
-
 const BiomeOverridesOptions = Schema.Struct({
 	declared: Schema.Array(Declaration).pipe(Schema.withDecodingDefaultKey(Effect.succeed([]))),
 });
 
-const sameScope = (left: ReadonlyArray<string>, right: ReadonlyArray<string>): boolean =>
-	new Set(left).size === new Set(right).size && left.every((glob) => right.includes(glob));
+interface Shipped extends Scoped {
+	readonly specifier: string;
+}
 
-const matches = (declaration: Declaration, weakening: Weakening): boolean =>
-	declaration.rule === weakening.rule && sameScope(declaration.includes, weakening.includes);
+const shippedBy = ({ base, layers }: Chain): ReadonlyArray<Shipped> =>
+	layers.flatMap(({ preset }) =>
+		preset === undefined
+			? []
+			: preset.declared.map(({ includes, rule }) => ({ includes: includes.map((glob) => scoped(base, glob)), rule, specifier: preset.specifier })),
+	);
 
-const scopeText = (includes: ReadonlyArray<string>): string => includes.map((glob) => `"${glob}"`).join(", ");
+const undeclared = ({ includes, layer, line, rule }: Weakening): Finding =>
+	layer.preset === undefined
+		? { file: layer.path, line, message: `Weakens "${rule}" for ${scopeText(includes)} without a declaration.`, subject: rule }
+		: {
+				file: layer.preset.file,
+				line: layer.preset.line,
+				message: `Extends "${layer.preset.specifier}", which weakens "${rule}" for ${scopeText(includes)} without a declaration.`,
+				subject: rule,
+			};
 
-const undeclared = (weakening: Weakening): Finding => ({
-	file: weakening.file,
-	line: weakening.line,
-	message: `Weakens "${weakening.rule}" for ${scopeText(weakening.includes)} without a declaration.`,
-	subject: weakening.rule,
+const unused = (file: string, declaration: Scoped): Finding => ({
+	file,
+	message: `Declares "${declaration.rule}" for ${scopeText(declaration.includes)}, which no Biome config weakens. Remove the declaration.`,
+	subject: declaration.rule,
 });
 
-const unused = (file: string, declaration: Declaration): Finding => ({
+const repeated = (file: string, declaration: Scoped, shipped: Shipped): Finding => ({
 	file,
-	message: `Declares "${declaration.rule}" for ${scopeText(declaration.includes)}, which no Biome config weakens. Remove the declaration.`,
+	message: `Declares "${declaration.rule}" for ${scopeText(declaration.includes)}, which "${shipped.specifier}" already declares. Remove the declaration.`,
 	subject: declaration.rule,
 });
 
-const unreadable = (config: Config): ReadonlyArray<Finding> =>
-	config._tag === "Unreadable" ? [{ file: config.path, message: `Cannot read this Biome config: ${config.reason}.` }] : [];
+const staleOrRepeated = (file: string, weakenings: ReadonlyArray<Weakening>, shipped: ReadonlyArray<Shipped>) => (declaration: Scoped) => {
+	if (!weakenings.some((weakening) => matches(declaration, weakening))) {
+		return [unused(file, declaration)];
+	}
+	const already = shipped.find((candidate) => matches(declaration, candidate));
+	return already === undefined ? [] : [repeated(file, declaration, already)];
+};
 
 export const biomeOverrides = defineRule({
 	id: "suppressions/biome-overrides",
@@ -46,16 +56,15 @@ export const biomeOverrides = defineRule({
 	options: Schema.toStandardSchemaV1(BiomeOverridesOptions, { parseOptions: { errors: "all", onExcessProperty: "error" } }),
 	registrable: false,
 	check: async (inputs) => {
-		const configs = await biomeConfigs(inputs);
+		const { chains, problems, root } = await biomeConfigs(inputs);
 		const { declared } = inputs.options;
-		const weakenings = configs.flatMap((config) => (config._tag === "Config" ? weakeningsOf(config.json, config.path, config.base) : []));
-		const root = configs.find((config) => !config.path.includes("/"))?.path ?? "biome.json";
+		const weakenings = chains.flatMap(weakeningsOf);
+		const shipped = chains.flatMap(shippedBy);
+		const covered = (weakening: Weakening): boolean => [...declared, ...shipped].some((declaration) => matches(declaration, weakening));
 		return [
-			...configs.flatMap(unreadable),
-			...weakenings.filter((weakening) => !declared.some((declaration) => matches(declaration, weakening))).map(undeclared),
-			...declared
-				.filter((declaration) => !weakenings.some((weakening) => matches(declaration, weakening)))
-				.map((declaration) => unused(root, declaration)),
+			...problems,
+			...weakenings.filter((weakening) => !covered(weakening)).map(undeclared),
+			...declared.flatMap(staleOrRepeated(root, weakenings, shipped)),
 		];
 	},
 });

package/tsconfig/base.json

@@ -0,0 +1,35 @@
+{
+	"compilerOptions": {
+		"target": "ESNext",
+		"lib": ["ESNext"],
+		"module": "ESNext",
+		"moduleResolution": "bundler",
+		"moduleDetection": "force",
+		"verbatimModuleSyntax": true,
+		"isolatedModules": true,
+		"erasableSyntaxOnly": true,
+		"allowImportingTsExtensions": true,
+		"resolveJsonModule": true,
+		"allowJs": true,
+		"checkJs": true,
+		"noEmit": true,
+		"strict": true,
+		"noImplicitAny": true,
+		"strictBuiltinIteratorReturn": true,
+		"useUnknownInCatchVariables": true,
+		"noUncheckedIndexedAccess": true,
+		"exactOptionalPropertyTypes": true,
+		"noImplicitOverride": true,
+		"noImplicitReturns": true,
+		"noFallthroughCasesInSwitch": true,
+		"noUnusedLocals": true,
+		"noUnusedParameters": true,
+		"allowUnreachableCode": false,
+		"allowUnusedLabels": false,
+		"noUncheckedSideEffectImports": true,
+		"libReplacement": false,
+		"stableTypeOrdering": true,
+		"forceConsistentCasingInFileNames": true,
+		"skipLibCheck": true
+	}
+}

package/tsconfig/package.json

@@ -0,0 +1,10 @@
+{
+	"extends": "./base.json",
+	"compilerOptions": {
+		"noEmit": false,
+		"declaration": true,
+		"declarationMap": true,
+		"sourceMap": true,
+		"rewriteRelativeImportExtensions": true
+	}
+}