enh: run code checks in pre-commit and pre-push hooks (gitcoinco#2314)

bard · vacekj · web-flow · commit 4972bbd215b4 · 2023-10-06T11:59:30.000+02:00
Co-authored-by: Atris &lt;vacekj@outlook.com&gt;
diff --git a/.prettierignore b/.prettierignore
diff --git a/lefthook.yml b/lefthook.yml
@@ -5,12 +5,34 @@ pre-commit:
   parallel: true
   commands:
     prettier:
-      glob: "*.{js,ts,jsx,tsx}"
-      run: pnpm prettier --write {staged_files}
+      glob: "**/*.{js,ts,jsx,tsx}"
+      run: pnpm format {staged_files}
+      stage_fixed: true
+
+    lint-ge:
+      root: "packages/builder"
+      glob: "**/*.{js,ts,jsx,tsx}"
+      run: pnpm --filter "builder" lint:local {staged_files}
+      stage_fixed: true
+
+    lint-rm:
+      root: "packages/round-manager"
+      glob: "**/*.{js,ts,jsx,tsx}"
+      run: pnpm --filter "round-manager" lint:local {staged_files}
+      stage_fixed: true
+
+    lint-builder:
+      root: "packages/grant-explorer"
+      glob: "**/*.{js,ts,jsx,tsx}"
+      run: pnpm --filter "grant-explorer" lint:local {staged_files}
+      stage_fixed: true
 
 pre-push:
   parallel: true
   commands:
-    eslint:
-      glob: "*.{js,ts,jsx,tsx}"
-      run: turbo lint:ci
+    typecheck:
+      run: turbo run typecheck
+    build:
+      run: turbo run build
+    test:
+      run: turbo run test
diff --git a/package.json b/package.json
@@ -12,6 +12,7 @@
     "compile": "pnpm --filter contracts run compile ",
     "test": "pnpm run test",
     "typecheck": "turbo run typecheck",
+    "format": "prettier --write",
     "// round manager script": "====== packages/round-manager specific ======",
     "rm-build": "pnpm --filter round-manager run build",
     "rm-test": "turbo run test --filter=round-manager",
@@ -35,7 +36,8 @@
     "@commitlint/config-conventional": "^17.6.3"
   },
   "dependencies": {
-    "turbo": "^1.10.14"
+    "prettier": "^3.0.3",
+    "turbo": "^1.10.9"
   },
   "pnpm": {
     "overrides": {
diff --git a/packages/builder/package.json b/packages/builder/package.json
@@ -74,10 +74,10 @@
     "ts-jest": "^27.0",
     "typescript": "^4.6.3",
     "url": "^0.11.0",
+    "verify-env": "*",
     "wagmi": "^0.12.19",
     "web-vitals": "^2.1.4",
-    "yup": "^0.32.11",
-    "verify-env": "*"
+    "yup": "^0.32.11"
   },
   "scripts": {
     "start": "craco start",
@@ -86,8 +86,9 @@
     "test:dev": "jest --watch",
     "test:coverage": "jest --watchAll=false --coverage",
     "eject": "react-scripts eject",
+    "lint:local": "eslint",
     "lint": "eslint --ext .js,.jsx,.ts,.tsx ./src --cache",
-    "lint:ci": "pnpm lint --max-warnings=0",
+    "lint:ci": "CI=false pnpm lint",
     "lint:fix": "eslint ./src --fix --cache",
     "typecheck": "tsc --noEmit"
   },
@@ -137,6 +138,6 @@
     "lokijs": "^1.5.12",
     "msw": "^0.47.4",
     "postcss-import": "^14.1.0",
-    "prettier": "^2.6.2"
+    "prettier": "2"
   }
 }
diff --git a/packages/eslint-config-gitcoin/index.js b/packages/eslint-config-gitcoin/index.js
@@ -24,7 +24,6 @@ module.exports = {
       files: ["**/*.{ts,tsx,js,jsx}"],
       rules: {
         "@typescript-eslint/explicit-module-boundary-types": "off",
-        "no-debugger": "off",
         "@typescript-eslint/no-var-requires": "off",
       },
     },
diff --git a/packages/eslint-config-gitcoin/package.json b/packages/eslint-config-gitcoin/package.json
@@ -4,10 +4,11 @@
   "main": "index.js",
   "private": true,
   "dependencies": {
-    "@typescript-eslint/eslint-plugin": "^6.5.0",
-    "@typescript-eslint/parser": "^6.5.0",
-    "eslint": "^8.22.0",
-    "eslint-config-turbo": "latest",
+    "@typescript-eslint/eslint-plugin": "^6.7.2",
+    "@typescript-eslint/parser": "^6.7.2",
+    "typescript": "^5.2.2",
+    "eslint": "^8.49.0",
+    "eslint-config-turbo": "^1.10.14",
     "eslint-plugin-react": "^7.31.7",
     "eslint-plugin-react-hooks": "^4.6.0"
   }
