feat: add eslint to be run pre commit (#3261)

* Adds linting rules and lint script to all the packages; foundation for running pre commit hook Signed-off-by: Konstantina Blazhukova <[email protected]> * Removes license header rule and uninstalls unecessary plugin Signed-off-by: Konstantina Blazhukova <[email protected]> * tests Signed-off-by: Konstantina Blazhukova <[email protected]> * test import sorting Signed-off-by: Konstantina Blazhukova <[email protected]> * Adds trailing comma rule Signed-off-by: Konstantina Blazhukova <[email protected]> * remove unecessary test changes from test file Signed-off-by: Konstantina Blazhukova <[email protected]> * Removes leftover variable Signed-off-by: Konstantina Blazhukova <[email protected]> --------- Signed-off-by: Konstantina Blazhukova <[email protected]>
hashgraph · Nov 15, 2024 · 51eeeba · 51eeeba
1 parent 2791784
commit 51eeeba
Show file tree

Hide file tree

Showing 5 changed files with 73 additions and 50 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -17,53 +17,52 @@
  * limitations under the License.
  *
  */
-const path = require('path');
 
 module.exports = {
     "env": {
         "node": true,
-        "es2021": true
+        "es2021": true,
     },
     "extends": [
         "eslint:recommended",
         "plugin:@typescript-eslint/recommended",
-        "prettier"
+        "prettier",
     ],
+    "plugins": ["simple-import-sort"],
     "overrides": [
         {
             "env": {
-                "node": true
+                "node": true,
             },
             "files": [
-                ".eslintrc.{js,cjs}"
+                ".eslintrc.{js,cjs}",
             ],
             "parserOptions": {
-                "sourceType": "script"
-            }
-        }
+                "sourceType": "script",
+            },
+        },
     ],
     "parserOptions": {
         "ecmaVersion": "latest",
-        "sourceType": "module"
+        "sourceType": "module",
     },
     "rules": {
         "@typescript-eslint/ban-ts-comment": "off",
-        "@typescript-eslint/no-empty-interface": "off",
         "@typescript-eslint/no-explicit-any": "off",
-        "@typescript-eslint/semi": "off",
         "@typescript-eslint/no-var-requires": "warn",
+        "@typescript-eslint/no-unused-vars": "warn",
         "@typescript-eslint/ban-types": "warn",
         "no-trailing-spaces": "error",
-        "no-prototype-builtins": "warn",
+        "no-useless-escape": "warn",
         "prefer-const": "error",
-        "no-unsafe-optional-chaining": "warn",
-        "comma-dangle": [2, "only-multiline"],
-        "semi": [2, "always"],
-        "sort-imports": ["error", {
-            "ignoreCase": true,
-            "ignoreDeclarationSort": true,
-            "ignoreMemberSort": false,
-            "memberSyntaxSortOrder": ["none", "all", "multiple", "single"],
+        "comma-dangle": ["error", {
+            "arrays": "always-multiline",
+            "objects": "always-multiline",
+            "imports": "always-multiline",
+            "exports": "always-multiline",
+            "functions": "always-multiline",
         }],
+        "simple-import-sort/imports": "error",
+        "simple-import-sort/exports": "off",
     },
 };
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -1,4 +1,4 @@
 #!/usr/bin/env sh
 . "$(dirname -- "$0")/_/husky.sh"
 
-npx lint-staged
+npx lint-staged --verbose
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -23,6 +23,7 @@
     "eslint-config-standard-with-typescript": "^43.0.1",
     "eslint-plugin-import": "^2.28.1",
     "eslint-plugin-n": "^15.7.0",
+    "eslint-plugin-simple-import-sort": "^12.1.1",
     "ethereum-waffle": "^4.0.7",
     "husky": "^8.0.3",
     "ioredis": "^5.3.2",
@@ -104,15 +105,19 @@
   },
   "lint-staged": {
     "packages/**/src/**/*.ts": [
+      "eslint --fix",
       "prettier --write"
     ],
     "packages/**/tests/**/*.ts": [
+      "eslint --fix",
       "prettier --write"
     ],
     "!(packages/**/dist/)*.ts": [
+      "eslint --fix",
       "prettier --write"
     ],
     "!(packages/**/node_modules/)*.ts": [
+      "eslint --fix",
       "prettier --write"
     ]
   },

diff --git a/packages/relay/tests/lib/sdkClient.spec.ts b/packages/relay/tests/lib/sdkClient.spec.ts
@@ -18,32 +18,6 @@
  *
  */
 
