feat: linter, prettier and solhint working

Andres Adjimann · Andres Adjimann · commit 7ad75aa3d686 · 2023-02-17T12:10:11.000-03:00
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,6 @@
-**/.env
+.env
 yarn.error.log
+yarn-error.log
 .yalc
 yalc.lock
 coverage*
diff --git a/config-packages/eslint/index.js b/config-packages/eslint/index.js
@@ -1,11 +1,12 @@
 const path = require('path');
-const tsconfigPath = path.join(__dirname, './tsconfig.json');
 module.exports = {
   ignorePatterns: [
+    'deployments/',
     'artifacts/',
     'cache/',
     'coverage/',
-    'node_modules/'
+    'node_modules/',
+    'typechain-types'
   ],
   root: true,
   extends: ['eslint:recommended', 'plugin:mocha/recommended', 'prettier'],
@@ -20,20 +21,21 @@ module.exports = {
   },
   overrides: [
     {
-      files: ['*.ts'],
+      files: ['*.ts', '*.tsx'],
       parser: '@typescript-eslint/parser',
       parserOptions: {
-        project: [tsconfigPath],
-        ecmaVersion: 2020,
-        sourceType: 'module',
+        project: ['./tsconfig.json'], // Specify it only for TypeScript files
+        // project: [path.join(__dirname, './tsconfig.json')],
+        // tsconfigRootDir: __dirname,
+        // ecmaVersion: 2020,
+        // sourceType: 'module',
       },
       plugins: ['mocha', '@typescript-eslint'],
       extends: [
         'eslint:recommended',
         'plugin:@typescript-eslint/recommended',
         'plugin:mocha/recommended',
         'prettier',
-        'prettier/@typescript-eslint',
       ],
       rules: {
         '@typescript-eslint/no-misused-promises': 'error',
diff --git a/config-packages/eslint/package.json b/config-packages/eslint/package.json
@@ -4,7 +4,10 @@
   "main": "index.js",
   "private": true,
   "dependencies": {
-    "eslint": "latest",
-    "eslint-config-prettier": "latest"
+    "@typescript-eslint/eslint-plugin": "^5.52.0",
+    "@typescript-eslint/parser": "^5.52.0",
+    "eslint": "^8.34.0",
+    "eslint-config-prettier": "^8.6.0",
+    "eslint-plugin-mocha": "^10.1.0"
   }
 }
diff --git a/config-packages/mocha/index.js b/config-packages/mocha/index.js
diff --git a/config-packages/mocha/package.json b/config-packages/mocha/package.json
diff --git a/config-packages/prettier/index.js b/config-packages/prettier/index.js
@@ -1,3 +1,4 @@
+// Right now we exclude files by .gitignore maybe someday prettier start supporting some ignore coniguration.
 module.exports = {
   singleQuote: true,
   bracketSpacing: false,
@@ -8,8 +9,7 @@ module.exports = {
         printWidth: 120,
         tabWidth: 4,
         singleQuote: false,
-        explicitTypes: 'always',
       },
     },
-  ],
+  ]
 };
diff --git a/config-packages/prettier/package.json b/config-packages/prettier/package.json
@@ -2,5 +2,9 @@
     "name": "prettier-config-custom",
     "version": "0.0.1",
     "main": "index.js",
-    "private": true
+    "private": true,
+    "dependencies": {
+        "prettier": "^2.8.4",
+        "prettier-plugin-solidity": "^1.1.2"
+    }
 }
