New eslint

.eslintignore

@@ -0,0 +1,10 @@
+docs
+the_azle_book
+type_tests
+run_time_errors
+**/webpack.config.js
+dfx_generate
+dfx_generated
+declarations
+property_tests/tests/**/src/*
+dist

.eslintrc.js

@@ -0,0 +1,52 @@
+module.exports = {
+    env: {
+        es2021: true,
+        node: true
+    },
+    extends: [
+        'eslint:recommended',
+        'plugin:@typescript-eslint/recommended',
+        'prettier'
+    ],
+    overrides: [
+        {
+            env: {
+                node: true
+            },
+            files: ['.eslintrc.{js,cjs}'],
+            parserOptions: {
+                sourceType: 'script'
+            }
+        }
+    ],
+    parser: '@typescript-eslint/parser',
+    parserOptions: {
+        ecmaVersion: 'latest',
+        sourceType: 'module'
+    },
+    plugins: ['@typescript-eslint', 'simple-import-sort'],
+    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',
+        eqeqeq: 'error',
+        '@typescript-eslint/no-unused-vars': [
+            'error',
+            {
+                argsIgnorePattern: '^_', // Ignore argument variables starting with _
+                varsIgnorePattern: '^_' // Ignore local variables starting with _
+            }
+        ],
+        '@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
+    }
+};

.github/workflows/test.yml

@@ -288,6 +288,9 @@ jobs:
                   git clone https://github.com/demergent-labs/wasmedge-quickjs
                   cd wasmedge-quickjs
                   git checkout c21ff69f442998e4cda4619166e23a9bc91418be
+            - if: ${{ needs.release-candidate-deploy.outputs.should_run_tests }}
+              shell: bash -l {0}
+              run: npm run lint
             - if: ${{ needs.release-candidate-deploy.outputs.should_run_tests }}
               working-directory: ${{ matrix.example_directories }}
               run: dfx start --clean --background --host 127.0.0.1:8000

.gitignore

@@ -1,5 +1,6 @@
 .dfx
 .DS_Store
+.eslintcache
 .vscode/*
 !.vscode/extensions.json
 dist

benchmark/index.ts

@@ -1,7 +1,8 @@
 import { execSync } from 'child_process';
-import { create_csv_report } from './csv';
 import { writeFileSync } from 'fs';
+
 import { nat64 } from '../src/lib';
+import { create_csv_report } from './csv';
 import { create_markdown_report } from './markdown';
 import { run_setup } from './setup';
 

benchmark/markdown.ts

@@ -1,6 +1,5 @@
 import { BenchmarkResult, calculate_average } from './index';
 import { get_usd_cost_estimates } from './usd';
-import { USDCostEstimates } from './usd/usd_cost_estimate';
 import {
     USAGE_CONFIG_HEAVY_QUERY_HEAVY,
     USAGE_CONFIG_HEAVY_QUERY_UPDATE_EVEN,
@@ -12,6 +11,7 @@ import {
     USAGE_CONFIG_MODERATE_QUERY_UPDATE_EVEN,
     USAGE_CONFIG_MODERATE_UPDATE_HEAVY
 } from './usd/usage_config';
+import { USDCostEstimates } from './usd/usd_cost_estimate';
 
 export function create_markdown_report(
     benchmark_results: BenchmarkResult[],

benchmark/usd/index.ts

@@ -3,15 +3,15 @@
 // TODO make this configurable per day, week, month, year etc? Or is just per year sufficient?
 
 import {
-    USAGE_CONFIG_LIGHT_QUERY_UPDATE_EVEN,
+    USAGE_CONFIG_HEAVY_QUERY_HEAVY,
+    USAGE_CONFIG_HEAVY_QUERY_UPDATE_EVEN,
+    USAGE_CONFIG_HEAVY_UPDATE_HEAVY,
     USAGE_CONFIG_LIGHT_QUERY_HEAVY,
+    USAGE_CONFIG_LIGHT_QUERY_UPDATE_EVEN,
     USAGE_CONFIG_LIGHT_UPDATE_HEAVY,
-    USAGE_CONFIG_MODERATE_QUERY_UPDATE_EVEN,
     USAGE_CONFIG_MODERATE_QUERY_HEAVY,
-    USAGE_CONFIG_MODERATE_UPDATE_HEAVY,
-    USAGE_CONFIG_HEAVY_QUERY_UPDATE_EVEN,
-    USAGE_CONFIG_HEAVY_QUERY_HEAVY,
-    USAGE_CONFIG_HEAVY_UPDATE_HEAVY
+    USAGE_CONFIG_MODERATE_QUERY_UPDATE_EVEN,
+    USAGE_CONFIG_MODERATE_UPDATE_HEAVY
 } from './usage_config';
 import { get_usd_cost_estimate, USDCostEstimates } from './usd_cost_estimate';
 

bin.js

@@ -1,5 +1,6 @@
 #!/usr/bin/env node
 
+// eslint-disable-next-line @typescript-eslint/no-var-requires
 require('ts-node').register({
     transpileOnly: true,
     ignore: [`node_modules/(?!azle)`],

canisters/icrc/icrc_2.ts

@@ -1,11 +1,10 @@
 import { blob, nat, nat64, Null, Opt, Record, Variant } from '../../src/lib';
-
 import {
-    BadFee,
     BadBurn,
-    InsufficientFunds,
+    BadFee,
     Duplicate,
-    GenericError
+    GenericError,
+    InsufficientFunds
 } from './errors';
 import { Account, CreatedInFuture } from './icrc_1';
 

canisters/icrc/index.ts

@@ -3,11 +3,11 @@ import {
     nat,
     nat8,
     Opt,
-    Record,
     query,
-    update,
+    Record,
     text,
     Tuple,
+    update,
     Vec
 } from '../../src/lib';
 import { Account, TransferArgs, TransferResult, Value } from './icrc_1';

canisters/ledger/address/index.ts

@@ -1,6 +1,7 @@
-import { blob, Principal } from '../../../src/lib';
 import { getCrc32 } from '@dfinity/principal/lib/esm/utils/getCrc';
 import { sha224 } from 'js-sha256';
+
+import { blob, Principal } from '../../../src/lib';
 import { Address } from '../index';
 
 // TODO we need to review these heavily
@@ -73,6 +74,6 @@ function to32Bits(number: number): number[] {
 
 function toHexString(byteArray: Uint8Array): string {
     return Array.from(byteArray, (byte) => {
-        return ('0' + (byte & 0xff).toString(16)).slice(-2);
+        return `0${(byte & 0xff).toString(16)}`.slice(-2);
     }).join('');
 }

canisters/ledger/index.ts

@@ -9,21 +9,21 @@
 import {
     blob,
     Canister,
+    Func,
     nat,
     nat8,
     nat32,
     nat64,
     Null,
     Opt,
-    Record,
+    Principal,
     query,
-    update,
+    Record,
     text,
     Tuple,
+    update,
     Variant,
-    Vec,
-    Principal,
-    Func
+    Vec
 } from '../../src/lib';
 import * as icrc from '../icrc';
 

canisters/management/canister_info.ts

@@ -5,16 +5,17 @@
 // Some documentation changed from original work.
 
 import {
-    Record,
+    nat8,
+    nat64,
+    Null,
     Opt,
-    Vec,
     Principal,
+    Record,
     Variant,
-    nat64,
-    nat8,
-    Null
+    Vec
 } from '../../src/lib';
-import { managementCanister } from '.';
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+import { managementCanister } from '.'; // Used for links in comments
 
 /** Argument type of {@link managementCanister.canister_info}. */
 export const CanisterInfoArgs = Record({

canisters/management/canister_management.ts

@@ -1,13 +1,13 @@
 import {
-    Record,
+    blob,
+    nat,
+    nat64,
+    Null,
     Opt,
-    Vec,
     Principal,
-    nat,
+    Record,
     Variant,
-    Null,
-    blob,
-    nat64
+    Vec
 } from '../../src/lib';
 
 export const CanisterId = Principal;

canisters/management/http_request.ts

@@ -1,14 +1,14 @@
 import {
     blob,
-    Record,
+    Func,
+    nat,
+    nat64,
+    Null,
     Opt,
-    Vec,
-    Variant,
+    Record,
     text,
-    Null,
-    nat64,
-    nat,
-    Func
+    Variant,
+    Vec
 } from '../../src/lib';
 
 export const HttpHeader = Record({

dfx/index.ts

@@ -1,6 +1,6 @@
-import { execSync } from 'child_process';
-import { Secp256k1KeyIdentity } from '@dfinity/identity-secp256k1';
 import { HttpAgent } from '@dfinity/agent';
+import { Secp256k1KeyIdentity } from '@dfinity/identity-secp256k1';
+import { execSync } from 'child_process';
 
 export function getCanisterId(canisterName: string): string {
     return execSync(

examples/apollo_server/test/test.ts

@@ -1,5 +1,6 @@
 import { getCanisterId } from 'azle/dfx';
 import { runTests } from 'azle/test';
+
 import { getTests } from './tests';
 
 const canisterId = getCanisterId('apollo_server');

examples/async_await/src/async_await.ts

@@ -1,4 +1,4 @@
-import { blob, Canister, ic, serialize, update, Void } from 'azle';
+import { blob, Canister, ic, update, Void } from 'azle';
 import { managementCanister } from 'azle/canisters/management';
 
 export default Canister({

examples/async_await/test/test.ts

@@ -1,5 +1,6 @@
 import { getCanisterId } from 'azle/dfx';
 import { runTests } from 'azle/test';
+
 import { createActor } from './dfx_generated/async_await';
 import { get_tests } from './tests';
 

examples/async_await/test/tests.ts

@@ -1,6 +1,7 @@
+import { ActorSubclass } from '@dfinity/agent';
 import { Test } from 'azle/test';
+
 import { _SERVICE } from './dfx_generated/async_await/async_await.did';
-import { ActorSubclass } from '@dfinity/agent';
 
 export function get_tests(
     async_await_canister: ActorSubclass<_SERVICE>

examples/audio_and_video/test/test.ts

@@ -1,5 +1,6 @@
 import { getCanisterId } from 'azle/dfx';
 import { runTests } from 'azle/test';
+
 import { getTests } from './tests';
 
 const canisterId = getCanisterId('backend');

examples/audio_recorder/src/index.ts

@@ -1,8 +1,8 @@
 import {
     blob,
     Canister,
-    ic,
     Err,
+    ic,
     nat64,
     Ok,
     Opt,

examples/audio_recorder/test/test.ts

@@ -1,5 +1,6 @@
 import { getCanisterId } from 'azle/dfx';
 import { runTests } from 'azle/test';
+
 import { createActor } from '../test/dfx_generated/audio_recorder';
 import { get_tests } from './tests';
 

examples/audio_recorder/test/tests.ts

@@ -1,6 +1,7 @@
+import { ActorSubclass } from '@dfinity/agent';
 import { ok, Test } from 'azle/test';
+
 import { _SERVICE } from './dfx_generated/audio_recorder/audio_recorder.did';
-import { ActorSubclass } from '@dfinity/agent';
 
 // TODO to be more thorough we could test all of the error cases as well
 

examples/autoreload/test/pretest.ts

@@ -1,5 +1,6 @@
 import { execSync } from 'child_process';
 import { writeFileSync } from 'fs';
+
 import { originalServerTs } from './tests';
 
 async function pretest() {

examples/autoreload/test/test.ts

@@ -1,5 +1,6 @@
 import { getCanisterId } from 'azle/dfx';
 import { runTests } from 'azle/test';
+
 import { getTests } from './tests';
 
 const canisterId = getCanisterId('autoreload');

examples/basic_bitcoin/src/bitcoin_api.ts

@@ -1,12 +1,12 @@
 // @ts-nocheck
 
 import { blob, ic, match, nat64, Opt, Vec } from 'azle';
+import { managementCanister } from 'azle/canisters/management';
 import {
     BitcoinNetwork,
     GetUtxosResult,
     MillisatoshiPerByte
 } from 'azle/canisters/management/bitcoin';
-import { managementCanister } from 'azle/canisters/management';
 
 // The fees for the various bitcoin endpoints.
 const GET_BALANCE_COST_CYCLES: nat64 = 100_000_000n;

examples/basic_bitcoin/src/bitcoin_wallet.ts

@@ -9,7 +9,7 @@
 //! * Support for address types that aren't P2PKH.
 //! * Caching spent UTXOs so that they are not reused in future transactions.
 //! * Option to set the fee.
-import { blob, ic, nat64, match, Result, Vec } from 'azle';
+import { blob, ic, match, nat64, Result, Vec } from 'azle';
 import {
     BitcoinNetwork,
     MillisatoshiPerByte,
@@ -137,6 +137,7 @@ async function buildTransaction(
     // rebuild the transaction, until the fee is set to the correct amount.
     console.log('Building transaction...');
     let totalFee = 0n;
+    // eslint-disable-next-line no-constant-condition
     while (true) {
         const transaction = match(
             buildTransactionWithFee(