diff --git a/packages/grant-explorer/package.json b/packages/grant-explorer/package.json
@@ -5,8 +5,10 @@
   "license": "AGPL-3.0-only",
   "scripts": {
     "build": "env REACT_APP_GIT_SHA=$(git rev-parse --short HEAD) craco build",
-    "lint:ci": "pnpm lint:fix --max-warnings=0",
+    "lint:local": "eslint",
+    "lint:ci": "CI=false pnpm lint",
     "lint:fix": "eslint ./src --fix",
+    "lint": "eslint ./src --cache",
     "typecheck": "tsc --noEmit",
     "start": "craco start",
     "test": "vitest run",
@@ -119,7 +121,6 @@
     "eslint-config-gitcoin": "workspace:*",
     "happy-dom": "^11.0.2",
     "postcss": "^8.4.14",
-    "prettier": "^2.8.3",
     "resize-observer-polyfill": "^1.5.1",
     "tailwind-styled-components": "^2.1.7",
     "tailwindcss": "^3.0.24",
diff --git a/packages/round-manager/.prettierignore b/packages/round-manager/.prettierignore
diff --git a/packages/round-manager/package.json b/packages/round-manager/package.json
@@ -14,8 +14,9 @@
     "test:dev": "craco test --watchAll=true",
     "test:coverage": "craco test --watchAll=false --silent --coverage",
     "eject": "react-scripts eject",
-    "format": "prettier . --write",
-    "lint:ci": "pnpm lint:fix --max-warnings=0",
+    "lint:local": "eslint",
+    "lint": "eslint ./src --cache",
+    "lint:ci": "CI=false pnpm lint",
     "lint:fix": "eslint ./src --fix",
     "typecheck": "tsc --noEmit",
     "typechain": "typechain --target=ethers-v5 ./src/features/**/*.json --out-dir ./src/types/generated/typechain/",
@@ -128,7 +129,6 @@
     "craco-esbuild": "^0.5.2",
     "husky": "^8.0.1",
     "postcss": "^8.4.14",
-    "prettier": "^2.7.1",
     "resize-observer-polyfill": "^1.5.1",
     "tailwind-styled-components": "2.1.6",
     "tailwindcss": "^3.0.24",
diff --git a/packages/round-manager/src/features/round/RoundDetailForm.tsx b/packages/round-manager/src/features/round/RoundDetailForm.tsx
@@ -42,7 +42,7 @@ export const RoundValidationSchema = yup.object().shape({
         .required("You must select a support type.")
         .notOneOf(
           ["Select what type of input."],
-          "You must select a support type."
+          "You must select a support type.",
         ),
       info: yup
         .string()
@@ -61,7 +61,7 @@ export const RoundValidationSchema = yup.object().shape({
             /*Matches www.example.com, example.com, http and https prefixes, but not www.invalid */
             .matches(
               /^(http:\/\/|https:\/\/|ipfs:\/\/)?\S+\.\S+$|^(ipfs:\/\/)\S+$/,
-              "Must be a valid URL"
+              "Must be a valid URL",
             )
             .required("You must provide a valid URL."),
         }),
@@ -883,7 +883,7 @@ function SupportTypeDropdown(props: {
               <SupportTypeButton
                 errors={props.errors}
                 supportType={props.supportTypes.find(
-                  (supportType) => supportType.name === field.value
+                  (supportType) => supportType.name === field.value,
                 )}
               />
               <Transition
@@ -904,7 +904,7 @@ function SupportTypeDropdown(props: {
                               active
                                 ? "text-white bg-indigo-600"
                                 : "text-gray-900",
-                              "relative cursor-default select-none py-2 pl-3 pr-9"
+                              "relative cursor-default select-none py-2 pl-3 pr-9",
                             )
                           }
                           value={type.name}
@@ -916,7 +916,7 @@ function SupportTypeDropdown(props: {
                                 <span
                                   className={classNames(
                                     selected ? "font-semibold" : "font-normal",
-                                    "ml-3 block truncate"
+                                    "ml-3 block truncate",
                                   )}
                                 >
                                   {type.name}
@@ -927,7 +927,7 @@ function SupportTypeDropdown(props: {
                                 <span
                                   className={classNames(
                                     active ? "text-white" : "text-indigo-600",
-                                    "absolute inset-y-0 right-0 flex items-center pr-4"
+                                    "absolute inset-y-0 right-0 flex items-center pr-4",
                                   )}
                                 >
                                   <CheckIcon
@@ -939,7 +939,7 @@ function SupportTypeDropdown(props: {
                             </>
                           )}
                         </Listbox.Option>
-                      )
+                      ),
                   )}
                 </Listbox.Options>
               </Transition>
@@ -1074,7 +1074,7 @@ function RoundType(props: {
                         ? "bg-indigo-600 border-transparent"
                         : "bg-white border-gray-300",
                       active ? "ring-2 ring-offset-2 ring-indigo-500" : "",
-                      "h-4 w-4 mt-1 rounded-full border flex items-center justify-center"
+                      "h-4 w-4 mt-1 rounded-full border flex items-center justify-center",
                     )}
                     aria-hidden="true"
                   >
@@ -1103,7 +1103,7 @@ function RoundType(props: {
                         ? "bg-indigo-600 border-transparent"
                         : "bg-white border-gray-300",
                       active ? "ring-2 ring-offset-2 ring-indigo-500" : "",
-                      "h-4 w-4 mt-1 rounded-full border flex items-center justify-center"
+                      "h-4 w-4 mt-1 rounded-full border flex items-center justify-center",
                     )}
                     aria-hidden="true"
                   >
diff --git a/packages/round-manager/src/features/round/ViewRoundStats.tsx b/packages/round-manager/src/features/round/ViewRoundStats.tsx
@@ -29,7 +29,7 @@ export default function ViewRoundStats() {
     payoutTokens.find(
       (t) =>
         t.address.toLowerCase() == round.token.toLowerCase() &&
-        t.chainId === chainId
+        t.chainId === chainId,
     );
 
   return (
@@ -50,8 +50,10 @@ export default function ViewRoundStats() {
         <StatsCard
           text={
             round &&
-            `${utils.formatUnits(round.matchAmount, matchToken?.decimal)} ${matchToken?.name
-            }`
+            `${utils.formatUnits(
+              round.matchAmount,
+              matchToken?.decimal,
+            )} ${matchToken?.name}`
           }
           title={"Matching Funds Available"}
         />
@@ -100,7 +102,7 @@ export default function ViewRoundStats() {
                 matches.map((match: Match) => {
                   const percentage =
                     Number(
-                      (BigInt(1000000) * match.matched) / round.matchAmount
+                      (BigInt(1000000) * match.matched) / round.matchAmount,
                     ) / 10000;
 
                   return (
@@ -127,9 +129,9 @@ export default function ViewRoundStats() {
             text={
               round && round.uniqueContributors > 0
                 ? new Intl.NumberFormat("en-US", {
-                  style: "currency",
-                  currency: "USD",
-                }).format(round.amountUSD / round.uniqueContributors)
+                    style: "currency",
+                    currency: "USD",
+                  }).format(round.amountUSD / round.uniqueContributors)
                 : "N/A"
             }
           />
@@ -153,8 +155,9 @@ type StatsCardProps = {
 function StatsCard(props: StatsCardProps) {
   return (
     <div
-      className={`p-4 border rounded ${props.grayBorder ? "border-grey-100" : "border-violet-400"
-        } flex flex-col justify-center`}
+      className={`p-4 border rounded ${
+        props.grayBorder ? "border-grey-100" : "border-violet-400"
+      } flex flex-col justify-center`}
     >
       <span
         className={
diff --git a/packages/round-manager/tsconfig.json b/packages/round-manager/tsconfig.json
@@ -15,7 +15,7 @@
     "isolatedModules": true,
     "noEmit": true,
     "jsx": "react-jsx",
-    "types": ["@testing-library/jest-dom", "jest", "node"],
+    "types": ["@testing-library/jest-dom", "jest", "node"]
   },
   "include": ["src"]
 }
diff --git a/packages/verify-env/src/index.test.ts b/packages/verify-env/src/index.test.ts
@@ -40,19 +40,19 @@ it("verifies vars from files", () => {
     return undefined as never;
   });
 
-  verify(__dirname + "/test/");
+  verify([__dirname + "/test/"]);
   expect(processMock).toHaveBeenCalledOnce();
   expect(processMock).toHaveBeenCalledWith(1);
   expect(consoleMock).toHaveBeenCalledWith(
-    "Error: Some environment variables are not set or are empty:"
+    "Error: Some environment variables are not set or are empty:",
   );
   expect(consoleMock).toHaveBeenCalledWith(
     `
 REACT_APP_ENV
 REACT_APP_WALLETCONNECT_PROJECT_ID
 REACT_APP_INFURA_ID
 REACT_APP_ALCHEMY_ID
-`
+`,
   );
 });
 
@@ -66,18 +66,18 @@ it("verifies vars from files when some vars are set", () => {
 
   process.env.REACT_APP_WALLETCONNECT_PROJECT_ID = "thisisset";
 
-  verify(__dirname + "/test/");
+  verify([__dirname + "/test/"]);
   expect(processMock).toHaveBeenCalledOnce();
   expect(processMock).toHaveBeenCalledWith(1);
   expect(consoleMock).toHaveBeenCalledWith(
-    "Error: Some environment variables are not set or are empty:"
+    "Error: Some environment variables are not set or are empty:",
   );
   expect(consoleMock).toHaveBeenCalledWith(
     `
 REACT_APP_ENV
 REACT_APP_INFURA_ID
 REACT_APP_ALCHEMY_ID
-`
+`,
   );
 
   delete process.env.REACT_APP_WALLETCONNECT_PROJECT_ID;
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
