Remove explicit any types from the codebase (#208)

This change removes all use of `any` from the code and updates the `no-explicit-any` eslint rule to be an error.

Author: petebacondarwin

.changeset/cyan-crews-try.md

@@ -0,0 +1,7 @@
+---
+"wrangler": patch
+---
+
+Remove explicit `any` types from the codebase
+
+This change removes all use of `any` from the code and updates the `no-explicit-any` eslint rule to be an error.

.vscode/settings.json

@@ -2,10 +2,14 @@
   "editor.defaultFormatter": "esbenp.prettier-vscode",
   "cSpell.words": [
     "cfetch",
+    "esbuild",
+    "estree",
     "execa",
     "iarna",
     "keyvalue",
+    "middlewares",
     "Miniflare",
+    "outfile",
     "Positionals"
   ]
 }

package.json

@@ -79,6 +79,7 @@
           ],
           "no-shadow": "error",
           "@typescript-eslint/no-floating-promises": "error",
+          "@typescript-eslint/no-explicit-any": "error",
           "no-empty": "off",
           "require-yield": "off",
           "no-empty-function": "off",

packages/wrangler/pages/functions/filepath-routing.ts

@@ -1,13 +1,10 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-
 import path from "path";
 import fs from "fs/promises";
 import { transform } from "esbuild";
 import * as acorn from "acorn";
 import * as acornWalk from "acorn-walk";
-import type { Config } from "./routes";
-import type { Identifier } from "estree";
-import type { ExportNamedDeclaration } from "@babel/types";
+import type { Config, RouteConfig } from "./routes";
+import type { ExportNamedDeclaration, Identifier } from "estree";
 
 type Arguments = {
   baseDir: string;
@@ -18,10 +15,7 @@ export async function generateConfigFromFileTree({
   baseDir,
   baseURL,
 }: Arguments) {
-  let routeEntries: [
-    string,
-    { [key in "module" | "middleware"]?: string[] }
-  ][] = [] as any;
+  let routeEntries: [string, RouteConfig][] = [];
 
   if (!baseURL.startsWith("/")) {
     baseURL = `/${baseURL}`;
@@ -45,8 +39,10 @@ export async function generateConfigFromFileTree({
         sourceType: "module",
       });
       acornWalk.simple(ast, {
-        ExportNamedDeclaration(_node) {
-          const node: ExportNamedDeclaration = _node as any;
+        ExportNamedDeclaration(_node: unknown) {
+          // This dynamic cast assumes that the AST generated by acornWalk will generate nodes that
+          // are compatible with the eslint AST nodes.
+          const node = _node as ExportNamedDeclaration;
 
           // this is an array because multiple things can be exported from a single statement
           // i.e. `export {foo, bar}` or `export const foo = "f", bar = "b"`

packages/wrangler/pages/functions/identifiers.ts

@@ -68,7 +68,7 @@ export const validIdentifierRegex = new RegExp(
   "u"
 );
 
-export const isValidIdentifer = (identifier: string) =>
+export const isValidIdentifier = (identifier: string) =>
   validIdentifierRegex.test(identifier);
 
 export const normalizeIdentifier = (identifier: string) =>

packages/wrangler/pages/functions/routes.ts

@@ -1,8 +1,6 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-
 import path from "path";
 import fs from "fs/promises";
-import { isValidIdentifer, normalizeIdentifier } from "./identifiers";
+import { isValidIdentifier, normalizeIdentifier } from "./identifiers";
 
 export const HTTP_METHODS = [
   "HEAD",
@@ -17,7 +15,7 @@ export type HTTPMethod = typeof HTTP_METHODS[number];
 export function isHTTPMethod(
   maybeHTTPMethod: string
 ): maybeHTTPMethod is HTTPMethod {
-  return HTTP_METHODS.includes(maybeHTTPMethod as any);
+  return (HTTP_METHODS as readonly string[]).includes(maybeHTTPMethod);
 }
 
 export type RoutesCollection = Array<{
@@ -29,14 +27,16 @@ export type RoutesCollection = Array<{
 
 export type Config = {
   routes?: RoutesConfig;
-  schedules?: any;
+  schedules?: unknown;
 };
 
 export type RoutesConfig = {
-  [route: string]: {
-    middleware?: string | string[];
-    module?: string | string[];
-  };
+  [route: string]: RouteConfig;
+};
+
+export type RouteConfig = {
+  middleware?: string | string[];
+  module?: string | string[];
 };
 
 type ImportMap = Map<
@@ -93,7 +93,7 @@ export function parseConfig(config: Config, baseDir: string) {
       }
 
       // ensure the module name (if provided) is a valid identifier to guard against injection attacks
-      if (name !== "default" && !isValidIdentifer(name)) {
+      if (name !== "default" && !isValidIdentifier(name)) {
         throw new Error(`Invalid module identifier "${name}"`);
       }
 

packages/wrangler/pages/functions/template-worker.ts

@@ -1,14 +1,12 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-
 import { match } from "path-to-regexp";
 import type { HTTPMethod } from "./routes";
 
 /* TODO: Grab these from @cloudflare/workers-types instead */
-type Params<P extends string = any> = Record<P, string | string[]>;
+type Params<P extends string = string> = Record<P, string | string[]>;
 
 type EventContext<Env, P extends string, Data> = {
   request: Request;
-  waitUntil: (promise: Promise<any>) => void;
+  waitUntil: (promise: Promise<unknown>) => void;
   next: (input?: Request | string, init?: RequestInit) => Promise<Response>;
   env: Env & { ASSETS: { fetch: typeof fetch } };
   params: Params<P>;
@@ -17,7 +15,7 @@ type EventContext<Env, P extends string, Data> = {
 
 declare type PagesFunction<
   Env = unknown,
-  P extends string = any,
+  P extends string = string,
   Data extends Record<string, unknown> = Record<string, unknown>
 > = (context: EventContext<Env, P, Data>) => Response | Promise<Response>;
 /* end @cloudflare/workers-types */
@@ -34,12 +32,12 @@ declare const routes: RouteHandler[];
 
 // expect an ASSETS fetcher binding pointing to the asset-server stage
 type Env = {
-  [name: string]: any;
+  [name: string]: unknown;
   ASSETS: { fetch(url: string, init: RequestInit): Promise<Response> };
 };
 
 type WorkerContext = {
-  waitUntil: (promise: Promise<any>) => void;
+  waitUntil: (promise: Promise<unknown>) => void;
 };
 
 function* executeRequest(request: Request, env: Env) {
@@ -107,7 +105,11 @@ export default {
       const { value } = handlerIterator.next();
       if (value) {
         const { handler, params } = value;
-        const context: EventContext<unknown, any, any> = {
+        const context: EventContext<
+          unknown,
+          string,
+          Record<string, unknown>
+        > = {
           request: new Request(request.clone()),
           next,
           params,

packages/wrangler/src/cfetch/index.ts

@@ -98,6 +98,5 @@ function throwFetchError(
 }
 
 function hasCursor(result_info: unknown): result_info is { cursor: string } {
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  return (result_info as any)?.cursor !== undefined;
+  return (result_info as { cursor } | undefined)?.cursor !== undefined;
 }