update eslint

demergent-labs · Dec 12, 2024 · dc239c3 · dc239c3
1 parent 298c8a4
commit dc239c3
Show file tree

Hide file tree

Showing 25 changed files with 149 additions and 140 deletions.
diff --git a/.eslintignore b/.eslintignore
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
diff --git a/.github/actions/get_test_infos/discover_test_dirs.ts b/.github/actions/get_test_infos/discover_test_dirs.ts
@@ -1,4 +1,4 @@
-import { readFile, readdir } from 'fs/promises';
+import { readdir, readFile } from 'fs/promises';
 import { join } from 'path';
 
 // Recursively find directories and check for package.json with a test script

diff --git a/.github/actions/get_test_infos/get_test_infos.ts b/.github/actions/get_test_infos/get_test_infos.ts
@@ -1,5 +1,5 @@
-import { discoverTestDirs } from './discover_test_dirs.js';
 import { dirToTestInfo, TestInfo } from './dir_to_test_info.js';
+import { discoverTestDirs } from './discover_test_dirs.js';
 
 export async function getTestInfos(
     dirs: string[],

diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -0,0 +1,72 @@
+import eslint from '@eslint/js';
+import tseslintParser from '@typescript-eslint/parser';
+import prettier from 'eslint-config-prettier';
+import simpleImportSort from 'eslint-plugin-simple-import-sort';
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config(
+    eslint.configs.recommended,
+    tseslint.configs.recommended,
+    prettier,
+    {
+        ignores: [
+            'docs/**',
+            'the_azle_book/**',
+            'tests/property/candid_rpc/**/src/**',
+            '**/.azle/**',
+            '**/.dfx/**',
+            '**/declarations/**',
+            '**/dfx_generate/**',
+            '**/dfx_generated/**',
+            '**/dist/**',
+            '**/node_modules/**',
+            '**/run_time_errors/**',
+            '**/target/**',
+            '**/webpack.config.js'
+        ]
+    },
+    {
+        files: ['**/*.{js,mjs,cjs,ts}'],
+        languageOptions: {
+            parser: tseslintParser,
+            parserOptions: {
+                ecmaVersion: 'latest',
+                sourceType: 'module'
+            }
+        },
+        plugins: {
+            'simple-import-sort': simpleImportSort
+        },
+        rules: {
+            'simple-import-sort/exports': 'error',
+            'simple-import-sort/imports': 'error',
+            'func-style': [
+                'error',
+                'declaration',
+                { allowArrowFunctions: true }
+            ],
+            'array-callback-return': 'error',
+            'no-template-curly-in-string': 'error',
+            'prefer-template': 'error',
+            'no-param-reassign': 'error',
+            '@typescript-eslint/prefer-for-of': 'error',
+            'prefer-arrow-callback': 'error',
+            'no-var': 'error',
+            '@typescript-eslint/explicit-function-return-type': ['error'],
+            eqeqeq: 'error',
+            '@typescript-eslint/no-unused-vars': [
+                'error',
+                {
+                    argsIgnorePattern: '^_',
+                    caughtErrorsIgnorePattern: '^_',
+                    destructuredArrayIgnorePattern: '^_',
+                    varsIgnorePattern: '^_'
+                }
+            ],
+            '@typescript-eslint/ban-ts-comment': 'off',
+            'prefer-const': 'off', // For azle let is used to indicate mutability not only re-assignability
+            'no-undef': 'off', // TS compiler handles this for us
+            '@typescript-eslint/no-explicit-any': 'off' // TODO https://github.com/demergent-labs/azle/issues/1737
+        }
+    }
+);
diff --git a/examples/basic_bitcoin/src/bitcoin_wallet.ts b/examples/basic_bitcoin/src/bitcoin_wallet.ts
@@ -130,7 +130,6 @@ async function buildTransaction(
     // rebuild the transaction, until the fee is set to the correct amount.
     console.info('Building transaction...');
     let totalFee = 0n;
-    // eslint-disable-next-line no-constant-condition
     while (true) {
         const transaction = buildTransactionWithFee(
             ownUtxos,

diff --git a/examples/bitcoin_psbt/src/bitcoin_wallet.ts b/examples/bitcoin_psbt/src/bitcoin_wallet.ts
@@ -127,7 +127,6 @@ async function buildTransaction(
     // rebuild the transaction, until the fee is set to the correct amount.
     console.info('Building transaction...');
     let totalFee = 0n;
-    // eslint-disable-next-line no-constant-condition
     while (true) {
         const transaction = buildTransactionWithFee(
             ownUtxos,

diff --git a/package.json b/package.json
@@ -4,7 +4,7 @@
     "description": "TypeScript and JavaScript CDK for the Internet Computer",
     "scripts": {
         "typecheck": "tsc --noEmit",
-        "lint": "if [ \"$npm_config_fix\" ]; then eslint . --ext .js,.ts --cache --fix; else eslint . --ext .js,.ts --cache; fi",
+        "lint": "if [ \"$npm_config_fix\" ]; then eslint . --cache --fix; else eslint . --cache; fi",
         "prepare": "husky",
         "install": "cd dfx_extension && ./install.sh",
         "test": "echo 'test'"
@@ -57,22 +57,26 @@
     },
     "devDependencies": {
         "@dfinity/identity": "^2.1.3",
+        "@eslint/js": "^9.16.0",
         "@types/deep-equal": "^1.0.4",
         "@types/fs-extra": "11.0.4",
         "@types/pako": "^2.0.3",
         "@types/text-encoding": "^0.0.40",
         "@types/uuid": "^10.0.0",
+        "@typescript-eslint/eslint-plugin": "^8.18.0",
+        "@typescript-eslint/parser": "^8.18.0",
         "deep-equal": "^2.2.3",
-        "eslint": "^8.54.0",
-        "eslint-config-prettier": "^8.5.0",
-        "eslint-plugin-simple-import-sort": "^10.0.0",
+        "eslint": "^9.16.0",
+        "eslint-config-prettier": "^9.1.0",
+        "eslint-plugin-simple-import-sort": "^12.1.1",
         "fast-check": "^3.23.1",
         "husky": "9.1.7",
         "jest": "^29.7.0",
         "lint-staged": "15.2.11",
         "prettier": "^3.4.2",
         "puppeteer": "^23.10.3",
-        "ts-jest": "^29.1.4"
+        "ts-jest": "^29.1.4",
+        "typescript-eslint": "^8.18.0"
     },
     "lint-staged": {
         "*.{js,ts}": "eslint --cache --fix",

diff --git a/scripts/jest_isolate_modules.js b/scripts/jest_isolate_modules.js
@@ -1,5 +1,3 @@
-/* eslint-disable @typescript-eslint/explicit-function-return-type */
-
 import * as fs from 'fs';
 import * as path from 'path';
 

diff --git a/src/build/experimental/commands/compile/file_watcher/setup_file_watcher.ts b/src/build/experimental/commands/compile/file_watcher/setup_file_watcher.ts
@@ -20,7 +20,7 @@ export function setupFileWatcher(
         // TODO does not result in a 0 exit code
         // TODO and look into removing the try catch?
         execSyncPretty(`pkill -f ./file_watcher_loader.js || true`);
-    } catch (error) {
+    } catch {
         // For some reason pkill throws even with || true
     }
 

diff --git a/test/property/get_actor.ts b/test/property/get_actor.ts
@@ -13,7 +13,7 @@ export function getActor(parentDir: string, agent?: Agent): any {
     delete require.cache[resolvedPathIndex];
     delete require.cache[resolvedPathDid];
 
-    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    // eslint-disable-next-line @typescript-eslint/no-require-imports
     const { createActor } = require(`${parentDir}/dfx_generated/canister`);
 
     return createActor(getCanisterId('canister'), {

diff --git a/test/property/test/index.ts b/test/property/test/index.ts
@@ -1,7 +1,7 @@
 // TODO import deepEqual from 'deep-is' works for some
 // TODO import { deepEqual } from 'deep-is' works for others
 // TODO require seems to work for all of them
-// eslint-disable-next-line @typescript-eslint/no-var-requires
+// eslint-disable-next-line @typescript-eslint/no-require-imports
 const deepEqual = require('deep-is');
 
 import { jsonStringify } from '../../../src/lib/stable/json';

diff --git a/tests/end_to_end/candid_rpc/class_syntax/rejections/src/rejections/index.ts b/tests/end_to_end/candid_rpc/class_syntax/rejections/src/rejections/index.ts
@@ -47,7 +47,7 @@ export default class {
     async getRejectionCodeDestinationInvalid(): Promise<RejectionCode> {
         try {
             await call('rkp4c-7iaaa-aaaaa-aaaca-cai', 'method');
-        } catch (error) {
+        } catch {
             // continue regardless of error
         }
 
@@ -61,7 +61,7 @@ export default class {
                 paramIdlTypes: [IDL.Text],
                 args: ['reject']
             });
-        } catch (error) {
+        } catch {
             // continue regardless of error
         }
 
@@ -72,7 +72,7 @@ export default class {
     async getRejectionCodeCanisterError(): Promise<RejectionCode> {
         try {
             await call(getSomeCanisterPrincipal(), 'error');
-        } catch (error) {
+        } catch {
             // continue regardless of error
         }
 
@@ -86,7 +86,7 @@ export default class {
                 paramIdlTypes: [IDL.Text],
                 args: [message]
             });
-        } catch (error) {
+        } catch {
             // continue regardless of error
         }
 

diff --git a/tests/end_to_end/candid_rpc/functional_syntax/rejections/src/rejections/index.ts b/tests/end_to_end/candid_rpc/functional_syntax/rejections/src/rejections/index.ts
@@ -53,7 +53,7 @@ export default Canister({
             } else {
                 await ic.call(nonexistentCanister.method);
             }
-        } catch (error) {
+        } catch {
             // continue regardless of error
         }
 
@@ -71,7 +71,7 @@ export default Canister({
             } else {
                 await ic.call(someCanister.reject, { args: ['reject'] });
             }
-        } catch (error) {
+        } catch {
             // continue regardless of error
         }
 
@@ -88,7 +88,7 @@ export default Canister({
             } else {
                 await ic.call(someCanister.error);
             }
-        } catch (error) {
+        } catch {
             // continue regardless of error
         }
 
@@ -106,7 +106,7 @@ export default Canister({
             } else {
                 await ic.call(someCanister.reject, { args: [message] });
             }
-        } catch (error) {
+        } catch {
             // continue regardless of error
         }
 

diff --git a/tests/end_to_end/http_server/tfjs/src/api.ts b/tests/end_to_end/http_server/tfjs/src/api.ts
@@ -9,10 +9,10 @@ async function init(): Promise<void> {
 
     tf.env().platform = {
         fetch,
-        now: () => Number(ic.time()), // TODO time probably off (look into nano vs milli)
-        encode: (text) => Buffer.from(text),
-        decode: (bytes) => Buffer.from(bytes).toString(),
-        isTypedArray: ((array: any) => {
+        now: (): number => Number(ic.time()), // TODO time probably off (look into nano vs milli)
+        encode: (text: string): Buffer => Buffer.from(text),
+        decode: (bytes: Uint8Array): string => Buffer.from(bytes).toString(),
+        isTypedArray: ((array: any): boolean => {
             return (array instanceof Float32Array ||
                 array instanceof Int32Array ||
                 array instanceof Uint8Array ||

diff --git a/tests/property/ic_api/reject_code/src/caller/index.ts b/tests/property/ic_api/reject_code/src/caller/index.ts
@@ -47,7 +47,7 @@ async function getThrowErrorRejectCode(
         await call(rejectorPrincipal, 'throwError', {
             returnIdlType: IDL.Text
         });
-    } catch (error) {
+    } catch {
         return rejectCode();
     }
     throw new Error('This should never be thrown');
@@ -60,7 +60,7 @@ async function getRejectWithMessageRejectCode(
         await call(rejectorPrincipal, 'rejectWithMessage', {
             returnIdlType: IDL.Text
         });
-    } catch (error) {
+    } catch {
         return rejectCode();
     }
     throw new Error('This should never be thrown');

diff --git a/tests/property/ic_api/reject_message/src/caller/index.ts b/tests/property/ic_api/reject_message/src/caller/index.ts
@@ -31,7 +31,7 @@ async function getRejectMessage(
             returnIdlType: IDL.Text,
             args: [message]
         });
-    } catch (error) {
+    } catch {
         return rejectMessage();
     }
     throw new Error('This should never be thrown');

diff --git a/type_tests/candid/constructed/opt.ts b/type_tests/candid/constructed/opt.ts
@@ -20,21 +20,21 @@ import {
 testCandidType(Opt(float32));
 testSerializable(Opt(float32));
 
-const testTypeMapping = Opt(float32);
+const _testTypeMapping = Opt(float32);
 export type TestTypeMapping = AssertType<
     NotAnyAndExact<
-        TypeMapping<typeof testTypeMapping>,
+        TypeMapping<typeof _testTypeMapping>,
         RequireExactlyOne<{ Some: number; None: null }>
     >
 >;
 
 testCandidType(Opt(Opt(float32)));
 testSerializable(Opt(Opt(float32)));
 
-const testTypeMappingDouble = Opt(Opt(float32));
+const _testTypeMappingDouble = Opt(Opt(float32));
 export type TestTypeMappingDouble = AssertType<
     NotAnyAndExact<
-        TypeMapping<typeof testTypeMappingDouble>,
+        TypeMapping<typeof _testTypeMappingDouble>,
         RequireExactlyOne<{
             Some: RequireExactlyOne<{ Some: number; None: null }>;
             None: null;
@@ -45,10 +45,10 @@ export type TestTypeMappingDouble = AssertType<
 testCandidType(Opt(Opt(Opt(float32))));
 testSerializable(Opt(Opt(Opt(float32))));
 
-const testTypeMappingTriple = Opt(Opt(Opt(float32)));
+const _testTypeMappingTriple = Opt(Opt(Opt(float32)));
 export type TestTypeMappingTriple = AssertType<
     NotAnyAndExact<
-        TypeMapping<typeof testTypeMappingTriple>,
+        TypeMapping<typeof _testTypeMappingTriple>,
         RequireExactlyOne<{
             Some: RequireExactlyOne<{
                 Some: RequireExactlyOne<{ Some: number; None: null }>;