Merge pull request #614 from shapehq/enhancement/migrate-to-es-lint

Migrates from `next lint` to `eslint`

Author: simonbs

__test__/auth/AuthjsAccountsOAuthTokenRepository.test.ts

@@ -14,7 +14,7 @@ test("It gets token for user ID and provider", async () => {
           async disconnect() {},
         }
       },
-      async query(_query, values: any[] = []) {
+      async query(_query, values: readonly unknown[] = []) {
         queryProvider = values[0]
         queryUserId = values[1]
         return {
@@ -44,7 +44,7 @@ test("It does not set token", async () => {
           async disconnect() {},
         }
       },
-      async query(_query, _values: any[] = []) {
+      async query(_query, _values: readonly unknown[] = []) {
         didSetToken = true
         return { rows: [] }
       }
@@ -67,7 +67,7 @@ test("It does not delete token", async () => {
           async disconnect() {},
         }
       },
-      async query(_query, _values: any[] = []) {
+      async query(_query, _values: readonly unknown[] = []) {
         didDeleteToken = true
         return { rows: [] }
       }

__test__/auth/OAuthTokenRepository.test.ts

@@ -8,13 +8,13 @@ test("It reads the auth token for the specified user", async () => {
     db: {
       async connect() {
         return {
-          async query(_query: string, _values: any[] = []) {
+          async query(_query: string, _values: readonly unknown[] = []) {
             return { rows: [] }
           },
           async disconnect() {},
         }
       },
-      async query(_query: string, values: any[] = []) {
+      async query(_query: string, values: [string, string]) {
         readProvider = values[0]
         readUserId = values[1]
         return {
@@ -36,20 +36,20 @@ test("It reads the auth token for the specified user", async () => {
 test("It stores the auth token for the specified user", async () => {
   let storedProvider: string | undefined
   let storedUserId: string | undefined
-  let storedAccessToken: any | undefined
-  let storedRefreshToken: any | undefined
+  let storedAccessToken: string | undefined
+  let storedRefreshToken: string | undefined
   const sut = new OAuthTokenRepository({
     provider: "github",
     db: {
       async connect() {
         return {
-          async query(_query: string, _values: any[] = []) {
+          async query(_query: string, _values: readonly unknown[] = []) {
             return { rows: [] }
           },
           async disconnect() {},
         }
       },
-      async query(_query: string, values: any[] = []) {
+      async query(_query: string, values: [string, string, string, string]) {
         storedProvider = values[0]
         storedUserId = values[1]
         storedAccessToken = values[2]
@@ -76,13 +76,13 @@ test("It deletes the auth token for the specified user", async () => {
     db: {
       async connect() {
         return {
-          async query(_query: string, _values: any[] = []) {
+          async query(_query: string, _values: readonly unknown[] = []) {
             return { rows: [] }
           },
           async disconnect() {},
         }
       },
-      async query(_query: string, values: any[] = []) {
+      async query(_query: string, values: [string, string]) {
         deletedUserId = values[1]
         return { rows: [] }
       }

__test__/common/github/OAuthTokenRefreshingGitHubClient.test.ts

@@ -285,6 +285,7 @@ test("It does not refresh an OAuth token when the initial request was successful
     },
     oauthTokenRefresher: {
       async refreshOAuthToken(_refreshToken) {
+        didRefreshOAuthToken = true
         return {
           accessToken: "newAccessToken",
           refreshToken: "newRefreshToken"

__test__/common/utils/saneParseInt.test.ts

@@ -1,7 +1,7 @@
 import { saneParseInt } from "@/common"
 
 test("It parses an integer", async () => {
-  // @ts-ignore
+  // @ts-expect-error - verifying that non-string input is rejected
   const val = saneParseInt(42 as string)
   expect(val).toBe(42)
 })

__test__/projects/GitHubRepositoryDataSource.test.ts

@@ -189,7 +189,7 @@ test("It queries for both .yml and .yaml file extension with no extension", asyn
 })
 
 test("It loads repositories for all logins", async () => {
-  let searchQueries: string[] = []
+  const searchQueries: string[] = []
   const sut = new GitHubRepositoryDataSource({
     repositoryNameSuffix: "-openapi",
     projectConfigurationFilename: ".demo-docs",

eslint.config.mjs

@@ -0,0 +1,55 @@
+import { defineConfig } from "eslint/config"
+import typescriptEslint from "@typescript-eslint/eslint-plugin"
+import tsParser from "@typescript-eslint/parser"
+import path from "node:path"
+import { fileURLToPath } from "node:url"
+import js from "@eslint/js"
+import { FlatCompat } from "@eslint/eslintrc"
+
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = path.dirname(__filename)
+const compat = new FlatCompat({
+  baseDirectory: __dirname,
+  recommendedConfig: js.configs.recommended,
+  allConfig: js.configs.all
+})
+
+export default defineConfig([
+  {
+    ignores: ["next-env.d.ts", ".next"],
+  },
+  {
+    extends: [
+      ...compat.extends("next/core-web-vitals"),
+      ...compat.extends("eslint:recommended"),
+      ...compat.extends("plugin:@typescript-eslint/recommended")
+    ],
+  
+    plugins: {
+      "@typescript-eslint": typescriptEslint,
+    },
+  
+    languageOptions: {
+      parser: tsParser,
+    },
+  
+    rules: {
+      "array-callback-return": ["error"],
+      "no-await-in-loop": ["error"],
+      "no-constant-binary-expression": ["error"],
+      "no-constructor-return": ["error"],
+      "no-duplicate-imports": ["error"],
+      "no-new-native-nonconstructor": ["error"],
+      "no-self-compare": ["error"],
+      "no-template-curly-in-string": ["error"],
+      "no-unmodified-loop-condition": ["error"],
+      "no-unreachable-loop": ["error"],
+      "no-unused-private-class-members": ["error"],
+      "require-atomic-updates": ["error"],
+  
+      "@typescript-eslint/no-unused-vars": ["error", {
+        argsIgnorePattern: "^_",
+      }],
+    },
+  }
+])

package.json

@@ -10,7 +10,7 @@
     "dev": "next dev",
     "build": "next build",
     "start": "next start",
-    "lint": "next lint --max-warnings=0",
+    "lint": "eslint --max-warnings=0 .",
     "test": "node --experimental-vm-modules ./node_modules/.bin/jest",
     "testwatch": "node --experimental-vm-modules ./node_modules/.bin/jest --watch"
   },

src/common/utils/fileUtils.ts

@@ -36,7 +36,6 @@ export async function downloadFile(params: {
     let didExceedMaxBytes = false;
     const reader = response.body.getReader();
     const chunks: Uint8Array[] = [];
-    // eslint-disable-next-line no-constant-condition
     while (true) {
         // eslint-disable-next-line no-await-in-loop
         const { done, value } = await reader.read();
@@ -55,11 +54,15 @@ export async function downloadFile(params: {
         const error = new Error("Maximum file size exceeded");
         error.name = ErrorName.MAX_FILE_SIZE_EXCEEDED;
         throw error;
+    }    
+    const allBytes = new Uint8Array(totalBytes);
+    let offset = 0;
+    for (const chunk of chunks) {
+        allBytes.set(chunk, offset);
+        offset += chunk.length;
     }
-    const blob = new Blob(chunks);
-    const arrayBuffer = await blob.arrayBuffer();
     const decoder = new TextDecoder();
-    return decoder.decode(arrayBuffer);
+    return decoder.decode(allBytes);
 }
 
 export function checkIfJsonOrYaml(fileText: string) {

src/features/auth/view/SignInTexts.tsx

@@ -4,16 +4,19 @@ import { BASE_COLORS } from "@/common/theme/theme"
 import { Box, Typography, SxProps } from "@mui/material"
 import { useEffect, useState, useMemo } from "react"
 
+const getRandomTextColor = ({ excluding }: { excluding?: string } = {}) => {
+  const colors = BASE_COLORS
+    .filter(e => e !== excluding)
+  return colors[Math.floor(Math.random() * colors.length)]
+}
+
+const INITIAL_TEXT_COLOR = getRandomTextColor()
+
 const SignInTexts = ({ prefix }: { prefix: string }) => {
-  const getRandomTextColor = ({ excluding }: { excluding?: string }) => {
-    const colors = BASE_COLORS
-      .filter(e => e !== excluding)
-    return colors[Math.floor(Math.random() * colors.length)]
-  }
   const [characterIndex, setCharacterIndex] = useState(0)
   const [textIndex, setTextIndex] = useState(0)
   const [displayedText, setDisplayedText] = useState("")
-  const [textColor, setTextColor] = useState(getRandomTextColor({}))
+  const [textColor, setTextColor] = useState(INITIAL_TEXT_COLOR)
   const texts = useMemo(() => [
     "is a great OpenAPI viewer",
     "facilitates spec-driven development",

src/features/encrypt/view/EncryptionForm.tsx

@@ -7,6 +7,12 @@ import { encrypt } from "./encryptAction"
 import { FontAwesomeIcon } from "@fortawesome/react-fontawesome"
 import { faClipboard } from "@fortawesome/free-regular-svg-icons"
 
+const EncryptedValueTextField = styled(TextField)({
+    '& .MuiInputBase-root': {
+        backgroundColor: '#F8F8F8'
+    }
+})
+
 export const EncryptionForm = () => {
     const [inputText, setInputText] = useState('')
     const [encryptedText, setEncryptedText] = useState('')
@@ -32,12 +38,6 @@ export const EncryptionForm = () => {
     const handleCloseSnackbar = () => {
         setOpenSnackbar(false)
     }
-    
-    const EncryptedValueTextField = styled(TextField)({
-        '& .MuiInputBase-root': {
-            backgroundColor: '#F8F8F8'
-        }
-    })
 
     return <Box
         component="form"