Feature/add eslint (#635)

* Adding eslint and jest plugin
* Fixing linting changing
* Automatic fixes
* Fixing linting issues
* More linting fixes and tests

Author: DaanV2

.github/workflows/publish-to-vscode.yml

@@ -53,6 +53,9 @@ jobs:
       - name: 📋 Test
         run: npm run test
 
+      - name: 🔍 Linting
+        run: npm run lint
+
   publish:
     if: ${{ needs.test.result == 'success' && needs.universal.result == 'success' }}
     runs-on: ubuntu-latest

.github/workflows/pull-request.yml

@@ -37,6 +37,9 @@ jobs:
       - name: 🛠️ Build
         run: npm run compile
 
+      - name: 🔍 Linting
+        run: npm run lint
+
       - name: 📦 Package test
         run: |
           npx vsce package

.github/workflows/unit-test.yml

@@ -34,6 +34,9 @@ jobs:
       - name: 📋 Test
         run: npm run test
 
+      - name: 🔍 Linting
+        run: npm run lint
+
       - name: 📦 Package test
         run: |
           npx vsce package

.vscode/extensions.json

@@ -3,5 +3,8 @@
   // Extension identifier format: ${publisher}.${name}. Example: vscode.csharp
 
   // List of extensions which should be recommended for users of this workspace.
-  "recommendations": []
+  "recommendations": [
+    "orta.vscode-jest",
+    "dbaeumer.vscode-eslint"
+  ]
 }

.vscode/settings.json

@@ -23,5 +23,9 @@
   "mocha.requires": ["ts-node/register", "chai"],
   "mocha.env": {
     "TS_NODE_COMPILER_OPTIONS": "{\"module\":\"commonjs\",\"declaration\":true,\"noImplicitAny\":false,\"removeComments\":false,\"noLib\":false,\"emitDecoratorMetadata\":true,\"experimentalDecorators\":true,\"target\":\"es6\",\"sourceMap\":false,\"resolveJsonModule\":true,\"esModuleInterop\":true,\"moduleResolution\":\"node\",\"lib\":[\"dom\",\"es2017\"],\"types\":[\"chai\",\"chai-as-promised\",\"chai-http\",\"convict\",\"cors\",\"helmet\",\"mocha\",\"mongoose\",\"morgan\",\"node\",\"winston\"]}"
-  }
+  },
+
+  "eslint.workingDirectories": [{ "mode": "auto" }],
+  "eslint.run": "onSave",
+  "eslint.lintTask.enable": true
 }

client/jest.config.ts

