build(prettier): improve prettier setup (#1108)

* build(prettier): improve prettier setup

* chore(prettier): fix prettier lint

Author: chimurai

.prettierrc

@@ -2,5 +2,9 @@
   "printWidth": 100,
   "tabWidth": 2,
   "semi": true,
-  "singleQuote": true
+  "singleQuote": true,
+  "plugins": ["@trivago/prettier-plugin-sort-imports"],
+  "importOrder": ["^node:.*$", "<THIRD_PARTY_MODULES>", "^[./]"],
+  "importOrderSeparation": true,
+  "importOrderSortSpecifiers": true
 }

.vscode/settings.json

@@ -3,5 +3,7 @@
   "editor.codeActionsOnSave": {
     "source.fixAll.eslint": "explicit"
   },
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.formatOnSave": true,
   "markdown.extension.toc.levels": "2..3"
 }

README.md

@@ -28,10 +28,8 @@ Proxy `/api` requests to `http://www.example.org`
 
 ```typescript
 // typescript
-
 import * as express from 'express';
-import type { Request, Response, NextFunction } from 'express';
-
+import type { NextFunction, Request, Response } from 'express';
 import { createProxyMiddleware } from 'http-proxy-middleware';
 import type { Filter, Options, RequestHandler } from 'http-proxy-middleware';
 

cspell.json

@@ -1,6 +1,5 @@
 {
   "language": "en",
-  "spellCheckDelayMs": 500,
   "dictionaries": ["node", "npm", "typescript", "contributors"],
   "ignorePaths": [
     "node_modules/**",
@@ -46,6 +45,7 @@
     "restream",
     "snyk",
     "streamify",
+    "trivago",
     "tseslint",
     "typicode",
     "vhosted",

eslint.config.mjs

@@ -1,9 +1,7 @@
 // @ts-check
-
 import eslint from '@eslint/js';
-import tseslint from 'typescript-eslint';
-import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended';
 import globals from 'globals';
+import tseslint from 'typescript-eslint';
 
 export default tseslint.config(
   // replacement of legacy `.eslintignore`
@@ -13,7 +11,6 @@ export default tseslint.config(
   // extends...
   eslint.configs.recommended,
   ...tseslint.configs.recommended,
-  eslintPluginPrettierRecommended,
   // base config
   {
     languageOptions: {
@@ -37,7 +34,6 @@ export default tseslint.config(
         'error',
         { vars: 'all', args: 'none', ignoreRestSiblings: false },
       ],
-      'prettier/prettier': 'warn',
     },
   },
   {

examples/next-app/pages/api/_proxy.ts

@@ -1,4 +1,5 @@
 import type { NextApiRequest, NextApiResponse } from 'next';
+
 import { createProxyMiddleware } from '../../../../dist';
 
 // Singleton

examples/next-app/pages/api/users.ts

@@ -1,4 +1,5 @@
 import type { NextApiRequest, NextApiResponse, PageConfig } from 'next';
+
 import { proxyMiddleware } from './_proxy';
 
 // https://nextjs.org/docs/pages/building-your-application/routing/api-routes

package.json

@@ -59,6 +59,7 @@
     "@commitlint/cli": "19.8.0",
     "@commitlint/config-conventional": "19.8.0",
     "@eslint/js": "9.23.0",
+    "@trivago/prettier-plugin-sort-imports": "5.2.2",
     "@types/debug": "4.1.12",
     "@types/eslint": "9.6.1",
     "@types/express": "4.17.21",
@@ -70,8 +71,6 @@
     "@types/ws": "8.18.0",
     "body-parser": "1.20.3",
     "eslint": "9.23.0",
-    "eslint-config-prettier": "10.1.1",
-    "eslint-plugin-prettier": "5.2.3",
     "express": "4.21.2",
     "get-port": "5.1.1",
     "globals": "16.0.0",

recipes/servers.md

@@ -105,9 +105,9 @@ export const proxyMiddleware = createProxyMiddleware<NextApiRequest, NextApiResp
 
 ```typescript
 // Next project: `/pages/api/users.ts`
