Add diagnostics provider

Author: PhilippeChab

.gitignore

@@ -6,4 +6,5 @@ tsconfig.tsbuildinfo
 test/
 server/resources/nwscript.nss
 yarn-error.log
-.DS_Store
+.DS_Store
+TODO.txt

.vscodeignore

@@ -11,3 +11,4 @@ test/**
 server/resources/nwscript.nss
 server/scripts
 images/**
+TODO.txt

CHANGELOG.md

@@ -22,3 +22,7 @@ All notable changes to the "nwscript-ee-language-server" extension will be docum
   - Is now performed in background, which means it is not blocking other features of the LSP.
   - Is now clustered - the number of processes depends on the number of cores on your machine.
   - Is now incremental, which means a file will be available as soon as it is indexed.
+
+## [1.4.0]
+
+- New provider: [Diagnostics](https://code.visualstudio.com/api/language-extensions/programmatic-language-features#provide-diagnostics).

README.md

@@ -10,6 +10,10 @@ While it seems to work well, even in bigger and older code bases, it is still an
 
 [clang-format](https://clang.llvm.org/docs/ClangFormat.html).
 
+### Diagnostics
+
+Neverwinter Nights home and installation folders.
+
 ## Usage
 
 Simply open a project with nss files and the extension installed. The extension will index your files and you will be ready to go - it can currently take up to 10-15 seconds to index big projects.
@@ -25,31 +29,31 @@ Notes:
 
 ```
 {
-    "editor.formatOnSave": true,
-    "files.associations": {
-      "*.nss": "nwscript"
-    },
-    "[nwscript]": {
-      "editor.defaultFormatter": "PhilippeChab.nwscript-ee-language-server"
-    },
-    "nwscript-ee-lsp.formatter": {
-      "enabled": true,
-      "executable": "clang-format",
-      "ignoredGlobs": ["/folder/to/ignore/*.nss", "file/to/ignore/filename.nss"],
-      "style": {
-        "BasedOnStyle": "Google",
-        "AlignTrailingComments": true,
-        "AlignConsecutiveAssignments": true,
-        "ColumnLimit": 250,
-        "BreakBeforeBraces": "Allman",
-        "AlignEscapedNewlinesLeft": true,
-        "AlwaysBreakBeforeMultilineStrings": true,
-        "MaxEmptyLinesToKeep": 1,
-        "TabWidth": 4,
-        "IndentWidth": 4,
-        "UseTab": "Always"
-      }
+  "editor.formatOnSave": true,
+  "files.associations": {
+    "*.nss": "nwscript"
+  },
+  "[nwscript]": {
+    "editor.defaultFormatter": "PhilippeChab.nwscript-ee-language-server"
+  },
+  "nwscript-ee-lsp.formatter": {
+    "enabled": true,
+    "executable": "clang-format",
+    "ignoredGlobs": ["/folder/to/ignore/*.nss", "file/to/ignore/filename.nss"],
+    "style": {
+      "BasedOnStyle": "Google",
+      "AlignTrailingComments": true,
+      "AlignConsecutiveAssignments": true,
+      "ColumnLimit": 250,
+      "BreakBeforeBraces": "Allman",
+      "AlignEscapedNewlinesLeft": true,
+      "AlwaysBreakBeforeMultilineStrings": true,
+      "MaxEmptyLinesToKeep": 1,
+      "TabWidth": 4,
+      "IndentWidth": 4,
+      "UseTab": "Always"
     }
+  }
 }
 ```
 
@@ -58,6 +62,28 @@ Notes:
 - The executable setting must either bet set to you path executable's identifier, or its absolute path.
 - The style object must respect clang-format [rules](https://clang.llvm.org/docs/ClangFormatStyleOptions.html).
 
+### Diagnostics
+
+```
+{
+  "nwscript-ee-lsp.compiler": {
+    "enabled": true,
+    "verbose": false,
+    "nwnHome": "C:\\Users\\YOUR_USERNAME\\Documents\\Neverwinter Nights",
+    "nwnInstallation": "D:\\Program Files (x86)\\Steam\\steamapps\\common\\Neverwinter Nights"
+  }
+}
+```
+
+Notes:
+
+- Diagnostics are provided by compiling the file with the [nwnsc](https://github.com/nwneetools/nwnsc) executable.
+- The compiler executable is provided for Windows, Darwin and Linux operating systems.
+- By default, the compiler will try to detect automatically your Neverwinter Nights home and installation folders if they are not specified. If it fails to do so, you can provide the paths in the extension settings like shown above - input paths are wrapped into quotes automatically.
+- In order to compile a file's includes, the compiler needs to know their directories. Files that had been requested a diagnostic while the project is being indexed are queued and processed once the indexing is done.
+- You can set the `verbose` setting to `true` if you wish to see detailed logs of the compilation process.
+- Big files with a lot of includes can take between half a second to a second to compile on older machines - it will not affect the client performances as the processing is done on the server.
+
 ## Features
 
 Enhanced syntax highlighting - the following example is with the [One Dark Pro](https://marketplace.visualstudio.com/items?itemName=zhuangtongfa.Material-theme) theme:
@@ -81,6 +107,7 @@ Also:
 - Formatting
 - Range formatting
 - Signature help
+- Diagnostics
 
 ## Building and running
 

package.json

@@ -8,7 +8,7 @@
     "url": "https://github.com/PhilippeChab/nwscript-ee-language-server"
   },
   "license": "MIT",
-  "version": "1.3.2",
+  "version": "1.4.0",
   "author": {
     "name": "Philippe Chabot"
   },
@@ -86,7 +86,7 @@
                 "type": "string"
               }
             },
-            "nwscript-formatter.style": {
+            "style": {
               "type": "object",
               "default": {
                 "BasedOnStyle": "Google",
@@ -104,6 +104,31 @@
               "description": "Style for the formatter."
             }
           }
+        },
+        "nwscript-ee-lsp.compiler": {
+          "type": "object",
+          "properties": {
+            "enabled": {
+              "type": "boolean",
+              "default": true,
+              "description": "Whether the compiler is enabled or not."
+            },
+            "verbose": {
+              "type": "boolean",
+              "default": false,
+              "description": "Print the compilation result in the output console."
+            },
+            "nwnHome": {
+              "type": "string",
+              "default": "",
+              "description": "Your Neverwinter Nights home directory."
+            },
+            "nwnInstallation": {
+              "type": "string",
+              "default": "",
+              "description": "Your Neverwinter Nights installation directory."
+            }
+          }
         }
       }
     }

server/resources/compiler/linux/nwnsc

@@ -1,6 +1,7 @@
 import { WorkspaceFilesSystem } from "../WorkspaceFilesSystem";
 import type { ComplexToken, StructComplexToken } from "../Tokenizer/types";
 import type DocumentsCollection from "./DocumentsCollection";
+import { Diagnostic } from "vscode-languageserver";
 
 export type OwnedComplexTokens = { owner: string; tokens: ComplexToken[] };
 export type OwnedStructComplexTokens = { owner: string; tokens: StructComplexToken[] };
@@ -18,6 +19,27 @@ export default class Document {
     return WorkspaceFilesSystem.getFileBasename(this.path);
   }
 
+  public getChildren(computedChildren: string[] = []): string[] {
+    return this.children.concat(
+      this.children.flatMap((child) => {
+        // Cycling children or/and duplicates
+        if (computedChildren.includes(child)) {
+          return [];
+        } else {
+          computedChildren.push(child);
+        }
+
+        const childDocument = this.collection.get(child);
+
+        if (!childDocument) {
+          return [];
+        }
+
+        return childDocument.getChildren(computedChildren);
+      })
+    );
+  }
+
   public getGlobalComplexTokensWithRef(computedChildren: string[] = []): OwnedComplexTokens[] {
     return [{ owner: this.path, tokens: this.complexTokens }].concat(
       this.children.flatMap((child) => {

server/resources/compiler/mac/nwnsc

@@ -6,6 +6,7 @@ import { GlobalScopeTokenizationResult, TokenizedScope } from "../Tokenizer/Toke
 import { Dictionnary } from "../Utils";
 import { WorkspaceFilesSystem } from "../WorkspaceFilesSystem";
 import Document from "./Document";
+import { TextDocument } from "vscode-languageserver-textdocument";
 
 export default class DocumentsCollection extends Dictionnary<string, Document> {
   public readonly standardLibComplexTokens: ComplexToken[] = [];
@@ -34,10 +35,9 @@ export default class DocumentsCollection extends Dictionnary<string, Document> {
     this.addDocument(this.initializeDocument(filePath, globalScope));
   }
 
-  public updateDocument(uri: string, tokenizer: Tokenizer) {
-    const filePath = WorkspaceFilesSystem.fileUriToPath(uri);
-    const fileContent = WorkspaceFilesSystem.readFileSync(filePath).toString();
-    const globalScope = tokenizer.tokenizeContent(fileContent, TokenizedScope.global);
+  public updateDocument(document: TextDocument, tokenizer: Tokenizer) {
+    const filePath = WorkspaceFilesSystem.fileUriToPath(document.uri);
+    const globalScope = tokenizer.tokenizeContent(document.getText(), TokenizedScope.global);
 
     this.overwriteDocument(this.initializeDocument(filePath, globalScope));
   }