chore: update eslint config (#730)

RequestNetwork · Jan 17, 2022 · 4004e56 · 4004e56
1 parent 5fcf8a5
commit 4004e56
Show file tree

Hide file tree

Showing 37 changed files with 112 additions and 75 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -57,7 +57,7 @@ jobs:
           command: yarn format:check
       - run:
           name: Verify lint
-          command: yarn lint
+          command: yarn lint:check
       - run:
           name: Build types
           command: yarn workspace @requestnetwork/types run build
@@ -194,7 +194,7 @@ jobs:
           command: 'yarn workspace @requestnetwork/smart-contracts run deploy'
       - run:
           name: 'Lint smart contracts smart-contracts'
-          command: 'yarn workspace @requestnetwork/smart-contracts run lint:sol'
+          command: 'yarn workspace @requestnetwork/smart-contracts run lint:sol:check'
       - run:
           name: 'Test smart contracts smart-contracts'
           command: 'yarn workspace @requestnetwork/smart-contracts run test'

diff --git a/.eslintrc b/.eslintrc
@@ -1,25 +1,50 @@
 {
   "root": true,
-  "parser": "@typescript-eslint/parser",
-  "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
+  "env": { "browser": true, "node": true },
   "parserOptions": {
-    "project": "tsconfig.json",
     "ecmaVersion": 10,
     "sourceType": "module"
   },
+  "extends": [
+    "eslint:recommended",
+    "prettier"
+  ],
   "plugins": [
-    "eslint-plugin-jsdoc",
-    "eslint-plugin-import",
-    "eslint-plugin-prefer-arrow",
-    "@typescript-eslint"
+    "jsdoc",
+    "import",
+    "prefer-arrow"
   ],
   "rules": {
     "arrow-parens": ["off", "always"],
     "curly": ["error", "all"],
     "complexity": "error",
     "eqeqeq": ["error", "smart"],
-    "import/no-extraneous-dependencies": "error",
-    "@typescript-eslint/no-floating-promises": "error",
-    "@typescript-eslint/no-unused-vars": "error"
-  }
+    "import/no-extraneous-dependencies": "error"
+  },
+  "ignorePatterns": [
+    "/packages/docs/",
+    "/packages/*/dist/",
+    // FIXME: tests should be linted
+    "/packages/*/test/"
+  ],
+  "overrides": [
+    {
+      "files": ["*.ts"],
+      "parser": "@typescript-eslint/parser",
+      "parserOptions": {
+        "project": "tsconfig.json"
+      },
+      "extends": [
+        "plugin:@typescript-eslint/recommended",
+        "prettier"
+      ],
+      "plugins": [
+        "@typescript-eslint"
+      ],
+      "rules": {
+        "@typescript-eslint/no-floating-promises": "error",
+        "@typescript-eslint/no-unused-vars": "error"
+      }
+    }
+  ]
 }
diff --git a/.lintstagedrc.json b/.lintstagedrc.json
@@ -1,6 +1,6 @@
 {
-  "packages/**/src/**/*.ts": [
-    "eslint --fix",
+  "*.[jt]s": [
+    "eslint --fix --quiet",
     "prettier --write"
   ]
-}
+}
diff --git a/package.json b/package.json
@@ -17,7 +17,8 @@
     "build": "lerna run build",
     "clean": "lerna run clean",
     "build:tsc": "tsc -b packages/advanced-logic packages/currency packages/data-access packages/data-format packages/epk-decryption packages/epk-signature packages/ethereum-storage packages/integration-test packages/multi-format packages/payment-detection packages/prototype-estimator packages/request-client.js packages/request-logic packages/request-node packages/smart-contracts packages/toolbox packages/transaction-manager packages/types packages/usage-examples packages/utils packages/web3-signature",
-    "lint": "eslint packages/**/src/**/*.ts --quiet",
+    "lint": "eslint . --fix --quiet",
+    "lint:check": "eslint . --quiet",
     "lint-staged": "lint-staged",
     "lerna": "lerna",
     "packageJsonLint": "npmPkgJsonLint ./packages",
@@ -40,7 +41,6 @@
     "eslint-plugin-import": "2.22.1",
     "eslint-plugin-jsdoc": "32.3.0",
     "eslint-plugin-prefer-arrow": "1.2.3",
-    "eslint-plugin-spellcheck": "0.0.17",
     "husky": "4.3.0",
     "lerna": "3.22.1",
     "lint-staged": "10.5.4",

diff --git a/packages/advanced-logic/package.json b/packages/advanced-logic/package.json
@@ -33,7 +33,8 @@
   "scripts": {
     "build": "tsc -b",
     "clean": "shx rm -rf dist tsconfig.tsbuildinfo",
-    "lint": "eslint \"src/**/*.ts\"",
+    "lint": "eslint . --fix",
+    "lint:check": "eslint .",
     "test": "jest",
     "test:watch": "yarn test --watch"
   },