diff --git a/config-packages/solcover/index.js b/config-packages/solcover/index.js
@@ -1,22 +1,8 @@
+// The only way to load this file is using a .solcover.js file :(
 module.exports = {
-  "extends": "solhint:recommended",
-  "plugins": ["prettier"],
-  "rules": {
-    "prettier/prettier": [
-      "error",
-      {
-        "endOfLine": "auto"
-      }
-    ],
-    "code-complexity": ["error", 7],
-    "compiler-version": ["error", "^0.8.0"],
-    "const-name-snakecase": "off",
-    "func-name-mixedcase": "off",
-    "constructor-syntax": "error",
-    "func-visibility": ["error", {"ignoreConstructors": true}],
-    "not-rely-on-time": "off",
-    "no-inline-assembly": "off",
-    "reason-string": ["warn", {"maxLength": 64}]
-  }
-}
-
+  mocha: {
+    grep: '@skip-on-coverage', // Find everything with this tag
+    invert: true, // Run the grep's inverse set.
+  },
+  skipFiles: [],
+};
diff --git a/config-packages/solcover/package.json b/config-packages/solcover/package.json
@@ -1,5 +1,5 @@
 {
-    "name": "solhint-config-custom",
+    "name": "solcover-config-custom",
     "version": "0.0.1",
     "main": "index.js",
     "private": true
diff --git a/config-packages/solhint/package.json b/config-packages/solhint/package.json
@@ -1,6 +1,9 @@
 {
-    "name": "solcover-config-custom",
+    "name": "solhint-config-custom",
     "version": "0.0.1",
     "main": "index.js",
-    "private": true
+    "private": true,
+    "dependencies": {
+        "solhint": "^3.3.8"
+    }
 }
diff --git a/packages/template/.gitignore b/packages/template/.gitignore
@@ -0,0 +1,13 @@
+.env
+yarn.error.log
+yarn-error.log
+.yalc
+yalc.lock
+coverage*
+.vscode/*
+node_modules/
+.idea/
+.DS_Store
+typechain-types/
+artifacts/
+cache/
diff --git a/packages/template/.solcover.js b/packages/template/.solcover.js
@@ -1,3 +1,2 @@
-module.exports = {
-  ...require("solcover-config-custom")
-};
+// The only way to load a custom configuration is using this file file. maybe somethis the will fix it.
+module.exports = require('solcover-config-custom');
diff --git a/packages/template/.solhint.json b/packages/template/.solhint.json
diff --git a/packages/template/contracts/Template.sol b/packages/template/contracts/Template.sol
@@ -7,7 +7,6 @@ pragma solidity ^0.8.9;
 // We import this library to be able to use console.log
 import "hardhat/console.sol";
 
-
 // This is the main building block for smart contracts.
 contract Token {
     // Some string type variables to identify the token.
@@ -51,12 +50,7 @@ contract Token {
 
         // We can print messages and values using console.log, a feature of
         // Hardhat Network:
-        console.log(
-            "Transferring from %s to %s %s tokens",
-            msg.sender,
-            to,
-            amount
-        );
+        console.log("Transferring from %s to %s %s tokens", msg.sender, to, amount);
 
         // Transfer the amount.
         balances[msg.sender] -= amount;
diff --git a/packages/template/hardhat.config.js b/packages/template/hardhat.config.js
diff --git a/packages/template/hardhat.config.ts b/packages/template/hardhat.config.ts
@@ -0,0 +1,12 @@
+import '@nomicfoundation/hardhat-toolbox';
+
+const config = {
+  solidity: '0.8.17',
+  networks: {
+    hardhat: {
+      chainId: 1337, // We set 1337 to make interacting with MetaMask simpler
+    },
+  },
+};
+
+export default config;
diff --git a/packages/template/package.json b/packages/template/package.json
@@ -1,48 +1,56 @@
 {
-    "name": "template",
-    "version": "0.0.1",
-    "description": "TheSandbox game example/template smart contract workspace",
-    "scripts": {
-        "test": "hardhat test"
-    },
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/thesandboxgame/contracts.git"
-    },
-    "keywords": [],
-    "author": "",
-    "license": "MIT",
-    "bugs": {
-        "url": "https://github.com/thesandboxgame/contracts/issues"
-    },
-    "homepage": "https://github.com/thesandboxgame/contracts#readme",
-    "devDependencies": {
-        "@ethersproject/abi": "^5.7.0",
-        "@ethersproject/providers": "^5.7.2",
-        "@nomicfoundation/hardhat-chai-matchers": "^1.0.5",
-        "@nomicfoundation/hardhat-network-helpers": "^1.0.7",
-        "@nomicfoundation/hardhat-toolbox": "^2.0.0",
-        "@nomiclabs/hardhat-ethers": "^2.2.1",
-        "@nomiclabs/hardhat-etherscan": "^3.1.4",
-        "chai": "^4.3.7",
-        "eslint-config-custom": "*",
-        "ethers": "^5.7.2",
-        "hardhat": "^2.12.5",
-        "mocha-config-custom": "*",
-        "prettier-config-custom": "*",
-        "solcover-config-custom": "*",
-        "solhint-config-custom": "*",
-        "solidity-coverage": "^0.8.2"
-    },
-    "main": "hardhat.config.js",
-    "directories": {
-        "test": "test"
-    },
-    "eslintConfig": {
-        "extends": "eslint-config-custom"
-    },
-    "prettier": "prettier-config-custom",
-    "mocha": {
-        "extends": "mocha-config-custom"
-    }
+  "name": "template",
+  "version": "0.0.1",
+  "description": "TheSandbox game example/template smart contract workspace",
+  "scripts": {
+    "lint": "solhint --max-warnings 0 \"contracts/**/*.sol\" && eslint --max-warnings 0 \"**/*.{js,ts}\"",
+    "lint:fix": "solhint --fix \"contracts/**/*.sol\" && eslint --fix \"**/*.{js,ts}\"",
+    "check": "hardhat check",
+    "format": "prettier --ignore-path .gitignore --check \"**/*.{ts,js,sol}\"",
+    "format:fix": "prettier --ignore-path .gitignore --write \"**/*.{ts,js,sol}\"",
+    "coverage": "dotenv -- cross-env NODE_OPTIONS=\"--max-old-space-size=8192 node --unhandled-rejections=strict\" HARDHAT_COMPILE=true NODE_ENV=test hardhat coverage --testfiles 'test/*.ts''test/*.js'",
+    "test": "dotenv -- cross-env NODE_OPTIONS=\"--max-old-space-size=4096 --unhandled-rejections=strict\" HARDHAT_COMPILE=true NODE_ENV=test hardhat test",
+    "hardhat": "hardhat"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/thesandboxgame/contracts.git"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/thesandboxgame/contracts/issues"
+  },
+  "homepage": "https://github.com/thesandboxgame/contracts#readme",
+  "devDependencies": {
+    "@ethersproject/abi": "^5.7.0",
+    "@ethersproject/providers": "^5.7.2",
+    "@nomicfoundation/hardhat-chai-matchers": "^1.0.6",
+    "@nomicfoundation/hardhat-network-helpers": "^1.0.8",
+    "@nomicfoundation/hardhat-toolbox": "^2.0.1",
+    "@nomiclabs/hardhat-ethers": "^2.2.2",
+    "@nomiclabs/hardhat-etherscan": "^3.1.6",
+    "@typechain/ethers-v5": "^10.2.0",
+    "@typechain/hardhat": "^6.1.5",
+    "chai": "^4.3.7",
+    "cross-env": "^7.0.3",
+    "dotenv": "^16.0.3",
+    "dotenv-cli": "^7.0.0",
+    "ethers": "^6.0.4",
+    "hardhat": "^2.12.7",
+    "solidity-coverage": "^0.8.2",
+    "typechain": "^8.1.1",
+    "hardhat-gas-reporter": "^1.0.9",
+    "prettier-config-custom": "*",
+    "solcover-config-custom": "*",
+    "solhint-config-custom": "*"
+  },
+  "eslintConfig": {
+    "extends": "eslint-config-custom"
+  },
+  "prettier": "prettier-config-custom",
+  "solhint": {
+    "extends": "custom"
+  }
 }
