style: add eslint

Author: SharzyL

.github/workflows/deploy.yml

@@ -22,7 +22,7 @@ jobs:
       - name: "Test"
         run: |
           yarn prettier -c .
-          yarn tsc --noEmit
+          yarn eslint .
           yarn test
 
       - name: "Deploy"

.github/workflows/pr.yml

@@ -34,7 +34,7 @@ jobs:
       - name: "Test"
         run: |
           yarn prettier -c .
-          yarn tsc --noEmit
+          yarn eslint .
           yarn test
 
       - name: "Run Coverage"

eslint.config.js

@@ -0,0 +1,40 @@
+// @ts-check
+
+import eslint from "@eslint/js"
+import tseslint from "typescript-eslint"
+import { globalIgnores } from "eslint/config"
+
+export default tseslint.config(
+  eslint.configs.recommended,
+  tseslint.configs.recommendedTypeChecked,
+  {
+    languageOptions: {
+      parserOptions: {
+        projectService: true,
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+  },
+  globalIgnores([
+    "dist/**",
+    ".wrangler/**",
+    "coverage/**",
+    "worker-configuration.d.ts",
+  ]),
+  {
+    rules: {
+      "no-unused-vars": "off",
+      "@typescript-eslint/no-unused-vars": [
+        "error",
+        {
+          argsIgnorePattern: "^_",
+          varsIgnorePattern: "^_",
+        },
+      ],
+    },
+  },
+  {
+    files: ["*.config.js"], // TODO: make them work
+    extends: [tseslint.configs.disableTypeChecked],
+  },
+)

package.json

@@ -12,6 +12,7 @@
     "delete-paste": "wrangler kv:key delete --binding PB",
     "test": "vitest",
     "fmt": "prettier --write .",
+    "lint": "eslint .",
     "coverage": "vitest run --coverage"
   },
   "author": "SharzyL <[email protected]>",
@@ -24,6 +25,7 @@
     "eslint": "^9.25.0",
     "prettier": "^3.5.3",
     "typescript": "^5.8.3",
+    "typescript-eslint": "^8.30.1",
     "vitest": "3.1.1",
     "wrangler": "^4.12.0"
   },

src/common.ts

