feat: user settings to control diagnostics reporting cross view files (#734)

* feat: user settings to control diagnostics reporting cross different view files

* fix: add change set

* fix: review comment

* fix: update readme file

Author: marufrasully

.changeset/ten-rivers-pull.md

@@ -0,0 +1,12 @@
+---
+"@ui5-language-assistant/vscode-ui5-language-assistant-bas-ext": patch
+"vscode-ui5-language-assistant": patch
+"@ui5-language-assistant/xml-views-completion": patch
+"@ui5-language-assistant/language-server": patch
+"@ui5-language-assistant/settings": patch
+"@ui5-language-assistant/binding": patch
+"@ui5-language-assistant/context": patch
+"@ui5-language-assistant/fe": patch
+---
+
+feat: User settings to control diagnostics reporting cross view files

packages/binding/test/unit/services/completion/aggregation-binding.test.ts

@@ -39,6 +39,7 @@ describe("aggregation binding", () => {
       server: "off",
     },
     SplitAttributesOnFormat: true,
+    LimitUniqueIdDiagnostics: false,
   };
 
   beforeAll(async function () {

packages/binding/test/unit/services/completion/property-binding-info.test.ts

@@ -44,6 +44,7 @@ describe("index", () => {
       server: "off",
     },
     SplitAttributesOnFormat: true,
+    LimitUniqueIdDiagnostics: false,
   };
 
   beforeAll(async function () {

packages/context/api.d.ts

@@ -5,5 +5,6 @@ export type {
   ManifestDetails,
   YamlDetails,
   ProjectKind,
+  ControlIdLocation,
 } from "./src/types";
 export type { Manifest } from "@sap-ux/project-access";

packages/fe/test/unit/services/completion/providers/context-path.test.ts

@@ -45,6 +45,7 @@ describe("contextPath attribute value completion", () => {
       server: "off",
     },
     SplitAttributesOnFormat: true,
+    LimitUniqueIdDiagnostics: false,
   };
 
   const annotationSnippetCDS = `

packages/fe/test/unit/services/completion/providers/filter-bar.test.ts

@@ -43,6 +43,7 @@ describe("filterBar id attribute value completion", () => {
       server: "off",
     },
     SplitAttributesOnFormat: true,
+    LimitUniqueIdDiagnostics: false,
   };
 
   const annotationSnippetCDS = `

packages/fe/test/unit/services/completion/providers/meta-path.test.ts

@@ -48,6 +48,7 @@ describe("metaPath attribute value completion", () => {
       server: "off",
     },
     SplitAttributesOnFormat: true,
+    LimitUniqueIdDiagnostics: false,
   };
 
   const annotationSnippetCDS = `

packages/language-server/src/server.ts

@@ -24,6 +24,7 @@ import {
   getSettingsForDocument,
   setConfigurationSettings,
   Settings,
+  getConfigurationSettings,
 } from "@ui5-language-assistant/settings";
 import { commands } from "@ui5-language-assistant/user-facing-text";
 import { ServerInitializationOptions } from "../api";
@@ -44,6 +45,7 @@ import {
   reactOnViewFileChange,
   reactOnPackageJson,
   isContext,
+  Context,
 } from "@ui5-language-assistant/context";
 import { diagnosticToCodeActionFix } from "./quick-fix";
 import { executeCommand } from "./commands";
@@ -296,6 +298,28 @@ const validateIdsOfOpenDocuments = async (): Promise<void> => {
     connection.sendDiagnostics({ uri: document.uri, diagnostics });
   }
 };
+/**
+ * Validates the IDs of the open document and sends the diagnostics to the client
+ * @param {TextDocument} document - The open document to be validated
+ * @param {Context} context - The context containing additional information
+ * @returns {void}
+ */
+const validateIdsOfOpenDocument = (
+  document: TextDocument,
+  context: Context
+): void => {
+  const idDiagnostics = getXMLViewIdDiagnostics({
+    document,
+    context,
+  });
+  let diagnostics = documentsDiagnostics.get(document.uri) ?? [];
+  diagnostics = diagnostics.concat(idDiagnostics);
+
+  getLogger().trace("computed diagnostics", {
+    diagnostics,
+  });
+  connection.sendDiagnostics({ uri: document.uri, diagnostics });
+};
 
 async function validateOpenDocumentsOnDidChangeWatchedFiles(
   changes: FileEvent[]
@@ -391,7 +415,13 @@ documents.onDidChangeContent(async (changeEvent): Promise<void> => {
       context,
     });
     documentsDiagnostics.set(document.uri, diagnostics);
-    await validateIdsOfOpenDocuments();
+    const settings = getConfigurationSettings();
+    const limitUniqueIdsDiagReport = settings.LimitUniqueIdDiagnostics;
+    if (limitUniqueIdsDiagReport) {
+      validateIdsOfOpenDocument(document, context);
+    } else {
+      await validateIdsOfOpenDocuments();
+    }
   }
 });
 
@@ -466,7 +496,7 @@ function ensureDocumentSettingsUpdated(resource: string): void {
   }
 }
 
-connection.onDidChangeConfiguration((change) => {
+connection.onDidChangeConfiguration(async (change) => {
   getLogger().debug("`onDidChangeConfiguration` event");
   if (hasConfigurationCapability) {
     getLogger().trace("Reset all cached document settings");
@@ -487,9 +517,8 @@ connection.onDidChangeConfiguration((change) => {
     });
     setConfigurationSettings(ui5LangAssistSettings);
   }
-  // In the future we might want to
   // re-validate the files related to the `cached document settings`.
-
+  await validateIdsOfOpenDocuments();
   // `setLogLevel` will ignore `undefined` values
   setLogLevel(change?.settings?.UI5LanguageAssistant?.logging?.level);
 });

packages/settings/api.d.ts

@@ -13,11 +13,15 @@ export type Settings = CodeAssistSettings &
   TraceSettings &
   LoggingSettings &
   WebServerSettings &
+  LimitUniqueIdDiagnostics &
   FormatterSettings;
 
 export interface WebServerSettings {
   SAPUI5WebServer?: string;
 }
+export interface LimitUniqueIdDiagnostics {
+  LimitUniqueIdDiagnostics: boolean;
+}
 export interface FormatterSettings {
   SplitAttributesOnFormat: boolean;
 }

packages/settings/src/settings.ts

@@ -9,6 +9,7 @@ const defaultSettings: Settings = {
   logging: { level: "error" },
   SAPUI5WebServer: "",
   SplitAttributesOnFormat: true,
+  LimitUniqueIdDiagnostics: false,
 };
 deepFreezeStrict(defaultSettings);