Fix various small issues

Author: PhilippeChab

.eslintrc.json

@@ -26,6 +26,7 @@
     "eqeqeq": "warn",
     "no-unsafe-finally": "warn",
     "no-throw-literal": "warn",
+    "prefer-const": "warn",
     "space-before-function-paren": "off",
     "semi": "off",
     "quotes": "off",

CHANGELOG.md

@@ -48,3 +48,10 @@ All notable changes to the "nwscript-ee-language-server" extension will be docum
 ## [1.5.2]
 
 - `const` expressions resolution has been enhanced.
+
+## [1.5.3]
+
+- Goto will now work for functions from `nwscript.nss` if the file is in your project.
+- Fixed the compilation provider not reporting warnings.
+- New compiler setting `reportWarnings`. True by default.
+- New formatter setting `verbose`. False by default.

package.json

@@ -8,7 +8,7 @@
     "url": "https://github.com/PhilippeChab/nwscript-ee-language-server"
   },
   "license": "MIT",
-  "version": "1.5.2",
+  "version": "1.5.3",
   "author": {
     "name": "Philippe Chabot"
   },
@@ -71,12 +71,17 @@
             "enabled": {
               "type": "boolean",
               "default": false,
-              "description": "Whether the formatter is enabled or not."
+              "description": "Whether or not the formatter is enabled."
+            },
+            "verbose": {
+              "type": "boolean",
+              "default": false,
+              "description": "Whether or not the formatter is verbose."
             },
             "executable": {
               "type": "string",
               "default": "clang-format",
-              "description": "Clang's executable path."
+              "description": "Clang format's executable path."
             },
             "ignoredGlobs": {
               "type": "array",
@@ -111,12 +116,17 @@
             "enabled": {
               "type": "boolean",
               "default": true,
-              "description": "Whether the compiler is enabled or not."
+              "description": "Whether or not the compiler is enabled."
             },
             "verbose": {
               "type": "boolean",
               "default": false,
-              "description": "Print the compilation result in the output console."
+              "description": "Whether or not the compiler is verbose."
+            },
+            "reportWarnings": {
+              "type": "boolean",
+              "default": false,
+              "description": "Whether or not the compiler report warnings."
             },
             "nwnHome": {
               "type": "string",

server/src/Documents/DocumentsIndexer.ts

@@ -10,13 +10,8 @@ const generateTokens = async (filesPath: string[]) => {
   }
 
   const tokenizer = await new Tokenizer().loadGrammar();
-
   for (let i = 0; i < filesPath.length; i++) {
     const filePath = filesPath[i];
-    if (filePath.includes("nwscript.nss")) {
-      continue;
-    }
-
     const fileContent = readFileSync(filePath).toString();
     const globalScope = tokenizer.tokenizeContent(fileContent, TokenizedScope.global);
 

server/src/Providers/DiagnosticsProvider.ts

@@ -8,7 +8,7 @@ import { ServerManager } from "../ServerManager";
 import Provider from "./Provider";
 
 const lineNumber = /\(([^)]+)\)/;
-const lineMessage = /Error:(.*)/;
+const lineMessage = /(Error|Warning):(.*)/;
 const lineFilename = /^[^(]+/;
 
 enum OS {
@@ -30,11 +30,7 @@ export default class DiagnoticsProvider extends Provider {
     );
   }
 
-  private sendDiagnostics(uri: string, diagnostics: Diagnostic[]) {
-    this.server.connection.sendDiagnostics({ uri, diagnostics });
-  }
-
-  private generateDiagnostic(uris: string[], files: FilesDiagnostics, severity: DiagnosticSeverity) {
+  private generateDiagnostics(uris: string[], files: FilesDiagnostics, severity: DiagnosticSeverity) {
     return (line: string) => {
       const uri = uris.find((uri) => basename(fileURLToPath(uri)) === lineFilename.exec(line)![0]);
 
@@ -73,8 +69,8 @@ export default class DiagnoticsProvider extends Provider {
 
   private publish(uri: string) {
     return async () => {
-      return await new Promise((resolve, reject) => {
-        const { enabled, nwnHome, nwnInstallation, verbose } = this.server.config.compiler;
+      return await new Promise<boolean>((resolve, reject) => {
+        const { enabled, nwnHome, reportWarnings, nwnInstallation, verbose } = this.server.config.compiler;
         if (!enabled) {
           return resolve(true);
         }
@@ -149,67 +145,62 @@ export default class DiagnoticsProvider extends Provider {
         });
 
         child.on("close", (_) => {
-          try {
-            const lines = stdout
-              .toString()
-              .split("\n")
-              .filter((line) => line !== "\r" && line !== "\n" && Boolean(line));
-            const errors: string[] = [];
-            const warnings: string[] = [];
-
-            lines.forEach((line) => {
-              if (verbose && !line.includes("Compiling:")) {
-                this.server.logger.info(line);
-              }
+          const lines = stdout
+            .toString()
+            .split("\n")
+            .filter((line) => line !== "\r" && line !== "\n" && Boolean(line));
+          const errors: string[] = [];
+          const warnings: string[] = [];
+
+          lines.forEach((line) => {
+            if (verbose && !line.includes("Compiling:")) {
+              this.server.logger.info(line);
+            }
 
-              // Diagnostics
-              if (line.includes("Error:")) {
-                errors.push(line);
-              }
-              if (line.includes("Warning:")) {
-                warnings.push(line);
-              }
+            // Diagnostics
+            if (line.includes("Error:")) {
+              errors.push(line);
+            }
+            if (reportWarnings && line.includes("Warning:")) {
+              warnings.push(line);
+            }
 
-              // Actual errors
-              if (line.includes("NOTFOUND")) {
+            // Actual errors
+            if (line.includes("NOTFOUND")) {
+              return this.server.logger.error(
+                "Unable to resolve nwscript.nss. Are your Neverwinter Nights home and/or installation directories valid?",
+              );
+            }
+            if (line.includes("Failed to open .key archive")) {
+              return this.server.logger.error(
+                "Unable to open nwn_base.key Is your Neverwinter Nights installation directory valid?",
+              );
+            }
+            if (line.includes("Unable to read input file")) {
+              if (Boolean(nwnHome) || Boolean(nwnInstallation)) {
                 return this.server.logger.error(
-                  "Unable to resolve nwscript.nss. Are your Neverwinter Nights home and/or installation directories valid?",
+                  "Unable to resolve provided Neverwinter Nights home and/or installation directories. Ensure the paths are valid in the extension settings.",
                 );
-              }
-              if (line.includes("Failed to open .key archive")) {
+              } else {
                 return this.server.logger.error(
-                  "Unable to open nwn_base.key Is your Neverwinter Nights installation directory valid?",
+                  "Unable to automatically resolve Neverwinter Nights home and/or installation directories.",
                 );
               }
-              if (line.includes("Unable to read input file")) {
-                if (Boolean(nwnHome) || Boolean(nwnInstallation)) {
-                  return this.server.logger.error(
-                    "Unable to resolve provided Neverwinter Nights home and/or installation directories. Ensure the paths are valid in the extension settings.",
-                  );
-                } else {
-                  return this.server.logger.error(
-                    "Unable to automatically resolve Neverwinter Nights home and/or installation directories.",
-                  );
-                }
-              }
-            });
-
-            if (verbose) {
-              this.server.logger.info("Done.\n");
             }
+          });
+
+          if (verbose) {
+            this.server.logger.info("Done.\n");
+          }
 
-            uris.push(document.uri);
-            errors.forEach(this.generateDiagnostic(uris, files, DiagnosticSeverity.Error));
-            warnings.forEach(this.generateDiagnostic(uris, files, DiagnosticSeverity.Warning));
+          uris.push(document.uri);
+          errors.forEach(this.generateDiagnostics(uris, files, DiagnosticSeverity.Error));
+          if (reportWarnings) warnings.forEach(this.generateDiagnostics(uris, files, DiagnosticSeverity.Warning));
 
-            for (const [uri, diagnostics] of Object.entries(files)) {
-              this.sendDiagnostics(uri, diagnostics);
-            }
-            resolve(true);
-          } catch (e: any) {
-            this.server.logger.error(e.message);
-            reject(e);
+          for (const [uri, diagnostics] of Object.entries(files)) {
+            this.server.connection.sendDiagnostics({ uri, diagnostics });
           }
+          resolve(true);
         });
       });
     };

server/src/Providers/DocumentFormattingProvider.ts

@@ -18,21 +18,18 @@ export default class DocumentFormattingProvider extends Provider {
       const {
         textDocument: { uri },
       } = params;
-      const { enabled, ignoredGlobs, style, executable } = this.server.config.formatter;
+      const { enabled, verbose, ignoredGlobs, style, executable } = this.server.config.formatter;
       const clangFormatter = new ClangFormatter(
         this.server.workspaceFilesSystem,
+        enabled,
+        verbose,
         ignoredGlobs,
         executable,
         style,
         this.server.logger,
       );
 
-      if (!enabled || clangFormatter.isIgnoredFile(uri)) {
-        return undefined;
-      }
-
       const liveDocument = this.server.liveDocumentsManager.get(uri);
-
       if (liveDocument) {
         return await clangFormatter.formatDocument(liveDocument, null);
       }

server/src/Providers/DocumentRangeFormattingProvider.ts

@@ -19,21 +19,18 @@ export default class DocumentRangeFormattingProvider extends Provider {
         textDocument: { uri },
         range,
       } = params;
-      const { enabled, ignoredGlobs, style, executable } = this.server.config.formatter;
+      const { enabled, verbose, ignoredGlobs, style, executable } = this.server.config.formatter;
       const clangFormatter = new ClangFormatter(
         this.server.workspaceFilesSystem,
+        enabled,
+        verbose,
         ignoredGlobs,
         executable,
         style,
         this.server.logger,
       );
 
-      if (!enabled || clangFormatter.isIgnoredFile(uri)) {
-        return undefined;
-      }
-
       const liveDocument = this.server.liveDocumentsManager.get(uri);
-
       if (liveDocument) {
         return await clangFormatter.formatDocument(liveDocument, range);
       }