fix: recognise options that are overwritten unnecessarily (#12)

Co-authored-by: AlCalzone <d.griesel@gmx.net>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: 3 people

esbuild.js

@@ -2,20 +2,23 @@
 // This may require changes when upgrading to esbuild 0.17+
 
 const { build } = require("esbuild");
+const glob = require("glob");
 
 const baseConfig = {
 	bundle: true,
 	minify: process.env.NODE_ENV === "production",
 	sourcemap: process.env.NODE_ENV !== "production",
 };
 
+const testFiles = process.env.NODE_ENV !== "production" ? glob.sync("./src/test/**/*.ts") : [];
+
 const extensionConfig = {
 	...baseConfig,
 	platform: "node",
 	mainFields: ["module", "main"],
 	format: "cjs",
-	entryPoints: ["./src/extension.ts"],
-	outfile: "./out/extension.js",
+	entryPoints: ["./src/extension.ts", ...testFiles],
+	outdir: "./out",
 	external: ["vscode"],
 };
 

src/astUtils.ts

@@ -1,5 +1,6 @@
 import * as vscode from "vscode";
 import {
+	ArrayASTNode,
 	ASTNode,
 	Location,
 	ObjectASTNode,
@@ -124,3 +125,64 @@ export function getOptionsFromParamDefinition(
 		});
 	return options;
 }
+
+export function isJSONDifferentToAST(json: unknown, ast: ASTNode): boolean {
+	const jsonType =
+		typeof json === "object"
+			? Array.isArray(json)
+				? "array"
+				: "object"
+			: typeof json;
+
+	// If the property is undefined in the JSON but present in the AST it will return here
+	if (jsonType !== ast.type) {
+		return true;
+	}
+
+	if (isArrayASTNode(ast) && Array.isArray(json)) {
+		if (ast.items.length !== json.length) {
+			return true;
+		}
+
+		for (let i = 0; i < ast.items.length; i++) {
+			if (isJSONDifferentToAST(json[i], ast.items[i])) {
+				return true;
+			}
+		}
+
+		return false;
+	}
+
+	if (isObjectASTNode(ast) && typeof json === "object" && json !== null) {
+		if (ast.properties.length !== Object.keys(json).length) {
+			return true;
+		}
+
+		for (const property of ast.properties) {
+			if (!property.valueNode) {
+				return true;
+			}
+
+			if (
+				isJSONDifferentToAST(
+					(json as Record<string, unknown>)[property.keyNode.value],
+					property.valueNode,
+				)
+			) {
+				return true;
+			}
+		}
+
+		return false;
+	}
+
+	return ast.value !== json;
+}
+
+export function isArrayASTNode(node: ASTNode): node is ArrayASTNode {
+	return node.type === "array";
+}
+
+export function isObjectASTNode(node: ASTNode): node is ObjectASTNode {
+	return node.type === "object";
+}

src/diagnostics/importOverrideDiagnostics.ts

@@ -2,6 +2,7 @@ import { ASTNode, PropertyASTNode } from "vscode-json-languageservice";
 import {
 	getPropertyNameFromNode,
 	getPropertyValueFromNode,
+	isJSONDifferentToAST,
 	nodeIsPropertyNameOrValue,
 	rangeFromNode,
 } from "../astUtils";
@@ -62,14 +63,13 @@ export function generateImportOverrideDiagnostics(
 			const properties = s
 				.map((s) => config.getNodeFromSymbol(s))
 				.filter(nodeIsPropertyNameOrValue)
-				.map(
-					(n) =>
-						[
-							getPropertyNameFromNode(n),
-							getPropertyValueFromNode(n),
-							n,
-						] as const,
-				)
+				.map((n) => {
+					return [
+						getPropertyNameFromNode(n),
+						n.parent.valueNode,
+						n,
+					] as const;
+				})
 				.filter(([name]) => name in resolvedImport);
 			return [resolvedImport, properties] as const;
 		},
@@ -79,11 +79,10 @@ export function generateImportOverrideDiagnostics(
 		if (!block) continue;
 		const [imp, properties] = block;
 
-		for (const [name, value, propNode] of properties) {
+		for (const [name, valueNode, propNode] of properties) {
 			const originalValue = imp[name];
-			const isUnchanged = value === originalValue;
 
-			if (isUnchanged) {
+			if (valueNode && !isJSONDifferentToAST(originalValue, valueNode)) {
 				ret.push({
 					type: DiagnosticType.UnnecessaryImportOverride,
 					range: rangeFromNode(config.original, propNode.parent),
@@ -92,7 +91,7 @@ export function generateImportOverrideDiagnostics(
 				ret.push({
 					type: DiagnosticType.ImportOverride,
 					range: rangeFromNode(config.original, propNode),
-					value,
+					value: getPropertyValueFromNode(propNode),
 					originalValue,
 				});
 			}