chore: clean up eslint config (#558)

* chore: remove extreneous lint rules and ignore statements

* chore: add rule to sort imports alphabetically

Author: mrstork

.eslintrc.cjs

@@ -8,29 +8,36 @@ module.exports = {
   },
   rules: {
     'arrow-body-style': 'off',
-    'no-param-reassign': ['error', { props: false }],
-    'no-underscore-dangle': 'off',
-    'no-magic-numbers': 'off',
-    'n/prefer-global/process': 'off',
-    'unicorn/numeric-separators-style': 'off',
-    'unicorn/filename-case': ['error', { case: 'kebabCase' }],
-    'import/no-extraneous-dependencies': 'off',
-    'import/no-namespace': 'off',
+    'class-methods-use-this': 'off',
+    complexity: 'off',
+    'func-style': 'off',
     'import/extensions': 'off',
+    'line-comment-position': 'off',
     'max-depth': 'off',
-    'func-style': 'off',
-    'class-methods-use-this': 'off',
-    'promise/prefer-await-to-then': 'off',
-    'promise/prefer-await-to-callbacks': 'off',
-    'promise/catch-or-return': 'off',
-    'promise/always-return': 'off',
+    'max-lines': 'off',
+    'max-lines-per-function': 'off',
     'max-nested-callbacks': 'off',
     'max-statements': 'off',
-    'require-await': 'off',
+    'n/prefer-global/process': 'off',
     'no-inline-comments': 'off',
-    'line-comment-position': 'off',
-    complexity: 'off',
-    'max-lines': 'off',
+    'no-magic-numbers': 'off',
+    'no-param-reassign': ['error', { props: false }],
+    'no-underscore-dangle': 'off',
+    'promise/always-return': 'off',
+    'promise/catch-or-return': 'off',
+    'promise/prefer-await-to-callbacks': 'off',
+    'promise/prefer-await-to-then': 'off',
+    'require-await': 'off',
+    'sort-imports': [
+      'error',
+      {
+        allowSeparatedGroups: true,
+        ignoreCase: true,
+        ignoreDeclarationSort: true,
+      },
+    ],
+    'unicorn/filename-case': ['error', { case: 'kebabCase' }],
+    'unicorn/numeric-separators-style': 'off',
   },
   overrides: [
     ...overrides,
@@ -46,55 +53,23 @@ module.exports = {
         '@typescript-eslint/no-floating-promises': 'error',
       },
     },
-    {
-      files: ['src/run/**'],
-      rules: {
-        'no-restricted-imports': [
-          'error',
-          {
-            paths: [
-              {
-                name: '@opentelemetry/api',
-                importNames: ['trace'],
-                message: 'Please use `getTracer()` from `./handlers/tracer.cjs` instead',
-              },
-            ],
-          },
-        ],
-      },
-    },
     {
       files: ['src/run/handlers/**'],
       rules: {
-        'max-statements': ['error', 30],
         'import/no-anonymous-default-export': 'off',
       },
     },
     {
-      files: ['src/**/*.test.*'],
-      rules: {
-        'max-statements': 'off',
-        'max-lines-per-function': 'off',
-      },
-    },
-    {
-      files: ['src/build/**/*.ts'],
+      files: ['src/run/**'],
       rules: {
         'no-restricted-imports': [
           'error',
           {
             paths: [
               {
-                name: 'path',
-                importNames: ['resolve'],
-                message:
-                  'Please use `PluginContext.resolve` instead to comply with our monorepo support',
-              },
-              {
-                name: 'node:path',
-                importNames: ['resolve'],
-                message:
-                  'Please use `PluginContext.resolve` instead to comply with our monorepo support',
+                name: '@opentelemetry/api',
+                importNames: ['trace'],
+                message: 'Please use `getTracer()` from `./handlers/tracer.cjs` instead',
               },
             ],
           },
@@ -104,10 +79,10 @@ module.exports = {
     {
       files: ['src/build/templates/**/*'],
       rules: {
-        'n/no-missing-import': 'off',
-        'import/no-unresolved': 'off',
-        'import/no-anonymous-default-export': 'off',
         'func-names': 'off',
+        'import/no-anonymous-default-export': 'off',
+        'import/no-unresolved': 'off',
+        'n/no-missing-import': 'off',
       },
     },
   ],

e2e-report/app/layout.js

@@ -1,4 +1,3 @@
-// eslint-disable-next-line import/no-unassigned-import
 import './globals.scss'
 
 export const metadata = {

edge-runtime/lib/routing.ts

@@ -10,7 +10,7 @@ import type { Key } from '../vendor/deno.land/x/[email protected]/index.ts'
 import { compile, pathToRegexp } from '../vendor/deno.land/x/[email protected]/index.ts'
 import { getCookies } from '../vendor/deno.land/[email protected]/http/cookie.ts'
 
-/* 
+/*
   ┌─────────────────────────────────────────────────────────────────────────┐
   │ Inlined/re-implemented types                                            │
   └─────────────────────────────────────────────────────────────────────────┘
@@ -86,7 +86,7 @@ export type RoutesManifest = {
   dynamicRoutes: DynamicRoute[]
 }
 
-/* 
+/*
   ┌─────────────────────────────────────────────────────────────────────────┐
   │ packages/next/src/shared/lib/escape-regexp.ts                           │
   └─────────────────────────────────────────────────────────────────────────┘
@@ -104,7 +104,7 @@ export function escapeStringRegexp(str: string) {
   return str
 }
 
-/* 
+/*
   ┌─────────────────────────────────────────────────────────────────────────┐
   │ packages/next/src/shared/lib/router/utils/querystring.ts                │
   └─────────────────────────────────────────────────────────────────────────┘
@@ -125,7 +125,7 @@ export function searchParamsToUrlQuery(searchParams: URLSearchParams): ParsedUrl
   return query
 }
 
-/* 
+/*
   ┌─────────────────────────────────────────────────────────────────────────┐
   │ packages/next/src/shared/lib/router/utils/parse-url.ts                  │
   └─────────────────────────────────────────────────────────────────────────┘
@@ -156,7 +156,7 @@ export function parseUrl(url: string): ParsedUrl {
   }
 }
 
-/* 
+/*
   ┌─────────────────────────────────────────────────────────────────────────┐
   │ packages/next/src/shared/lib/router/utils/prepare-destination.ts        │
   │ — Changed to use WHATWG Fetch `Request` instead of                      │
@@ -392,7 +392,7 @@ function unescapeSegments(str: string) {
   return str.replace(/__ESC_COLON_/gi, ':')
 }
 
-/* 
+/*
   ┌─────────────────────────────────────────────────────────────────────────┐
   │ packages/next/src/shared/lib/router/utils/is-dynamic.ts                 │
   └─────────────────────────────────────────────────────────────────────────┘
@@ -404,7 +404,7 @@ export function isDynamicRoute(route: string): boolean {
   return TEST_ROUTE.test(route)
 }
 
-/* 
+/*
   ┌─────────────────────────────────────────────────────────────────────────┐
   │ packages/next/shared/lib/router/utils/middleware-route-matcher.ts       │
   └─────────────────────────────────────────────────────────────────────────┘

src/build/content/prerendered.ts

@@ -11,8 +11,8 @@ import { encodeBlobKey } from '../../shared/blobkey.js'
 import type {
   CachedFetchValue,
   CachedPageValue,
-  NetlifyCacheHandlerValue,
   NetlifyCachedRouteValue,
+  NetlifyCacheHandlerValue,
   NetlifyIncrementalCacheValue,
 } from '../../shared/cache-types.cjs'
 import type { PluginContext } from '../plugin-context.js'

src/build/content/server.test.ts

@@ -2,15 +2,15 @@ import { readFile } from 'node:fs/promises'
 import { join } from 'node:path'
 
 import { NetlifyPluginOptions } from '@netlify/build'
-import { expect, test, vi, describe, beforeEach } from 'vitest'
+import { beforeEach, describe, expect, test, vi } from 'vitest'
 
 import { mockFileSystem } from '../../../tests/index.js'
 import { PluginContext, RequiredServerFilesManifest } from '../plugin-context.js'
 
 import {
-  NextInternalModuleReplacement,
   copyNextServerCode,
   getPatchesToApply,
+  NextInternalModuleReplacement,
   verifyHandlerDirStructure,
 } from './server.js'
 

src/build/content/server.ts

@@ -3,14 +3,13 @@ import {
   access,
   cp,
   mkdir,
-  readFile,
   readdir,
+  readFile,
   readlink,
   symlink,
   writeFile,
 } from 'node:fs/promises'
 import { createRequire } from 'node:module'
-// eslint-disable-next-line no-restricted-imports
 import { dirname, join, resolve, sep } from 'node:path'
 import { join as posixJoin, sep as posixSep } from 'node:path/posix'
 

src/build/content/static.test.ts

@@ -4,7 +4,7 @@ import { inspect } from 'node:util'
 
 import type { NetlifyPluginOptions } from '@netlify/build'
 import glob from 'fast-glob'
-import { Mock, beforeEach, describe, expect, test, vi } from 'vitest'
+import { beforeEach, describe, expect, Mock, test, vi } from 'vitest'
 
 import { mockFileSystem } from '../../../tests/index.js'
 import { type FixtureTestContext } from '../../../tests/utils/contexts.js'

src/build/image-cdn.test.ts

@@ -1,7 +1,6 @@
-/* eslint-disable id-length */
 import type { NetlifyPluginOptions } from '@netlify/build'
 import type { NextConfigComplete } from 'next/dist/server/config-shared.js'
-import { TestContext, beforeEach, describe, expect, test } from 'vitest'
+import { beforeEach, describe, expect, test, TestContext } from 'vitest'
 
 import { setImageConfig } from './image-cdn.js'
 import { PluginContext, type RequiredServerFilesManifest } from './plugin-context.js'
@@ -35,11 +34,8 @@ describe('Image CDN', () => {
       expect.arrayContaining([
         {
           from: '/_next/image',
-          query: {
-            q: ':quality',
-            url: ':url',
-            w: ':width',
-          },
+          // eslint-disable-next-line id-length
+          query: { q: ':quality', url: ':url', w: ':width' },
           to: '/.netlify/images?url=:url&w=:width&q=:quality',
           status: 200,
         },
@@ -64,11 +60,8 @@ describe('Image CDN', () => {
       expect.arrayContaining([
         {
           from: '/_next/image',
-          query: {
-            q: ':quality',
-            url: ':url',
-            w: ':width',
-          },
+          // eslint-disable-next-line id-length
+          query: { q: ':quality', url: ':url', w: ':width' },
           to: '/.netlify/images?url=:url&w=:width&q=:quality',
           status: 200,
         },
@@ -97,16 +90,12 @@ describe('Image CDN', () => {
       expect.arrayContaining([
         {
           from: '/base/path/_custom/image/endpoint',
-          query: {
-            q: ':quality',
-            url: ':url',
-            w: ':width',
-          },
+          // eslint-disable-next-line id-length
+          query: { q: ':quality', url: ':url', w: ':width' },
           to: '/.netlify/images?url=:url&w=:width&q=:quality',
           status: 200,
         },
       ]),
     )
   })
 })
-/* eslint-enable id-length */

src/build/plugin-context.ts

@@ -1,7 +1,5 @@
 import { existsSync, readFileSync } from 'node:fs'
 import { readFile } from 'node:fs/promises'
-// Here we need to actually import `resolve` from node:path as we want to resolve the paths
-// eslint-disable-next-line no-restricted-imports
 import { join, relative, resolve } from 'node:path'
 import { fileURLToPath } from 'node:url'
 

src/run/handlers/server.ts

@@ -5,7 +5,7 @@ import { Context } from '@netlify/functions'
 import type { NextConfigComplete } from 'next/dist/server/config-shared.js'
 import type { WorkerRequestHandler } from 'next/dist/server/lib/types.js'
 
-import { TagsManifest, getTagsManifest } from '../config.js'
+import { getTagsManifest, TagsManifest } from '../config.js'
 import {
   adjustDateHeader,
   setCacheControlHeaders,