Apply eslint (#41)

* Lint the project

Author: PhilippeChab

.eslintignore

@@ -0,0 +1 @@
+webpack.config.js

.eslintrc.json

@@ -2,17 +2,40 @@
   "root": true,
   "parser": "@typescript-eslint/parser",
   "parserOptions": {
-    "ecmaVersion": 6,
-    "sourceType": "module"
+    "ecmaVersion": "latest",
+    "sourceType": "module",
+    "project": ["./client/tsconfig.json", "./server/tsconfig.json", "./server/tsconfig.eslint.json"]
   },
   "plugins": ["@typescript-eslint"],
+  "extends": ["standard-with-typescript", "plugin:prettier/recommended"],
   "rules": {
+    "@typescript-eslint/quotes": ["error", "double"],
+    "@typescript-eslint/consistent-type-definitions": ["error", "type"],
     "@typescript-eslint/naming-convention": "warn",
-    "@typescript-eslint/semi": "warn",
+    "@typescript-eslint/no-non-null-assertion": "warn",
+    "@typescript-eslint/no-floating-promises": "warn",
+    "@typescript-eslint/semi": "off",
+    "@typescript-eslint/explicit-function-return-type": "off",
+    "@typescript-eslint/space-before-function-paren": "off",
+    "@typescript-eslint/array-type": "off",
+    "@typescript-eslint/strict-boolean-expressions": "off",
+    "@typescript-eslint/prefer-nullish-coalescing": "off",
+    "@typescript-eslint/consistent-type-assertions": "off",
+    "@typescript-eslint/no-extraneous-class": "off",
     "curly": "warn",
     "eqeqeq": "warn",
+    "no-unsafe-finally": "warn",
     "no-throw-literal": "warn",
-    "semi": "off"
+    "space-before-function-paren": "off",
+    "semi": "off",
+    "quotes": "off",
+    "no-extra-boolean-cast": "off",
+    "prettier/prettier": [
+      "error",
+      {
+        "endOfLine": "auto"
+      }
+    ]
   },
-  "ignorePatterns": ["out", "dist", "**/*.d.ts"]
+  "ignorePatterns": ["out", "**/*.d.ts"]
 }

.prettierrc.json

@@ -0,0 +1,5 @@
+{
+  "printWidth": 130,
+  "trailingComma": "all",
+  "singleQuote": false
+}

.vscode/settings.json

@@ -2,6 +2,5 @@
   "editor.formatOnSave": true,
   "[typescript]": {
     "editor.defaultFormatter": "esbenp.prettier-vscode"
-  },
-  "prettier.printWidth": 130
+  }
 }

CHANGELOG.md

@@ -39,3 +39,7 @@ All notable changes to the "nwscript-ee-language-server" extension will be docum
 ## [1.5.0]
 
 - The extension size has been lowered from 14.7 to 4.8 MB.
+
+## [1.5.1]
+
+- Eslint has been configured along with prettier and the project will be linted from now on.

client/src/extension.ts

@@ -25,6 +25,6 @@ export function activate(context: ExtensionContext) {
   client.start();
 }
 
-export function deactivate() {
-  return client?.stop();
+export async function deactivate() {
+  return await client?.stop();
 }

package.json

@@ -8,7 +8,7 @@
     "url": "https://github.com/PhilippeChab/nwscript-ee-language-server"
   },
   "license": "MIT",
-  "version": "1.5.0",
+  "version": "1.5.1",
   "author": {
     "name": "Philippe Chabot"
   },
@@ -148,14 +148,20 @@
   },
   "devDependencies": {
     "@types/node": "14.x",
-    "@typescript-eslint/eslint-plugin": "^5.21.0",
+    "@typescript-eslint/eslint-plugin": "^5.33.0",
     "@typescript-eslint/parser": "^5.21.0",
-    "eslint": "^8.14.0",
+    "eslint": "^8.0.1",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-config-standard-with-typescript": "^22.0.0",
+    "eslint-plugin-import": "^2.25.2",
+    "eslint-plugin-n": "^15.0.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-promise": "^6.0.0",
     "merge-options": "^3.0.4",
-    "prettier": "^2.6.2",
+    "prettier": "^2.7.1",
     "rimraf": "^3.0.2",
     "ts-loader": "^9.3.1",
-    "typescript": "^4.6.4",
+    "typescript": "*",
     "webpack": "^5.74.0",
     "webpack-cli": "^4.10.0"
   }

server/scripts/GenerateLibDefinitions.ts