diff --git a/packages/currency/package.json b/packages/currency/package.json
@@ -34,7 +34,8 @@
   "scripts": {
     "build": "tsc -b",
     "clean": "shx rm -rf dist tsconfig.tsbuildinfo",
-    "lint": "eslint \"src/**/*.ts\"",
+    "lint": "eslint . --fix",
+    "lint:check": "eslint .",
     "prepare": "yarn run build",
     "test": "jest",
     "test:watch": "yarn test --watch",

diff --git a/packages/data-access/package.json b/packages/data-access/package.json
@@ -33,7 +33,8 @@
   "scripts": {
     "build": "tsc -b",
     "clean": "shx rm -rf dist tsconfig.tsbuildinfo",
-    "lint": "eslint \"src/**/*.ts\"",
+    "lint": "eslint . --fix",
+    "lint:check": "eslint .",
     "test": "jest",
     "test:watch": "yarn test --watch"
   },

diff --git a/packages/data-format/package.json b/packages/data-format/package.json
@@ -34,7 +34,8 @@
   "scripts": {
     "build": "tsc -b",
     "clean": "shx rm -rf dist tsconfig.tsbuildinfo",
-    "lint": "eslint \"src/**/*.ts\"",
+    "lint": "eslint . --fix",
+    "lint:check": "eslint .",
     "test": "jest",
     "test:watch": "yarn test --watch"
   },

diff --git a/packages/epk-decryption/package.json b/packages/epk-decryption/package.json
@@ -35,7 +35,8 @@
     "build:commonjs": "tsc -b",
     "build:umd": "webpack",
     "clean": "shx rm -rf dist tsconfig.tsbuildinfo",
-    "lint": "eslint \"src/**/*.ts\"",
+    "lint": "eslint . --fix",
+    "lint:check": "eslint .",
     "test": "jest",
     "test:watch": "yarn test --watch"
   },

diff --git a/packages/epk-decryption/webpack.config.js b/packages/epk-decryption/webpack.config.js
@@ -44,4 +44,3 @@ module.exports = {
     new DuplicatePackageCheckerPlugin(),
   ],
 };
-/* eslint-enable spellcheck/spell-checker */
diff --git a/packages/epk-signature/package.json b/packages/epk-signature/package.json
@@ -35,7 +35,8 @@
     "build:commonjs": "tsc -b",
     "build:umd": "webpack",
     "clean": "shx rm -rf dist tsconfig.tsbuildinfo",
-    "lint": "eslint \"src/**/*.ts\"",
+    "lint": "eslint . --fix",
+    "lint:check": "eslint .",
     "test": "jest",
     "test:watch": "yarn test --watch"
   },

diff --git a/packages/epk-signature/webpack.config.js b/packages/epk-signature/webpack.config.js
@@ -44,4 +44,3 @@ module.exports = {
     new DuplicatePackageCheckerPlugin(),
   ],
 };
-/* eslint-enable spellcheck/spell-checker */
diff --git a/packages/ethereum-storage/package.json b/packages/ethereum-storage/package.json
@@ -33,7 +33,8 @@
   "scripts": {
     "build": "tsc -b",
     "clean": "shx rm -rf dist tsconfig.tsbuildinfo",
-    "lint": "eslint \"src/**/*.ts\"",
+    "lint": "eslint . --fix",
+    "lint:check": "eslint .",
     "test": "jest",
     "test:watch": "yarn test --watch",
     "init-ipfs": "node scripts/init-ipfs.js"

diff --git a/packages/ethereum-storage/scripts/init-ipfs.js b/packages/ethereum-storage/scripts/init-ipfs.js
@@ -107,7 +107,6 @@ function setupSwarmKey(ipfsPath, swarmKeyContent) {
     });
   } catch (err) {
     throw new Error(`Error creating swarm key file: ${err.message}`);
-    return;
   }
 
   shell.echo('Swarm key file created.');

