feat: Update ESLint config to fix imports/exports (#109)

packages/cloudflare/eslint.config.mjs

@@ -1,6 +1,8 @@
+import pluginJs from "@eslint/js";
+import importPlugin from "eslint-plugin-import";
+import simpleImportSort from "eslint-plugin-simple-import-sort";
 import eslintPluginUnicorn from "eslint-plugin-unicorn";
 import globals from "globals";
-import pluginJs from "@eslint/js";
 import tseslint from "typescript-eslint";
 
 export default [
@@ -18,13 +20,20 @@ export default [
   pluginJs.configs.recommended,
   ...tseslint.configs.recommended,
   {
+    name: "open-next",
     plugins: {
       unicorn: eslintPluginUnicorn,
+      "simple-import-sort": simpleImportSort,
+      import: importPlugin,
     },
     rules: {
       "@typescript-eslint/ban-ts-comment": "off",
       "unicorn/prefer-node-protocol": "error",
-      "sort-imports": "error",
+      "simple-import-sort/imports": "error",
+      "simple-import-sort/exports": "error",
+      "import/first": "error",
+      "import/newline-after-import": "error",
+      "import/no-duplicates": "error",
     },
   },
 ];

packages/cloudflare/package.json

@@ -46,6 +46,8 @@
     "@types/node": "catalog:",
     "esbuild": "catalog:",
     "eslint": "catalog:",
+    "eslint-plugin-import": "^2.31.0",
+    "eslint-plugin-simple-import-sort": "^12.1.1",
     "eslint-plugin-unicorn": "catalog:",
     "glob": "catalog:",
     "globals": "catalog:",

packages/cloudflare/src/cli/args.ts

@@ -1,6 +1,6 @@
-import { type Stats, mkdirSync, statSync } from "node:fs";
-import { parseArgs } from "node:util";
+import { mkdirSync, type Stats, statSync } from "node:fs";
 import { resolve } from "node:path";
+import { parseArgs } from "node:util";
 
 export function getArgs(): {
   skipNextBuild: boolean;

packages/cloudflare/src/cli/build/build-next-app.ts

@@ -1,6 +1,7 @@
-import { type AgentName as PackageManager, detect } from "package-manager-detector";
 import { execSync } from "node:child_process";
 
+import { type AgentName as PackageManager, detect } from "package-manager-detector";
+
 /**
  * Builds the Next.js app in the standard Next.js cli way (this outputs a `.next` directory)
  *

packages/cloudflare/src/cli/build/build-worker.ts

@@ -1,21 +1,23 @@
-import { Plugin, build } from "esbuild";
+import { existsSync, readFileSync } from "node:fs";
 import { cp, readFile, writeFile } from "node:fs/promises";
 import { dirname, join } from "node:path";
-import { existsSync, readFileSync } from "node:fs";
+import { fileURLToPath } from "node:url";
+
+import { build, Plugin } from "esbuild";
+
 import { Config } from "../config";
 import { copyPackageCliFiles } from "./patches/investigated/copy-package-cli-files";
-import { copyPrerenderedRoutes } from "./utils";
-import { fileURLToPath } from "node:url";
+import { patchCache } from "./patches/investigated/patch-cache";
+import { patchRequire } from "./patches/investigated/patch-require";
+import { updateWebpackChunksFile } from "./patches/investigated/update-webpack-chunks-file";
 import { inlineEvalManifest } from "./patches/to-investigate/inline-eval-manifest";
 import { inlineMiddlewareManifestRequire } from "./patches/to-investigate/inline-middleware-manifest-require";
 import { inlineNextRequire } from "./patches/to-investigate/inline-next-require";
-import { patchCache } from "./patches/investigated/patch-cache";
 import { patchExceptionBubbling } from "./patches/to-investigate/patch-exception-bubbling";
 import { patchFindDir } from "./patches/to-investigate/patch-find-dir";
 import { patchReadFile } from "./patches/to-investigate/patch-read-file";
-import { patchRequire } from "./patches/investigated/patch-require";
 import { patchWranglerDeps } from "./patches/to-investigate/wrangler-deps";
-import { updateWebpackChunksFile } from "./patches/investigated/update-webpack-chunks-file";
+import { copyPrerenderedRoutes } from "./utils";
 
 /** The dist directory of the Cloudflare adapter package */
 const packageDistDir = join(dirname(fileURLToPath(import.meta.url)), "..");

packages/cloudflare/src/cli/build/index.ts

@@ -1,10 +1,11 @@
-import { containsDotNextDir, getConfig } from "../config";
+import { cpSync } from "node:fs";
+import { rm } from "node:fs/promises";
+import { join } from "node:path";
+
 import type { ProjectOptions } from "../config";
+import { containsDotNextDir, getConfig } from "../config";
 import { buildNextjsApp } from "./build-next-app";
 import { buildWorker } from "./build-worker";
-import { cpSync } from "node:fs";
-import { join } from "node:path";
-import { rm } from "node:fs/promises";
 
 /**
  * Builds the application in a format that can be passed to workerd

packages/cloudflare/src/cli/build/patches/investigated/copy-package-cli-files.ts

@@ -1,7 +1,8 @@
-import { Config } from "../../../config";
 import { cpSync } from "node:fs";
 import { join } from "node:path";
 
+import { Config } from "../../../config";
+
 /**
  * Copies the template files present in the cloudflare adapter package into the standalone node_modules folder
  */

packages/cloudflare/src/cli/build/patches/investigated/patch-cache.ts

@@ -1,7 +1,9 @@
-import { Config } from "../../../config";
-import { build } from "esbuild";
 import { join } from "node:path";
 
+import { build } from "esbuild";
+
+import { Config } from "../../../config";
+
 /**
  * Sets up the OpenNext cache handler in a Next.js build.
  *

packages/cloudflare/src/cli/build/patches/investigated/update-webpack-chunks-file/get-chunk-installation-identifiers.test.ts

@@ -1,7 +1,9 @@
-import { describe, expect, test } from "vitest";
-import { getChunkInstallationIdentifiers } from "./get-chunk-installation-identifiers";
 import { readFile } from "node:fs/promises";
+
+import { describe, expect, test } from "vitest";
+
 import { tsParseFile } from "../../../utils";
+import { getChunkInstallationIdentifiers } from "./get-chunk-installation-identifiers";
 
 describe("getChunkInstallationIdentifiers", () => {
   test("gets chunk identifiers from unminified code", async () => {

packages/cloudflare/src/cli/build/patches/investigated/update-webpack-chunks-file/get-file-content-with-updated-webpack-f-require-code.test.ts

@@ -1,7 +1,9 @@
-import { describe, expect, test } from "vitest";
-import { getFileContentWithUpdatedWebpackFRequireCode } from "./get-file-content-with-updated-webpack-f-require-code";
 import { readFile } from "node:fs/promises";
+
+import { describe, expect, test } from "vitest";
+
 import { tsParseFile } from "../../../utils";
+import { getFileContentWithUpdatedWebpackFRequireCode } from "./get-file-content-with-updated-webpack-f-require-code";
 
 describe("getFileContentWithUpdatedWebpackFRequireCode", () => {
   test("returns the updated content of the f.require function from unminified webpack runtime code", async () => {

packages/cloudflare/src/cli/build/patches/investigated/update-webpack-chunks-file/get-updated-webpack-chunks-file-content.test.ts

@@ -1,6 +1,8 @@
+import { readFile } from "node:fs/promises";
+
 import { describe, expect, test } from "vitest";
+
 import { getUpdatedWebpackChunksFileContent } from "./get-updated-webpack-chunks-file-content";
-import { readFile } from "node:fs/promises";
 
 describe("getUpdatedWebpackChunksFileContent", () => {
   test("returns the updated content of a webpack runtime chunks unminified file", async () => {

packages/cloudflare/src/cli/build/patches/investigated/update-webpack-chunks-file/get-updated-webpack-chunks-file-content.ts

@@ -1,6 +1,6 @@
+import { tsParseFile } from "../../../utils";
 import { getChunkInstallationIdentifiers } from "./get-chunk-installation-identifiers";
 import { getFileContentWithUpdatedWebpackFRequireCode } from "./get-file-content-with-updated-webpack-f-require-code";
-import { tsParseFile } from "../../../utils";
 
 /**
  * Updates the content of the webpack runtime file in a manner so that it doesn't perform runtime dynamic `require` calls which fail in our runtime.

packages/cloudflare/src/cli/build/patches/investigated/update-webpack-chunks-file/index.ts

@@ -1,7 +1,8 @@
-import { readFileSync, readdirSync, writeFileSync } from "node:fs";
+import { readdirSync, readFileSync, writeFileSync } from "node:fs";
+import { join } from "node:path";
+
 import { Config } from "../../../../config";
 import { getUpdatedWebpackChunksFileContent } from "./get-updated-webpack-chunks-file-content";
-import { join } from "node:path";
 
 /**
  * Fixes the webpack-runtime.js file by removing its webpack dynamic requires.

packages/cloudflare/src/cli/build/patches/to-investigate/inline-eval-manifest.ts

@@ -1,6 +1,8 @@
 import { join, posix } from "node:path";
-import { Config } from "../../../config";
+
 import { globSync } from "glob";
+
+import { Config } from "../../../config";
 import { normalizePath } from "../../utils";
 
 /**

packages/cloudflare/src/cli/build/patches/to-investigate/inline-middleware-manifest-require.ts

@@ -1,7 +1,8 @@
 import { existsSync, readFileSync } from "node:fs";
-import { Config } from "../../../config";
 import { join } from "node:path";
 
+import { Config } from "../../../config";
+
 /**
  * Inlines the middleware manifest from the build output to prevent a dynamic require statement
  * as they result in runtime failures.

packages/cloudflare/src/cli/build/patches/to-investigate/inline-next-require.ts

@@ -1,7 +1,8 @@
 import { existsSync, readFileSync } from "node:fs";
-import { Config } from "../../../config";
 import { join } from "node:path";
 
+import { Config } from "../../../config";
+
 /**
  * The following avoid various Next.js specific files `require`d at runtime since we can just read
  * and inline their content during build time

packages/cloudflare/src/cli/build/patches/to-investigate/patch-find-dir.ts

@@ -1,7 +1,8 @@
-import { Config } from "../../../config";
 import { existsSync } from "node:fs";
 import { join } from "node:path";
 
+import { Config } from "../../../config";
+
 /**
  * Here we patch `findDir` so that the next server can detect whether the `app` or `pages` directory exists
  * (source: https://github.com/vercel/next.js/blob/ba995993/packages/next/src/lib/find-pages-dir.ts#L4-L13)

packages/cloudflare/src/cli/build/patches/to-investigate/patch-read-file.ts

@@ -1,8 +1,10 @@
+import { readFileSync } from "node:fs";
 import { join, posix } from "node:path";
-import { Config } from "../../../config";
+
 import { globSync } from "glob";
+
+import { Config } from "../../../config";
 import { normalizePath } from "../../utils";
-import { readFileSync } from "node:fs";
 
 export function patchReadFile(code: string, config: Config): string {
   console.log("# patchReadFile");

packages/cloudflare/src/cli/build/patches/to-investigate/wrangler-deps.ts

@@ -1,7 +1,8 @@
 import { readFileSync, statSync, writeFileSync } from "node:fs";
-import { Config } from "../../../config";
 import { join } from "node:path";
 
+import { Config } from "../../../config";
+
 export function patchWranglerDeps(config: Config) {
   console.log("# patchWranglerDeps");
 

packages/cloudflare/src/cli/build/utils/copy-prerendered-routes.ts

@@ -1,8 +1,10 @@
-import { NEXT_META_SUFFIX, SEED_DATA_DIR } from "../../constants/incremental-cache";
 import { copyFileSync, existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
 import { dirname, join } from "node:path";
-import { Config } from "../../config";
+
 import type { PrerenderManifest } from "next/dist/build";
+
+import { Config } from "../../config";
+import { NEXT_META_SUFFIX, SEED_DATA_DIR } from "../../constants/incremental-cache";
 import { readPathsRecursively } from "./read-paths-recursively";
 
 /**

packages/cloudflare/src/cli/build/utils/index.ts

@@ -1,3 +1,3 @@
-export * from "./ts-parse-file";
 export * from "./copy-prerendered-routes";
 export * from "./normalize-path";
+export * from "./ts-parse-file";

packages/cloudflare/src/cli/build/utils/read-paths-recursively.ts

@@ -1,5 +1,5 @@
-import { join } from "node:path";
 import { readdirSync } from "node:fs";
+import { join } from "node:path";
 
 /**
  * Recursively reads all file paths in a directory.

packages/cloudflare/src/cli/config.ts

@@ -1,5 +1,5 @@
-import { join, relative } from "node:path";
 import { readdirSync, statSync } from "node:fs";
+import { join, relative } from "node:path";
 
 const PACKAGE_NAME = "@opennextjs/cloudflare";
 

packages/cloudflare/src/cli/index.ts

@@ -1,9 +1,10 @@
 #!/usr/bin/env node
-import { build } from "./build";
 import { existsSync } from "node:fs";
-import { getArgs } from "./args";
 import { resolve } from "node:path";
 
+import { getArgs } from "./args";
+import { build } from "./build";
+
 const nextAppDir = resolve(".");
 
 console.log(`Building the Next.js app in the current folder (${nextAppDir})`);

packages/cloudflare/src/cli/templates/cache-handler/open-next-cache-handler.ts

@@ -1,8 +1,11 @@
+import type { KVNamespace } from "@cloudflare/workers-types";
 import type {
   CacheHandler,
   CacheHandlerContext,
   CacheHandlerValue,
 } from "next/dist/server/lib/incremental-cache";
+import type { IncrementalCacheValue } from "next/dist/server/response-cache";
+
 import {
   NEXT_BODY_SUFFIX,
   NEXT_DATA_SUFFIX,
@@ -12,8 +15,6 @@ import {
   SEED_DATA_DIR,
 } from "../../constants/incremental-cache";
 import { getSeedBodyFile, getSeedMetaFile, getSeedTextFile, parseCtx } from "./utils";
-import type { IncrementalCacheValue } from "next/dist/server/response-cache";
-import type { KVNamespace } from "@cloudflare/workers-types";
 
 type CacheEntry = {
   lastModified: number;

packages/cloudflare/src/cli/templates/cache-handler/utils.ts

@@ -1,4 +1,5 @@
 import type { IncrementalCache } from "next/dist/server/lib/incremental-cache";
+
 import { NEXT_META_SUFFIX } from "../../constants/incremental-cache";
 
 type PrerenderedRouteMeta = {

packages/cloudflare/src/cli/templates/worker.ts

@@ -1,12 +1,14 @@
-import type { ExportedHandler, Fetcher } from "@cloudflare/workers-types";
-import { NodeNextRequest, NodeNextResponse } from "next/dist/server/base-http/node";
 import { AsyncLocalStorage } from "node:async_hooks";
-import type { CloudflareContext } from "../../api";
 import type { IncomingMessage } from "node:http";
-import { MockedResponse } from "next/dist/server/lib/mock-request";
+import Stream from "node:stream";
+
+import type { ExportedHandler, Fetcher } from "@cloudflare/workers-types";
 import type { NextConfig } from "next";
+import { NodeNextRequest, NodeNextResponse } from "next/dist/server/base-http/node";
+import { MockedResponse } from "next/dist/server/lib/mock-request";
 import type { NodeRequestHandler } from "next/dist/server/next-server";
-import Stream from "node:stream";
+
+import type { CloudflareContext } from "../../api";
 
 const NON_BODY_RESPONSES = new Set([101, 204, 205, 304]);
 

packages/cloudflare/tsup.config.ts

@@ -1,4 +1,5 @@
 import { cp } from "node:fs/promises";
+
 import { defineConfig } from "tsup";
 
 const cliConfig = defineConfig({