-
 // Next.js API route support: https://nextjs.org/docs/api-routes/introduction
 import type { NextApiRequest, NextApiResponse } from 'next';
+
 import { proxyMiddleware } from './users.proxy';
 
 export default function handler(req: NextApiRequest, res: NextApiResponse) {

src/factory.ts

@@ -1,7 +1,8 @@
-import { HttpProxyMiddleware } from './http-proxy-middleware';
-import type { Options, RequestHandler, NextFunction } from './types';
 import type * as http from 'http';
 
+import { HttpProxyMiddleware } from './http-proxy-middleware';
+import type { NextFunction, Options, RequestHandler } from './types';
+
 export function createProxyMiddleware<
   TReq = http.IncomingMessage,
   TRes = http.ServerResponse,

src/get-plugins.ts

@@ -1,10 +1,10 @@
-import type { Options, Plugin } from './types';
 import {
   debugProxyErrorsPlugin,
-  loggerPlugin,
   errorResponsePlugin,
+  loggerPlugin,
   proxyEventsPlugin,
 } from './plugins/default';
+import type { Options, Plugin } from './types';
 
 export function getPlugins<TReq, TRes>(options: Options<TReq, TRes>): Plugin<TReq, TRes>[] {
   // don't load default errorResponsePlugin if user has specified their own

src/handlers/response-interceptor.ts

@@ -1,5 +1,6 @@
 import type * as http from 'http';
 import * as zlib from 'zlib';
+
 import { Debug } from '../debug';
 import { getFunctionName } from '../utils/function';
 

src/http-proxy-middleware.ts

@@ -1,16 +1,17 @@
-import type * as net from 'net';
 import type * as http from 'http';
-import type * as https from 'https';
-import type { RequestHandler, Options, Filter, Logger } from './types';
 import * as httpProxy from 'http-proxy';
+import type * as https from 'https';
+import type * as net from 'net';
+
 import { verifyConfig } from './configuration';
+import { Debug as debug } from './debug';
 import { getPlugins } from './get-plugins';
+import { getLogger } from './logger';
 import { matchPathFilter } from './path-filter';
 import * as PathRewriter from './path-rewriter';
 import * as Router from './router';
-import { Debug as debug } from './debug';
+import type { Filter, Logger, Options, RequestHandler } from './types';
 import { getFunctionName } from './utils/function';
-import { getLogger } from './logger';
 
 export class HttpProxyMiddleware<TReq, TRes> {
   private wsInternalSubscribed = false;

src/legacy/create-proxy-middleware.ts

@@ -1,9 +1,10 @@
-import { createProxyMiddleware } from '../factory';
+import type * as http from 'http';
+
 import { Debug } from '../debug';
+import { createProxyMiddleware } from '../factory';
 import { Filter, RequestHandler } from '../types';
 import { legacyOptionsAdapter } from './options-adapter';
 import { LegacyOptions } from './types';
-import type * as http from 'http';
 
 const debug = Debug.extend('legacy-create-proxy-middleware');
 

src/legacy/options-adapter.ts

@@ -1,9 +1,10 @@
 import * as url from 'url';
-import { Filter, Options } from '../types';
-import { LegacyOptions } from './types';
+
 import { Debug } from '../debug';
 import { getLogger } from '../logger';
+import { Filter, Options } from '../types';
 import { Logger } from '../types';
+import { LegacyOptions } from './types';
 
 const debug = Debug.extend('legacy-options-adapter');
 

src/legacy/types.ts

@@ -1,4 +1,5 @@
 import type * as http from 'http';
+
 import { Options } from '../types';
 
 /**

src/path-filter.ts

@@ -1,9 +1,10 @@
-import type { Filter } from './types';
+import type * as http from 'http';
 import * as isGlob from 'is-glob';
 import * as micromatch from 'micromatch';
 import * as url from 'url';
+
 import { ERRORS } from './errors';
-import type * as http from 'http';
+import type { Filter } from './types';
 
 export function matchPathFilter<TReq = http.IncomingMessage>(
   pathFilter: Filter<TReq> = '/',

src/path-rewriter.ts

@@ -1,6 +1,7 @@
 import { isPlainObject } from 'is-plain-object';
-import { ERRORS } from './errors';
+
 import { Debug } from './debug';
+import { ERRORS } from './errors';
 
 const debug = Debug.extend('path-rewriter');
 

src/plugins/default/error-response-plugin.ts

@@ -1,5 +1,6 @@
 import type * as http from 'http';
 import type { Socket } from 'net';
+
 import { getStatusCode } from '../../status-code';
 import { Plugin } from '../../types';
 

src/plugins/default/logger-plugin.ts

@@ -1,7 +1,9 @@
+import type { IncomingMessage } from 'node:http';
+
 import { URL } from 'url';
-import { Plugin } from '../../types';
+
 import { getLogger } from '../../logger';
-import type { IncomingMessage } from 'node:http';
+import { Plugin } from '../../types';
 import { getPort } from '../../utils/logger-plugin';
 
 type ExpressRequest = {

src/router.ts

@@ -1,4 +1,5 @@
 import { isPlainObject } from 'is-plain-object';
+
 import { Debug } from './debug';
 
 const debug = Debug.extend('router');

src/types.ts

@@ -2,7 +2,6 @@
  * Based on definition by DefinitelyTyped:
  * https://github.com/DefinitelyTyped/DefinitelyTyped/blob/6f529c6c67a447190f86bfbf894d1061e41e07b7/types/http-proxy-middleware/index.d.ts
  */
-
 import type * as http from 'http';
 import type * as httpProxy from 'http-proxy';
 import type * as net from 'net';

test/e2e/express-error-middleware.spec.ts

@@ -1,6 +1,7 @@
-import { createApp, createProxyMiddleware } from './test-kit';
 import * as request from 'supertest';
 
+import { createApp, createProxyMiddleware } from './test-kit';
+
 describe('express error middleware', () => {
   it('should propagate error to express', async () => {
     let httpProxyError: Error | undefined;

test/e2e/express-router.spec.ts

@@ -1,7 +1,8 @@
 import * as express from 'express';
 import * as request from 'supertest';
-import { createProxyMiddleware } from './test-kit';
+
 import { Options } from '../../src/index';
+import { createProxyMiddleware } from './test-kit';
 
 describe('Usage in Express', () => {
   let app: express.Express;

test/e2e/http-proxy-middleware.spec.ts

@@ -1,10 +1,11 @@
-import { createProxyMiddleware, createApp, createAppWithPath, fixRequestBody } from './test-kit';
-import * as request from 'supertest';
-import { Mockttp, getLocal, CompletedRequest } from 'mockttp';
-import type * as http from 'http';
-import type * as express from 'express';
 import * as bodyParser from 'body-parser';
+import type * as express from 'express';
+import type * as http from 'http';
+import { CompletedRequest, Mockttp, getLocal } from 'mockttp';
+import * as request from 'supertest';
+
 import type { Logger } from '../../src/types';
+import { createApp, createAppWithPath, createProxyMiddleware, fixRequestBody } from './test-kit';
 
 describe('E2E http-proxy-middleware', () => {
   describe('http-proxy-middleware creation', () => {

test/e2e/http-server.spec.ts

@@ -1,7 +1,8 @@
 import * as http from 'http';
-import { createProxyMiddleware } from './test-kit';
 import * as request from 'supertest';
 
+import { createProxyMiddleware } from './test-kit';
+
 describe('http integration', () => {
   it('should work with raw node http RequestHandler', async () => {
     const handler = createProxyMiddleware({

test/e2e/path-rewriter.spec.ts

@@ -1,6 +1,7 @@
-import { createProxyMiddleware, createApp } from './test-kit';
+import { Mockttp, getLocal } from 'mockttp';
 import * as request from 'supertest';
-import { getLocal, Mockttp } from 'mockttp';
+
+import { createApp, createProxyMiddleware } from './test-kit';
 
 describe('E2E pathRewrite', () => {
   let mockTargetServer: Mockttp;

test/e2e/plugins.spec.ts

@@ -1,7 +1,8 @@
-import { createProxyMiddleware, createApp } from './test-kit';
+import { Mockttp, getLocal } from 'mockttp';
 import * as request from 'supertest';
-import { getLocal, Mockttp } from 'mockttp';
+
 import type { Options, Plugin } from '../../src/types';
+import { createApp, createProxyMiddleware } from './test-kit';
 
 describe('E2E Plugins', () => {
   let mockTargetServer: Mockttp;

test/e2e/response-interceptor.spec.ts

@@ -1,6 +1,7 @@
+import * as request from 'supertest';
+
 import { createProxyMiddleware, responseInterceptor } from '../../src';
 import { createApp } from './test-kit';
-import * as request from 'supertest';
 
 describe('responseInterceptor()', () => {
   let agent: request.Agent;

test/e2e/router.spec.ts

@@ -1,8 +1,9 @@
-import { createProxyMiddleware, createApp, createAppWithPath } from './test-kit';
 import { ErrorRequestHandler } from 'express';
-import * as request from 'supertest';
-import { getLocal, generateCACertificate, Mockttp } from 'mockttp';
 import * as getPort from 'get-port';
+import { Mockttp, generateCACertificate, getLocal } from 'mockttp';
+import * as request from 'supertest';
+
+import { createApp, createAppWithPath, createProxyMiddleware } from './test-kit';
 
 const untrustedCACert = generateCACertificate({ bits: 1024 });
 

test/e2e/websocket.spec.ts

@@ -1,9 +1,10 @@
+import * as getPort from 'get-port';
 import * as http from 'http';
 import * as WebSocket from 'ws';
 import { Server as WebSocketServer } from 'ws';
-import * as getPort from 'get-port';
-import { createProxyMiddleware, createApp } from './test-kit';
+
 import type { RequestHandler } from '../../src/types';
+import { createApp, createProxyMiddleware } from './test-kit';
 
 /********************************************************************
  * - Not possible to use `supertest` to test WebSockets

test/legacy/http-proxy-middleware.spec.ts

@@ -1,7 +1,8 @@
-import { createApp, createAppWithPath } from '../e2e/test-kit';
-import { legacyCreateProxyMiddleware, LegacyOptions } from '../../src';
-import * as request from 'supertest';
 import { Mockttp, getLocal } from 'mockttp';
+import * as request from 'supertest';
+
+import { LegacyOptions, legacyCreateProxyMiddleware } from '../../src';
+import { createApp, createAppWithPath } from '../e2e/test-kit';
 
 describe('legacyCreateProxyMiddleware()', () => {
   const mockServer: Mockttp = getLocal();

test/types.spec.ts

@@ -1,8 +1,8 @@
 /* eslint-disable @typescript-eslint/no-unused-expressions */
-
 import * as express from 'express';
 import * as http from 'http';
-import { createProxyMiddleware as middleware, fixRequestBody, responseInterceptor } from '../src';
+
+import { fixRequestBody, createProxyMiddleware as middleware, responseInterceptor } from '../src';
 import type { Options, RequestHandler } from '../src/types';
 
 describe('http-proxy-middleware TypeScript Types', () => {

test/unit/fix-request-body.spec.ts

@@ -1,7 +1,8 @@
-import { Socket } from 'net';
 import { ClientRequest, IncomingMessage, ServerResponse } from 'http';
+import { Socket } from 'net';
 import * as querystring from 'querystring';
-import { fixRequestBody, BodyParserLikeRequest } from '../../src/handlers/fix-request-body';
+
+import { BodyParserLikeRequest, fixRequestBody } from '../../src/handlers/fix-request-body';
 
 const fakeProxyRequest = (): ClientRequest => {
   const proxyRequest = new ClientRequest('http://some-host');