diff --git a/packages/multi-format/package.json b/packages/multi-format/package.json
@@ -33,7 +33,8 @@
   "scripts": {
     "build": "tsc -b",
     "clean": "shx rm -rf dist tsconfig.tsbuildinfo",
-    "lint": "eslint \"src/**/*.ts\"",
+    "lint": "eslint . --fix",
+    "lint:check": "eslint .",
     "prepare": "yarn run build",
     "test": "jest",
     "test:watch": "yarn test --watch"

diff --git a/packages/payment-detection/.eslintrc b/packages/payment-detection/.eslintrc
@@ -0,0 +1,5 @@
+{
+  "ignorePatterns": [
+    "/src/thegraph/generated/"
+  ]
+}
diff --git a/packages/payment-detection/package.json b/packages/payment-detection/package.json
@@ -33,7 +33,8 @@
     "prebuild": "yarn codegen",
     "build": "tsc -b",
     "clean": "shx rm -rf dist tsconfig.tsbuildinfo **/generated",
-    "lint": "eslint \"src/**/*.ts\"",
+    "lint": "eslint . --fix",
+    "lint:check": "eslint .",
     "prepare": "yarn run build",
     "test": "jest --runInBand",
     "test:watch": "yarn test --watch",

diff --git a/packages/payment-processor/package.json b/packages/payment-processor/package.json
@@ -32,7 +32,8 @@
   "scripts": {
     "build": "tsc -b",
     "clean": "shx rm -rf dist tsconfig.tsbuildinfo",
-    "lint": "eslint \"src/**/*.ts\"",
+    "lint": "eslint . --fix",
+    "lint:check": "eslint .",
     "prepare": "yarn run build",
     "test": "jest --runInBand",
     "test:watch": "yarn test --watch"

diff --git a/packages/request-client.js/package.json b/packages/request-client.js/package.json
@@ -36,7 +36,8 @@
     "build:umd": "webpack",
     "clean": "shx rm -rf dist tsconfig.tsbuildinfo",
     "docs": "shx rm -rf ./docs && compodoc -p tsconfig.json --output docs --disablePrivate --gaID UA-105153327-8",
-    "lint": "eslint \"src/**/*.ts\"",
+    "lint": "eslint . --fix",
+    "lint:check": "eslint .",
     "prepare": "yarn run build",
     "test": "jest",
     "test:watch": "yarn test --watch"

diff --git a/packages/request-logic/package.json b/packages/request-logic/package.json
@@ -34,7 +34,8 @@
     "build": "tsc -b",
     "clean": "shx rm -rf dist tsconfig.tsbuildinfo",
     "example": "ts-node specs/example/example.ts",
-    "lint": "eslint \"src/**/*.ts\"",
+    "lint": "eslint . --fix",
+    "lint:check": "eslint .",
     "test": "jest",
     "test:watch": "yarn test --watch"
   },

diff --git a/packages/request-logic/specs/example/example.ts b/packages/request-logic/specs/example/example.ts
@@ -73,7 +73,7 @@ async function foo(): Promise<void> {
     signatureProvider,
   );
   // apply creation
-  let requestState = RequestLogic.applyActionToRequest(null, actionCreation);
+  let requestState = RequestLogic.applyActionToRequest(null, actionCreation, Date.now());
   console.log('###########################################');
   console.log('Creation Action ---------------------------');
   console.log(JSON.stringify(JSON.stringify(actionCreation)));
@@ -91,7 +91,7 @@ async function foo(): Promise<void> {
     signatureProvider,
   );
   // apply discount
-  requestState = RequestLogic.applyActionToRequest(requestState, actionReduceAmount);
+  requestState = RequestLogic.applyActionToRequest(requestState, actionReduceAmount, Date.now());
   console.log('###########################################');
   console.log('Reduce Amount Action ----------------------');
   console.log(JSON.stringify(actionReduceAmount));
@@ -108,7 +108,7 @@ async function foo(): Promise<void> {
     signatureProvider,
   );
   // apply accept
-  requestState = RequestLogic.applyActionToRequest(requestState, actionAccept);
+  requestState = RequestLogic.applyActionToRequest(requestState, actionAccept, Date.now());
   console.log('###########################################');
   console.log('Accept Action -----------------------------');
   console.log(JSON.stringify(JSON.stringify(actionAccept)));
@@ -117,4 +117,4 @@ async function foo(): Promise<void> {
   console.log('###########################################');
 }
 
-foo();
+void foo();
diff --git a/packages/request-node/package.json b/packages/request-node/package.json
@@ -36,7 +36,8 @@
     "start": "ts-node src/server.ts",
     "start:watch": "ts-node-dev src/server.ts",
     "clean": "shx rm -rf dist tsconfig.tsbuildinfo",
-    "lint": "eslint \"src/**/*.ts\"",
+    "lint": "eslint . --fix",
+    "lint:check": "eslint .",
     "init-ipfs": "node init-ipfs.js"
   },
   "dependencies": {

diff --git a/packages/smart-contracts/.eslintrc b/packages/smart-contracts/.eslintrc
@@ -0,0 +1,8 @@
+{
+  "ignorePatterns": [
+    "/cache/",
+    "/types/",
+    // FIXME: artifacts index.ts should be linted
+    "/src/lib/artifacts/**/index.ts"
+  ]
+}
diff --git a/packages/smart-contracts/.eslintrc.js b/packages/smart-contracts/.eslintrc.js
diff --git a/packages/smart-contracts/package.json b/packages/smart-contracts/package.json
@@ -39,9 +39,12 @@
     "clean:lib": "shx rm -rf dist",
     "clean:hardhat": "shx rm -rf cache && shx rm -rf build",
     "clean": "yarn clean:lib && yarn clean:types && yarn clean:hardhat",
-    "lint:lib": "eslint \"src/lib/**/*.ts\"",
-    "lint:sol": "solhint \"src/contracts/**/*.sol\"",
+    "lint:lib": "eslint . --fix",
+    "lint:lib:check": "eslint .",
+    "lint:sol": "solhint \"src/contracts/**/*.sol\" --fix",
+    "lint:sol:check": "solhint \"src/contracts/**/*.sol\"",
     "lint": "yarn run lint:lib && yarn run lint:sol",
+    "lint:check": "yarn run lint:lib:check && yarn run lint:sol:check",
     "ganache": "ganache-cli -l 90000000 -p 8545 -m \"candy maple cake sugar pudding cream honey rich smooth crumble sweet treat\"",
     "deploy": "yarn hardhat deploy-local-env --network private",
     "test": "yarn hardhat test --network private",
@@ -58,6 +61,7 @@
     "@openzeppelin/contracts": "4.4.1",
     "@openzeppelin/test-helpers": "0.5.6",
     "@requestnetwork/currency": "0.8.0",
+    "@requestnetwork/types": "0.35.0",
     "@typechain/ethers-v5": "7.0.1",
     "@typechain/hardhat": "2.1.2",
     "@types/chai": "4.2.21",

diff --git a/packages/smart-contracts/scripts/deploy-one.ts b/packages/smart-contracts/scripts/deploy-one.ts
@@ -68,7 +68,9 @@ export async function deployOne<TContract extends Contract>(
           type: 'attached',
         };
       }