diff --git a/packages/template/test/Template.ts b/packages/template/test/Template.ts
@@ -0,0 +1,12 @@
+async function deployContractsFixture() {
+  const token = await Token.deploy();
+  return {token};
+}
+
+describe('Template.sol', function () {
+  it('test', async function () {
+    const {token} = await loadFixture(deployContractsFixture);
+    await token.callSomething();
+    // use token and exchanges contracts
+  });
+});
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,10 @@`
`4`	`4`	`"main": "index.js",`
`5`	`5`	`"private": true,`
`6`	`6`	`"dependencies": {`
`7`		`- "eslint": "latest",`
`8`		`- "eslint-config-prettier": "latest"`
	`7`	`+ "@typescript-eslint/eslint-plugin": "^5.52.0",`
	`8`	`+ "@typescript-eslint/parser": "^5.52.0",`
	`9`	`+ "eslint": "^8.34.0",`
	`10`	`+ "eslint-config-prettier": "^8.6.0",`
	`11`	`+ "eslint-plugin-mocha": "^10.1.0"`
`9`	`12`	`}`
`10`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "name": "solhint-config-custom",`
	`2`	`+ "name": "solcover-config-custom",`
`3`	`3`	`"version": "0.0.1",`
`4`	`4`	`"main": "index.js",`
`5`	`5`	`"private": true`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,9 @@`
`1`	`1`	`{`
`2`		`- "name": "solcover-config-custom",`
	`2`	`+ "name": "solhint-config-custom",`
`3`	`3`	`"version": "0.0.1",`
`4`	`4`	`"main": "index.js",`
`5`		`- "private": true`
	`5`	`+ "private": true,`
	`6`	`+ "dependencies": {`
	`7`	`+ "solhint": "^3.3.8"`
	`8`	`+ }`
`6`	`9`	`}`