Perfect the codebase for wamr-ide (#1817)

Fix errors and warnings reported by eslint
Add CONTRIBUTING document for vscode-extension

Author: NingW101

test-tools/wamr-ide/VSCode-Extension/.eslintrc.json

@@ -1,13 +1,12 @@
 {
     "root": true,
     "parser": "@typescript-eslint/parser",
+    "extends": ["plugin:@typescript-eslint/recommended"],
     "parserOptions": {
-        "ecmaVersion": 6,
+        "ecmaVersion": "latest",
         "sourceType": "module"
     },
-    "plugins": [
-        "@typescript-eslint"
-    ],
+    "plugins": ["@typescript-eslint"],
     "rules": {
         "@typescript-eslint/naming-convention": "warn",
         "@typescript-eslint/semi": "warn",
@@ -16,9 +15,5 @@
         "no-throw-literal": "warn",
         "semi": "off"
     },
-    "ignorePatterns": [
-        "out",
-        "dist",
-        "**/*.d.ts"
-    ]
+    "ignorePatterns": ["out", "dist", "**/*.d.ts"]
 }

test-tools/wamr-ide/VSCode-Extension/CONTRIBUTING.md

@@ -0,0 +1,34 @@
+# CONTRIBUTING
+
+## Pull requests
+
+To submit your change:
+
+-   Make sure your code is in line with our
+    [coding conventions](##Coding-conventions).
+-   Create an [issue] describing the bug the PR fixes or the feature you intend
+    to implement.
+-   Submit a [pull request] into the main branch.
+
+## Coding conventions
+
+#### Format
+
+The codebase is formatted by `Prettier` and the `.prettierrc.json` has been
+configured.
+
+-   VSCode along with `Format on Save` configuration could easily format your
+    code during development.
+-   You can run `prettier-format-check` and `prettier-format-apply` to check and
+    format your codebase with `prettier` in terminal.
+
+#### Lint
+
+`ESlint` is used as linter for the codebase and the `.eslintrc.json` has been
+configured.
+
+-   It's suggested to run `npm run lint` then fix errors and warnings before
+    committing.
+
+[issue]: https://github.com/bytecodealliance/wasm-micro-runtime/issues
+[pull request]: https://github.com/bytecodealliance/wasm-micro-runtime/pulls

test-tools/wamr-ide/VSCode-Extension/package.json

@@ -229,6 +229,7 @@
         "watch": "tsc -watch -p ./",
         "pretest": "npm run compile && npm run lint",
         "lint": "eslint src --ext ts",
+        "lint-fix": "eslint --fix src --ext ts",
         "test": "node ./out/test/runTest.js",
         "prettier-format-check": "prettier --config .prettierrc.json 'src/**/*.ts' --check",
         "prettier-format-apply": "prettier --config .prettierrc.json 'src/**/*.ts' --write"

test-tools/wamr-ide/VSCode-Extension/resource/webview/js/configbuildtarget.js

@@ -3,7 +3,6 @@
  * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
  */
 
-
 const vscode = acquireVsCodeApi();
 
 document.getElementById('btn_submit').onclick = () => {
@@ -12,16 +11,16 @@ document.getElementById('btn_submit').onclick = () => {
 
 function submitFunc() {
     let outputFileName = document.getElementById('output_file_name').value;
-    let initmemSize = document.getElementById('initial_mem_size').value;
-    let maxmemSize = document.getElementById('max_mem_size').value;
+    let initMemSize = document.getElementById('initial_mem_size').value;
+    let maxMemSize = document.getElementById('max_mem_size').value;
     let stackSize = document.getElementById('stack_size').value;
     let exportedSymbols = document.getElementById('exported_symbols').value;
 
     vscode.postMessage({
         command: 'config_build_target',
         outputFileName: outputFileName,
-        initmemSize: initmemSize,
-        maxmemSize: maxmemSize,
+        initMemSize: initMemSize,
+        maxMemSize: maxMemSize,
         stackSize: stackSize,
         exportedSymbols: exportedSymbols,
     });

test-tools/wamr-ide/VSCode-Extension/src/debugConfigurationProvider.ts

@@ -9,8 +9,6 @@ import * as os from 'os';
 export class WasmDebugConfigurationProvider
     implements vscode.DebugConfigurationProvider
 {
-    constructor() {}
-
     /* default port set as 1234 */
     private port = 1234;
     private hostPath!: string;
@@ -29,7 +27,7 @@ export class WasmDebugConfigurationProvider
         return this.providerPromise;
     }
 
-    public setDebugConfig(hostPath: string, port: number) {
+    public setDebugConfig(hostPath: string, port: number): void {
         this.port = port;
         this.hostPath = hostPath;
         /* linux and windows has different debug configuration */
@@ -57,7 +55,7 @@ export class WasmDebugConfigurationProvider
         }
     }
 
-    public getDebugConfig() {
+    public getDebugConfig(): vscode.DebugConfiguration {
         return this.wasmDebugConfig;
     }
 }

test-tools/wamr-ide/VSCode-Extension/src/decorationProvider.ts

@@ -26,11 +26,11 @@ export class DecorationProvider implements vscode.FileDecorationProvider {
     public onDidChangeFileDecorations: vscode.Event<
         vscode.Uri | vscode.Uri[] | undefined
     >;
-    private _eventEmiter: vscode.EventEmitter<vscode.Uri | vscode.Uri[]>;
+    private eventEmitter: vscode.EventEmitter<vscode.Uri | vscode.Uri[]>;
 
     constructor() {
-        this._eventEmiter = new vscode.EventEmitter();
-        this.onDidChangeFileDecorations = this._eventEmiter.event;
+        this.eventEmitter = new vscode.EventEmitter();
+        this.onDidChangeFileDecorations = this.eventEmitter.event;
         this.disposables.push(
             vscode.window.registerFileDecorationProvider(this)
         );
@@ -39,34 +39,27 @@ export class DecorationProvider implements vscode.FileDecorationProvider {
     public provideFileDecoration(
         uri: vscode.Uri
     ): vscode.ProviderResult<vscode.FileDecoration> {
-        let currentPrjDir,
-            prjConfigDir,
-            configFilePath,
-            configData,
-            includePathArr = new Array(),
-            excludeFileArr = new Array(),
-            pathRelative;
-
-        /* Read include_paths and exclude_fils from the config file */
-        currentPrjDir =
+        const currentPrjDir =
             os.platform() === 'win32'
                 ? (vscode.workspace.workspaceFolders?.[0].uri.fsPath as string)
                 : os.platform() === 'linux' || os.platform() === 'darwin'
-                ? (currentPrjDir = vscode.workspace.workspaceFolders?.[0].uri
-                      .path as string)
+                ? (vscode.workspace.workspaceFolders?.[0].uri.path as string)
                 : '';
 
-        pathRelative = (uri.fsPath ? uri.fsPath : uri.toString()).replace(
+        const pathRelative = (uri.fsPath ? uri.fsPath : uri.toString()).replace(
             currentPrjDir,
             '..'
         );
 
-        prjConfigDir = path.join(currentPrjDir, '.wamr');
-        configFilePath = path.join(prjConfigDir, 'compilation_config.json');
+        const prjConfigDir = path.join(currentPrjDir, '.wamr');
+        const configFilePath = path.join(
+            prjConfigDir,
+            'compilation_config.json'
+        );
         if (readFromFile(configFilePath) !== '') {
-            configData = JSON.parse(readFromFile(configFilePath));
-            includePathArr = configData['include_paths'];
-            excludeFileArr = configData['exclude_files'];
+            const configData = JSON.parse(readFromFile(configFilePath));
+            const includePathArr = configData['includePaths'];
+            const excludeFileArr = configData['excludeFiles'];
 
             if (includePathArr.indexOf(pathRelative) > -1) {
                 return DECORATION_INCLUDE_PATHS;
@@ -81,7 +74,7 @@ export class DecorationProvider implements vscode.FileDecorationProvider {
     }
 
     public updateDecorationsForSource(uri: vscode.Uri): void {
-        this._eventEmiter.fire(uri);
+        this.eventEmitter.fire(uri);
     }
 }