@@ -1,8 +1,6 @@
-import { FormDataDisposition } from "./parseFormdata.js"
-
 export const params = {
   CHAR_GEN: "ABCDEFGHJKMNPQRSTWXYZabcdefhijkmnprstwxyz2345678",
-  NAME_REGEX: /^[a-zA-Z0-9+_\-\[\]*$@,;]{3,}$/,
+  NAME_REGEX: /^[a-zA-Z0-9+_\-[\]*$@,;]{3,}$/,
   PASTE_NAME_LEN: 4,
   PRIVATE_PASTE_NAME_LEN: 24,
   DEFAULT_PASSWD_LEN: 24,
@@ -29,8 +27,8 @@ export function atob_utf8(value: string): string {
 
 export class WorkerError extends Error {
   public statusCode: number
-  constructor(statusCode: number, ...params: any[]) {
-    super(...params)
+  constructor(statusCode: number, msg: string) {
+    super(msg)
     this.statusCode = statusCode
   }
 }
@@ -79,20 +77,20 @@ export function parsePath(pathname: string): ParsedPath {
   }
 
   // extract and remove filename
-  let startOfFilename = pathname.lastIndexOf("/")
+  const startOfFilename = pathname.lastIndexOf("/")
   if (startOfFilename >= 0) {
     filename = pathname.slice(startOfFilename + 1)
     pathname = pathname.slice(0, startOfFilename)
   }
 
   // if having filename, parse ext from filename, else from remaining pathname
   if (filename) {
-    let startOfExt = filename.indexOf(".")
+    const startOfExt = filename.indexOf(".")
     if (startOfExt >= 0) {
       ext = filename.slice(startOfExt)
     }
   } else {
-    let startOfExt = pathname.indexOf(".")
+    const startOfExt = pathname.indexOf(".")
     if (startOfExt >= 0) {
       ext = pathname.slice(startOfExt)
       pathname = pathname.slice(0, startOfExt)

src/handlers/handleCors.ts

@@ -5,12 +5,12 @@ const corsHeaders = {
 }
 
 export function handleOptions(request: Request) {
-  let headers = request.headers
+  const headers = request.headers
   if (
     headers.get("Origin") !== null &&
     headers.get("Access-Control-Request-Method") !== null
   ) {
-    let respHeaders: { [name: string]: string } = corsHeaders
+    const respHeaders: { [name: string]: string } = corsHeaders
     if ("Access-Control-Request-Methods" in respHeaders) {
       respHeaders["Access-Control-Allow-Headers"] = request.headers.get(
         "Access-Control-Request-Headers",

src/handlers/handleWrite.ts

@@ -16,11 +16,12 @@ import {
   updatePaste,
 } from "../storage/storage.js"
 
-type PasteResponse = {
+export type PasteResponse = {
   url: string
   suggestedUrl?: string
   manageUrl: string
   expirationSeconds: number
+  expireAt: string
 }
 
 function suggestUrl(
@@ -63,7 +64,7 @@ export async function handlePostOrPut(
     const uint8Array = new Uint8Array(await request.arrayBuffer())
     try {
       form = parseFormdata(uint8Array, getBoundary(contentType))
-    } catch (e) {
+    } catch {
       throw new WorkerError(400, "error occurs when parsing formdata")
     }
   } else {
@@ -92,7 +93,7 @@ export async function handlePostOrPut(
 
   // parse expiration
   let expirationSeconds = parseExpiration(expire)
-  let maxExpiration = parseExpiration(env.MAX_EXPIRATION)
+  const maxExpiration = parseExpiration(env.MAX_EXPIRATION)
   if (expirationSeconds > maxExpiration) {
     expirationSeconds = maxExpiration
   }
@@ -105,22 +106,10 @@ export async function handlePostOrPut(
     )
   }
 
-  function makeResponse(created: PasteResponse, now: Date): Response {
-    return new Response(
-      JSON.stringify(
-        {
-          ...created,
-          expiredAt: new Date(
-            now.getTime() + 1000 * created.expirationSeconds,
-          ).toISOString(),
-        },
-        null,
-        2,
-      ),
-      {
-        headers: { "content-type": "application/json;charset=UTF-8" },
-      },
-    )
+  function makeResponse(created: PasteResponse): Response {
+    return new Response(JSON.stringify(created, null, 2), {
+      headers: { "content-type": "application/json;charset=UTF-8" },
+    })
   }
 
   function accessUrl(short: string): string {
@@ -131,7 +120,7 @@ export async function handlePostOrPut(
     return env.BASE_URL + "/" + short + params.SEP + passwd
   }
 
-  let now = new Date()
+  const now = new Date()
   if (isPut) {
     const { nameFromPath, passwd } = parsePath(url.pathname)
     const originalMetadata = await getPasteMetadata(env, nameFromPath)
@@ -146,27 +135,27 @@ export async function handlePostOrPut(
         `incorrect password for paste '${nameFromPath}`,
       )
     } else {
-      let pasteName =
+      const pasteName =
         nameFromPath ||
         genRandStr(
           isPrivate ? params.PRIVATE_PASTE_NAME_LEN : params.PASTE_NAME_LEN,
         )
-      let newPasswd = passwdFromForm || passwd
+      const newPasswd = passwdFromForm || passwd
       await updatePaste(env, pasteName, content, originalMetadata, {
         expirationSeconds,
         now,
         passwd: newPasswd,
         filename,
       })
-      return makeResponse(
-        {
-          url: accessUrl(pasteName),
-          suggestedUrl: suggestUrl(content, pasteName, env.BASE_URL, filename),
-          manageUrl: manageUrl(pasteName, newPasswd),
-          expirationSeconds,
-        },
-        now,
-      )
+      return makeResponse({
+        url: accessUrl(pasteName),
+        suggestedUrl: suggestUrl(content, pasteName, env.BASE_URL, filename),
+        manageUrl: manageUrl(pasteName, newPasswd),
+        expirationSeconds,
+        expireAt: new Date(
+          now.getTime() + 1000 * expirationSeconds,
+        ).toISOString(),
+      })
     }
   } else {
     let pasteName: string | undefined
@@ -181,25 +170,25 @@ export async function handlePostOrPut(
       )
     }
 
-    let passwd = passwdFromForm || genRandStr(params.DEFAULT_PASSWD_LEN)
+    const passwd = passwdFromForm || genRandStr(params.DEFAULT_PASSWD_LEN)
     if (passwd.length === 0) {
       throw new WorkerError(400, "Empty passwd is not allowed")
     }
-    await createPaste(env, pasteName!, content, {
+    await createPaste(env, pasteName, content, {
       expirationSeconds,
       now,
       passwd,
       filename,
     })
 
-    return makeResponse(
-      {
-        url: accessUrl(pasteName),
-        suggestedUrl: suggestUrl(content, pasteName, env.BASE_URL, filename),
-        manageUrl: manageUrl(pasteName, passwd),
-        expirationSeconds,
-      },
-      now,
-    )
+    return makeResponse({
+      url: accessUrl(pasteName),
+      suggestedUrl: suggestUrl(content, pasteName, env.BASE_URL, filename),
+      manageUrl: manageUrl(pasteName, passwd),
+      expirationSeconds,
+      expireAt: new Date(
+        now.getTime() + 1000 * expirationSeconds,
+      ).toISOString(),
+    })
   }
 }

src/index.ts

@@ -39,7 +39,7 @@ async function handleRequest(
         }),
       )
     } else {
-      let err = e as Error
+      const err = e as Error
       console.log(err.stack)
       return corsWrapResponse(
         new Response(`Error 500: ${err.message}\n`, { status: 500 }),

src/pages/markdown.ts

@@ -1,4 +1,5 @@
 import { unified } from "unified"
+import { Root } from "mdast"
 import remarkParse from "remark-parse"
 import remarkGfm from "remark-gfm"
 import remarkRehype from "remark-rehype"
@@ -15,8 +16,8 @@ type DocMetadata = {
   description: string
 }
 
-function getMetadata(options: { result: DocMetadata }): (tree: any) => void {
-  return (tree) => {
+function getMetadata(options: { result: DocMetadata }): (_: Root) => void {
+  return (tree: Root) => {
     if (tree.children.length === 0) return
 
     const firstChild = tree.children[0]

src/parseFormdata.ts

@@ -103,7 +103,7 @@ export function parseFormdata(
         break
       }
     }
-    let key = decode(line.slice(0, curIdx + 1))
+    const key = decode(line.slice(0, curIdx + 1))
 
     curIdx++ // now curIdx points to the next char after ':'
     while (curIdx < line.length) {
@@ -114,7 +114,7 @@ export function parseFormdata(
       }
     }
 
-    let value = decode(line.slice(curIdx))
+    const value = decode(line.slice(curIdx))
     return [key, value]
   }
 
@@ -144,8 +144,6 @@ export function parseFormdata(
     return LineType.NORMAL
   }
 
-  let decoder = new TextDecoder()
-
   enum DecoderState {
     WANT_HEADER,
     WANT_BODY,
@@ -154,12 +152,12 @@ export function parseFormdata(
   // 0: expecting a header
   // 1: expecting body or boundary
   let state = DecoderState.WANT_HEADER
-  let parts: Map<string, FormDataPart> = new Map()
+  const parts: Map<string, FormDataPart> = new Map()
   let lineStart = readLine(0) + 2
 
   let bodyStartIdx = 0
   let curDisposition: FormDataDisposition | undefined = undefined
-  let curHeaders: Map<string, string> = new Map()
+  const curHeaders: Map<string, string> = new Map()
 
   while (true) {
     const lineEnd = readLine(lineStart)
@@ -181,7 +179,7 @@ export function parseFormdata(
       const lineType = getLineType(line)
       if (lineType !== LineType.NORMAL) {
         // current line is boundary or EOF
-        let content = uint8Array.subarray(bodyStartIdx, lineStart - 2)
+        const content = uint8Array.subarray(bodyStartIdx, lineStart - 2)
         parts.set(curDisposition!.name, {
           disposition: curDisposition!,
           headers: curHeaders,