-    } catch (e) {}
+    } catch (e) {
+      // ignore error
+    }
   }
 
   if (options?.nonceCondition) {

diff --git a/packages/smart-contracts/scripts/deploy-payments.ts b/packages/smart-contracts/scripts/deploy-payments.ts
@@ -36,9 +36,10 @@ export async function deployAllPaymentContracts(
   hre: HardhatRuntimeEnvironment,
 ): Promise<void> {
   const deploymentResults: (DeploymentResult | undefined)[] = [];
-  let simulationSuccess: boolean | undefined = args.simulate ? true : undefined;
+  let simulationSuccess: boolean | undefined;
 
   try {
+    simulationSuccess = args.simulate ? true : undefined;
     const [deployer] = await hre.ethers.getSigners();
 
     console.log(
@@ -293,7 +294,6 @@ export async function deployAllPaymentContracts(
   } else {
     console.log(`--- No deployment was made. ---`);
   }
-  // @ts-ignore
   if (simulationSuccess === false) {
     console.log('--- DO NOT PROCEED ---');
   }

diff --git a/packages/smart-contracts/tsconfig.json b/packages/smart-contracts/tsconfig.json
@@ -5,6 +5,6 @@
     "rootDir": ".",
     "resolveJsonModule": true
   },
-  "include": ["./src/**/*", "./src/**/*.json"],
+  "include": ["src", "src/**/*.json", "scripts", "hardhat.config.ts"],
   "references": [{ "path": "../currency" }, { "path": "../utils" }]
 }
diff --git a/packages/toolbox/package.json b/packages/toolbox/package.json
@@ -33,7 +33,8 @@
   "scripts": {
     "build": "tsc -b",
     "clean": "shx rm -rf dist tsconfig.tsbuildinfo",
-    "lint": "eslint \"src/**/*.ts\"",
+    "lint": "eslint . --fix",
+    "lint:check": "eslint .",
     "prepare": "yarn run build",
     "cli": "cross-env NODE_ENV=development ts-node src/cli.ts",
     "chainlinkPath": "yarn -s cli listAggregators",

diff --git a/packages/transaction-manager/package.json b/packages/transaction-manager/package.json
@@ -33,7 +33,8 @@
   "scripts": {
     "build": "tsc -b",
     "clean": "shx rm -rf dist tsconfig.tsbuildinfo",
-    "lint": "eslint \"src/**/*.ts\"",
+    "lint": "eslint . --fix",
+    "lint:check": "eslint .",
     "test": "jest",
     "test:watch": "yarn test --watch"
   },
-Original file line number
+Diff line change
@@ Expand Up / @@ -44,4 +44,3 @@ module.exports = { @@
         new DuplicatePackageCheckerPlugin(),
       ],
     };
-    /* eslint-enable spellcheck/spell-checker */