@@ -1,5 +1,6 @@
 import { writeFileSync, readFileSync } from "fs";
 import { normalize, join } from "path";
+
 import { Tokenizer } from "../src/Tokenizer";
 import { TokenizedScope } from "../src/Tokenizer/Tokenizer";
 

server/src/Documents/Document.ts

@@ -1,4 +1,3 @@
-import { WorkspaceFilesSystem } from "../WorkspaceFilesSystem";
 import type { ComplexToken, StructComplexToken } from "../Tokenizer/types";
 import type DocumentsCollection from "./DocumentsCollection";
 
@@ -11,11 +10,11 @@ export default class Document {
     readonly children: string[],
     readonly complexTokens: ComplexToken[],
     readonly structComplexTokens: StructComplexToken[],
-    private readonly collection: DocumentsCollection
+    private readonly collection: DocumentsCollection,
   ) {}
 
   public getKey() {
-    return WorkspaceFilesSystem.getFileBasename(this.path);
+    return this.collection.getKey(this.path);
   }
 
   public getChildren(computedChildren: string[] = []): string[] {
@@ -35,7 +34,7 @@ export default class Document {
         }
 
         return childDocument.getChildren(computedChildren);
-      })
+      }),
     );
   }
 
@@ -56,7 +55,7 @@ export default class Document {
         }
 
         return childDocument.getGlobalComplexTokensWithRef(computedChildren);
-      })
+      }),
     );
   }
 
@@ -77,7 +76,7 @@ export default class Document {
         }
 
         return childDocument.getGlobalComplexTokens(computedChildren);
-      })
+      }),
     );
   }
 
@@ -98,7 +97,7 @@ export default class Document {
         }
 
         return childDocument.getGlobalStructComplexTokensWithRef(computedChildren);
-      })
+      }),
     );
   }
 
@@ -119,7 +118,7 @@ export default class Document {
         }
 
         return childDocument.getGlobalStructComplexTokens(computedChildren);
-      })
+      }),
     );
   }
 }

server/src/Documents/DocumentsCollection.ts

@@ -1,12 +1,14 @@
-import { join } from "path";
+import { basename, join } from "path";
+import { fileURLToPath } from "url";
+import { readFileSync } from "fs";
+import { TextDocument } from "vscode-languageserver-textdocument";
 
 import type { Tokenizer } from "../Tokenizer";
 import type { ComplexToken } from "../Tokenizer/types";
 import { GlobalScopeTokenizationResult, TokenizedScope } from "../Tokenizer/Tokenizer";
 import { Dictionnary } from "../Utils";
-import { WorkspaceFilesSystem } from "../WorkspaceFilesSystem";
 import Document from "./Document";
-import { TextDocument } from "vscode-languageserver-textdocument";
+import { FILES_EXTENSION } from "../WorkspaceFilesSystem/WorkspaceFilesSystem";
 
 export default class DocumentsCollection extends Dictionnary<string, Document> {
   public readonly standardLibComplexTokens: ComplexToken[] = [];
@@ -15,7 +17,7 @@ export default class DocumentsCollection extends Dictionnary<string, Document> {
     super();
 
     this.standardLibComplexTokens = JSON.parse(
-      WorkspaceFilesSystem.readFileSync(join(__dirname, "..", "resources", "standardLibDefinitions.json")).toString()
+      readFileSync(join(__dirname, "..", "resources", "standardLibDefinitions.json")).toString(),
     ).complexTokens as ComplexToken[];
   }
 
@@ -31,12 +33,20 @@ export default class DocumentsCollection extends Dictionnary<string, Document> {
     return new Document(filePath, globalScope.children, globalScope.complexTokens, globalScope.structComplexTokens, this);
   }
 
+  public getKey(path: string) {
+    return basename(path, FILES_EXTENSION).slice(0, -1);
+  }
+
+  public getFromPath(path: string) {
+    return this.get(this.getKey(path));
+  }
+
   public createDocument(filePath: string, globalScope: GlobalScopeTokenizationResult) {
     this.addDocument(this.initializeDocument(filePath, globalScope));
   }
 
   public updateDocument(document: TextDocument, tokenizer: Tokenizer) {
-    const filePath = WorkspaceFilesSystem.fileUriToPath(document.uri);
+    const filePath = fileURLToPath(document.uri);
     const globalScope = tokenizer.tokenizeContent(document.getText(), TokenizedScope.global);
 
     this.overwriteDocument(this.initializeDocument(filePath, globalScope));