-import pino from 'pino';
-import Long from 'long';
-import { expect } from 'chai';
-import * as sinon from 'sinon';
-import EventEmitter from 'events';
-import { Utils } from '../../src/utils';
-import axios, { AxiosInstance } from 'axios';
-import MockAdapter from 'axios-mock-adapter';
-import constants from '../../src/lib/constants';
-import { register, Registry } from 'prom-client';
-import { RequestDetails } from '../../src/lib/types';
-import { formatTransactionId } from '../../src/formatters';
-import { MirrorNodeClient, SDKClient } from '../../src/lib/clients';
-import HAPIService from '../../src/lib/services/hapiService/hapiService';
-import { HbarLimitService } from '../../src/lib/services/hbarLimitService';
-import MetricService from '../../src/lib/services/metricService/metricService';
-import { CacheService } from '../../src/lib/services/cacheService/cacheService';
-import {
-  calculateTxRecordChargeAmount,
-  overrideEnvsInMochaDescribe,
-  random20BytesAddress,
-  withOverriddenEnvsInMochaTest,
-} from '../helpers';
-import { HbarSpendingPlanRepository } from '../../src/lib/db/repositories/hbarLimiter/hbarSpendingPlanRepository';
-import { IPAddressHbarSpendingPlanRepository } from '../../src/lib/db/repositories/hbarLimiter/ipAddressHbarSpendingPlanRepository';
-import { EthAddressHbarSpendingPlanRepository } from '../../src/lib/db/repositories/hbarLimiter/ethAddressHbarSpendingPlanRepository';
 import { ConfigService } from '@hashgraph/json-rpc-config-service/dist/services';
 import {
   AccountId,
@@ -64,7 +38,34 @@ import {
   TransactionRecordQuery,
   TransactionResponse,
 } from '@hashgraph/sdk';
+import axios, { AxiosInstance } from 'axios';
+import MockAdapter from 'axios-mock-adapter';
+import { expect } from 'chai';
+import EventEmitter from 'events';
+import Long from 'long';
 import { Context } from 'mocha';
+import pino from 'pino';
+import { register, Registry } from 'prom-client';
+import * as sinon from 'sinon';
+
+import { formatTransactionId } from '../../src/formatters';
+import { MirrorNodeClient, SDKClient } from '../../src/lib/clients';
+import constants from '../../src/lib/constants';
+import { EthAddressHbarSpendingPlanRepository } from '../../src/lib/db/repositories/hbarLimiter/ethAddressHbarSpendingPlanRepository';
+import { HbarSpendingPlanRepository } from '../../src/lib/db/repositories/hbarLimiter/hbarSpendingPlanRepository';
+import { IPAddressHbarSpendingPlanRepository } from '../../src/lib/db/repositories/hbarLimiter/ipAddressHbarSpendingPlanRepository';
+import { CacheService } from '../../src/lib/services/cacheService/cacheService';
+import HAPIService from '../../src/lib/services/hapiService/hapiService';
+import { HbarLimitService } from '../../src/lib/services/hbarLimitService';
+import MetricService from '../../src/lib/services/metricService/metricService';
+import { RequestDetails } from '../../src/lib/types';
+import { Utils } from '../../src/utils';
+import {
+  calculateTxRecordChargeAmount,
+  overrideEnvsInMochaDescribe,
+  random20BytesAddress,
+  withOverriddenEnvsInMochaTest,
+} from '../helpers';
 
 const registry = new Registry();
 const logger = pino();
@@ -181,7 +182,7 @@ describe('SdkClient', async function () {
 
     it('executes the query', async () => {
       queryStub.returns(successResponse);
-      let { resp, cost } = await sdkClient.increaseCostAndRetryExecution(
+      const { resp, cost } = await sdkClient.increaseCostAndRetryExecution(
         contractCallQuery,
         baseCost,
         client,
@@ -200,7 +201,7 @@ describe('SdkClient', async function () {
       });
 
       queryStub.onCall(1).returns(successResponse);
-      let { resp, cost } = await sdkClient.increaseCostAndRetryExecution(
+      const { resp, cost } = await sdkClient.increaseCostAndRetryExecution(
         contractCallQuery,
         baseCost,
         client,
@@ -224,7 +225,7 @@ describe('SdkClient', async function () {
 
       queryStub.onCall(2).returns(successResponse);
 
-      let { resp, cost } = await sdkClient.increaseCostAndRetryExecution(
+      const { resp, cost } = await sdkClient.increaseCostAndRetryExecution(
         contractCallQuery,
         baseCost,
         client,