@@ -149,10 +149,10 @@ const config: Config = {
   // testLocationInResults: false,
 
   // The glob patterns Jest uses to detect test files
-  // testMatch: [
-  //   "**/__tests__/**/*.[jt]s?(x)",
-  //   "**/?(*.)+(spec|test).[tj]s?(x)"
-  // ],
+  testMatch: [
+    "**/__tests__/**/*.[jt]s?(x)",
+    "**/?(*.)+(spec|test).[tj]s?(x)"
+  ],
 
   // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
   // testPathIgnorePatterns: [

client/src/code/character.ts

@@ -14,7 +14,7 @@ export namespace Character {
 
   /** */
   export function IsLetter(char: string): boolean {
-    var code = char.charCodeAt(0);
+    const code = char.charCodeAt(0);
 
     if (code >= Character_a && code <= Character_z) return true;
     if (code >= Character_A && code <= Character_Z) return true;
@@ -32,7 +32,7 @@ export namespace Character {
 
   /** */
   export function IsNumber(char: string): boolean {
-    var code = char.charCodeAt(0);
+    const code = char.charCodeAt(0);
 
     if (code >= Character_0 && code <= Character_9) return true;
 

client/src/code/document-location.ts

@@ -105,7 +105,7 @@ export function resolve(text: string | { getText(): string }, path: string): num
   const s = path.split(/[\\/]/);
   let index = 0;
 
-  for (var I = 0; I < s.length; I++) {
+  for (let I = 0; I < s.length; I++) {
     const elem = s[I];
 
     if (!Number.isInteger(elem) && elem !== "") {

client/src/commands/create-templates.ts

@@ -33,19 +33,24 @@ export function activate(context: ExtensionContext): void {
 
   //General
   createCommandWithID(context, Commands.Create.General.Entity, "Create Entity", EntityID);
-  createCommand(context, Commands.Create.General.Languages, "Create Languages");
-  createCommand(context, Commands.Create.General.Manifests, "Create Manifests");
+  createCommand(context, Commands.Create.General.Languages);
+  createCommand(context, Commands.Create.General.Manifests);
 
   //Project
   createCommandWithID(context, Commands.Create.Project.WorldProject, "Create World, BP, RP project", ProjectID);
   createCommandWithID(context, Commands.Create.Project.Resourcepack, "Create RP", ProjectID);
   createCommandWithID(context, Commands.Create.Project.Behaviorpack, "Create BP", ProjectID);
 
   //Behavior pack
-  createCommand(context, Commands.Create.Behaviorpack.Languages, "Create language files");
-  createCommand(context, Commands.Create.Behaviorpack.Manifests, "Create manifest");
-
-  createCommandWithID(context, Commands.Create.Behaviorpack.Animation_Controller, "Create animation controller", AnimationControllerID);
+  createCommand(context, Commands.Create.Behaviorpack.Languages);
+  createCommand(context, Commands.Create.Behaviorpack.Manifests);
+
+  createCommandWithID(
+    context,
+    Commands.Create.Behaviorpack.Animation_Controller,
+    "Create animation controller",
+    AnimationControllerID
+  );
   createCommandWithID(context, Commands.Create.Behaviorpack.Animation, "Create animation", AnimationID);
   createCommandWithID(context, Commands.Create.Behaviorpack.Block, "Create block", BlockID);
   createCommandWithID(context, Commands.Create.Behaviorpack.Dialogue, "Create dialogue", DialogueID);
@@ -58,34 +63,49 @@ export function activate(context: ExtensionContext): void {
   createCommandWithID(context, Commands.Create.Behaviorpack.Volume, "Create volume", VolumeID);
 
   //Resource pack
-  createCommand(context, Commands.Create.Resourcepack.Biomes_Client, "Create biomesclient file");
-  createCommand(context, Commands.Create.Resourcepack.Blocks, "Create the blocks file");
-  createCommand(context, Commands.Create.Resourcepack.Flipbook_Textures, "Create flipbook_textures file");
-  createCommand(context, Commands.Create.Resourcepack.Item_Texture, "Create item tereate item texture file");
-  createCommand(context, Commands.Create.Resourcepack.Languages, "Create lanreate language file");
-  createCommand(context, Commands.Create.Resourcepack.Manifests, "Creatreate all manifest");
-  createCommand(context, Commands.Create.Resourcepack.Music_Definitions, "Create the music definireate the music definitions file");
-  createCommand(context, Commands.Create.Resourcepack.Sound_Definitions, "Create the sound definireate the sound definitions file");
-  createCommand(context, Commands.Create.Resourcepack.Sounds, "Create the sreate the sounds file");
-  createCommand(context, Commands.Create.Resourcepack.Terrain_Texture, "Create the terrain texture file");
-  createCommand(context, Commands.Create.Resourcepack.Texture_List, "Create texturelist");
-
-  createCommandWithID(context, Commands.Create.Resourcepack.Animation_Controller, "Create animation controllers files", AnimationControllerID);
+  createCommand(context, Commands.Create.Resourcepack.Biomes_Client);
+  createCommand(context, Commands.Create.Resourcepack.Blocks);
+  createCommand(context, Commands.Create.Resourcepack.Flipbook_Textures);
+  createCommand(context, Commands.Create.Resourcepack.Item_Texture);
+  createCommand(context, Commands.Create.Resourcepack.Languages);
+  createCommand(context, Commands.Create.Resourcepack.Manifests);
+  createCommand(context, Commands.Create.Resourcepack.Music_Definitions);
+  createCommand(context, Commands.Create.Resourcepack.Sound_Definitions);
+  createCommand(context, Commands.Create.Resourcepack.Sounds);
+  createCommand(context, Commands.Create.Resourcepack.Terrain_Texture);
+  createCommand(context, Commands.Create.Resourcepack.Texture_List);
+
+  createCommandWithID(
+    context,
+    Commands.Create.Resourcepack.Animation_Controller,
+    "Create animation controllers files",
+    AnimationControllerID
+  );
   createCommandWithID(context, Commands.Create.Resourcepack.Animation, "Create animations files", AnimationID);
   createCommandWithID(context, Commands.Create.Resourcepack.Attachable, "Create attachable files", AttachableID);
-  createCommandWithID(context, Commands.Create.Resourcepack.BlockCulling, "Create the block culling rule file", BlockCullingRuleID)
+  createCommandWithID(
+    context,
+    Commands.Create.Resourcepack.BlockCulling,
+    "Create the block culling rule file",
+    BlockCullingRuleID
+  );
   createCommandWithID(context, Commands.Create.Resourcepack.Entity, "Create entities files", EntityID);
   createCommandWithID(context, Commands.Create.Resourcepack.Fog, "Create fog file", FogID);
   createCommandWithID(context, Commands.Create.Resourcepack.Model, "Create reate model file", ModelID);
   createCommandWithID(context, Commands.Create.Resourcepack.Particle, "Create particle file", ParticleID);
-  createCommandWithID(context, Commands.Create.Resourcepack.Render_Controller, "Create render_controller file", RenderControllerID);
+  createCommandWithID(
+    context,
+    Commands.Create.Resourcepack.Render_Controller,
+    "Create render_controller file",
+    RenderControllerID
+  );
 
   //World
-  createCommand(context, Commands.Create.World.Languages, "Create language files");
-  createCommand(context, Commands.Create.World.Manifests, "Create manifest");
+  createCommand(context, Commands.Create.World.Languages);
+  createCommand(context, Commands.Create.World.Manifests);
 }
 
-function createCommand(context: ExtensionContext, command: string, title: string) {
+function createCommand(context: ExtensionContext, command: string) {
   context.subscriptions.push(
     commands.registerCommand(command, (arg: any[]) => {
       onCommandComplete(command, arg);

client/src/commands/languages.ts

@@ -7,15 +7,15 @@ export function activate(context: ExtensionContext): void {
   context.subscriptions.push(commands.registerCommand(Commands.AddLanguageFile, addAll));
 }
 
-function addAll(args: any): any {
+function addAll(): any {
   const ed = window.activeTextEditor;
 
   if (!ed) return;
-  const Current = ed.document.uri.path;
-  const Params: ExecuteCommandParams = {
+  const current = ed.document.uri.path;
+  const params: ExecuteCommandParams = {
     command: Commands.AddLanguageFile,
-    arguments: [Current],
+    arguments: [current],
   };
 
-  return Manager.Client.sendRequest(ExecuteCommandRequest.type, Params);
+  return Manager.Client.sendRequest(ExecuteCommandRequest.type, params);
 }

client/src/commands/open-lastest.ts

@@ -8,7 +8,7 @@ export function activate(context: ExtensionContext): void {
   context.subscriptions.push(commands.registerCommand(Commands.Errors.OpenLastest, openLastestError));
 }
 
-function openLastestError(args: any): void {
+function openLastestError(): void {
   try {
     let APPDATA = process.env.APPDATA;
 
@@ -33,7 +33,7 @@ function openLastestError(args: any): void {
       }
     }
   } catch (error) {
-    handleError(error);
+    window.showErrorMessage("error retrieving errors", JSON.stringify(error));
   }
 }
 
@@ -68,6 +68,3 @@ function findLastestLog(folder: string): void {
     window.showInformationMessage("Couldn't find content logs");
   }
 }
-function handleError(error: unknown) {
-  throw new Error("Function not implemented.");
-}

client/src/commands/show-docs.ts

@@ -1,11 +1,11 @@
 import { commands, ExtensionContext, FileType, ProgressLocation, Uri, window, workspace } from "vscode";
 import { Commands } from "@blockception/shared";
-import { Console } from '../console/console';
+import { Console } from "../console/console";
 
 import path from "path";
 
 export function activate(context: ExtensionContext): void {
-  async function showDocs(args: any) {
+  async function showDocs() {
     const base = context.storageUri || context.globalStorageUri;
     const storage_path = path.join(base.fsPath, "docs");
     const command = new ShowDocsCommand(storage_path);
@@ -141,7 +141,7 @@ class ShowDocsCommand {
 
       return diff <= day_diff_2;
     } catch (err) {
-      Console.errror(`Failed to read file ${filepath}`, )
+      Console.errror(`Failed to read file ${filepath}`, err);
     }
 
     return false;
@@ -234,7 +234,7 @@ class ShowDocsCommand {
       // Open the markdown preview
       await commands.executeCommand("markdown.showPreview", uri);
     } catch (err) {
-      window.showErrorMessage("Failed to open docs", filepath);
+      window.showErrorMessage("Failed to open docs", filepath, JSON.stringify(err));
     }
   }
 }
@@ -256,4 +256,4 @@ namespace Sidebar {
   export function is(item: any): item is Sidebar {
     return item && item.items && Array.isArray(item.items);
   }
-}
+}

client/src/commands/show-vanilla-file.ts

@@ -4,7 +4,7 @@ import { GithubFiles } from "bc-minecraft-bedrock-vanilla-data/lib/src/Lib/Vanil
 import path from "path";
 
 export function activate(context: ExtensionContext): void {
-  async function showVanillaFile(args: any) {
+  async function showVanillaFile() {
     const base = context.storageUri || context.globalStorageUri;
     const storage_path = path.join(base.fsPath, "vanilla");
     const command = new ShowVanillaFileCommand(storage_path);
@@ -55,6 +55,7 @@ class ShowVanillaFileCommand {
 
       return diff <= day_diff_2;
     } catch (err) {
+      console.log("trouble during checking of file", err);
       return false;
     }
   }
@@ -115,7 +116,7 @@ class ShowVanillaFileCommand {
       const doc = await workspace.openTextDocument(Uri.file(filepath));
       await window.showTextDocument(doc);
     } catch (err) {
-      window.showErrorMessage("Failed to open vanilla file", filepath);
+      window.showErrorMessage("Failed to open vanilla file", filepath, JSON.stringify(err));
     }
   }
 }

eslint.config.mjs

@@ -0,0 +1,26 @@
+import eslint from "@eslint/js";
+import tseslint from "typescript-eslint";
+
+export default tseslint.config(
+  {
+    files: ["**/*.ts"],
+    ignores: [
+      "client/out/**/*",
+      "shared/out/**/*",
+      "server/out/**/*",
+      "node_modules/**/*",
+      "minecraft-bedrock-schemas/**/*",
+    ],
+    extends: [eslint.configs.recommended, ...tseslint.configs.recommended],
+    plugins: {
+      jest: {},
+    },
+  },
+  {
+    rules: {
+      "@typescript-eslint/no-namespace": "off",
+      "@typescript-eslint/no-explicit-any": "off",
+      "no-case-declarations": "off",
+    },
+  }
+);