Run format check in CI (#355)

lukekarrys · web-flow · commit 5fd25462f4f6 · 2024-12-06T15:14:13.000-07:00
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -71,6 +71,29 @@ jobs:
 
       - name: Run Lint
         run: pnpm lint
+        id: lint
+        continue-on-error: true
+
+      - name: Run Format
+        run: pnpm format:check
+        id: format
+        continue-on-error: true
+
+      - name: Check Results
+        run: |
+          declare -A OUTCOMES=(
+            [lint]="${{ steps.lint.outcome }}"
+            [format]="${{ steps.format.outcome }}"
+          )
+          STATUS=0
+          for STEP in "${!OUTCOMES[@]}"; do
+            OUTCOME="${OUTCOMES[$STEP]}"
+            echo "$STEP: $OUTCOME"
+            if [ "$OUTCOME" != "success" ]; then
+              STATUS=1
+            fi
+          done
+          exit $STATUS
 
   e2e:
     name: E2E
diff --git a/.prettierignore b/.prettierignore
@@ -1,2 +1,5 @@
 packages/*/dist
 packages/degenerator/test/*.js
+*.md
+*.pac
+pnpm-lock.yaml
diff --git a/.prettierrc b/.prettierrc
@@ -1,3 +1,3 @@
 {
-    "singleQuote": true
+	"singleQuote": true
 }
diff --git a/package.json b/package.json
@@ -7,7 +7,8 @@
     "lint": "turbo run lint",
     "test": "turbo run test",
     "test-e2e": "turbo run test-e2e",
-    "format": "prettier --write \"**/*.{ts,js,mjs}\"",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
     "ci:version": "changeset version && pnpm install --no-frozen-lockfile",
     "ci:publish": "pnpm publish -r && changeset tag"
   },
diff --git a/packages/agent-base/tsconfig.json b/packages/agent-base/tsconfig.json
@@ -1,7 +1,7 @@
 {
   "extends": "tsconfig/base.json",
   "compilerOptions": {
-    "outDir": "dist",
+    "outDir": "dist"
   },
   "include": ["src"],
   "exclude": ["node_modules"]
diff --git a/packages/data-uri-to-buffer/src/common.ts b/packages/data-uri-to-buffer/src/common.ts
@@ -15,55 +15,59 @@ export interface IBufferConversions {
  *
  * @param {String} uri Data URI to turn into a Buffer instance
  */
-export const makeDataUriToBuffer = (convert: IBufferConversions) => (uri: string | URL): ParsedDataURI => {
-	uri = String(uri);
+export const makeDataUriToBuffer =
+	(convert: IBufferConversions) =>
+	(uri: string | URL): ParsedDataURI => {
+		uri = String(uri);
 
-	if (!/^data:/i.test(uri)) {
-		throw new TypeError(
-			'`uri` does not appear to be a Data URI (must begin with "data:")'
-		);
-	}
+		if (!/^data:/i.test(uri)) {
+			throw new TypeError(
+				'`uri` does not appear to be a Data URI (must begin with "data:")'
+			);
+		}
 
-	// strip newlines
-	uri = uri.replace(/\r?\n/g, '');
+		// strip newlines
+		uri = uri.replace(/\r?\n/g, '');
 
-	// split the URI up into the "metadata" and the "data" portions
-	const firstComma = uri.indexOf(',');
-	if (firstComma === -1 || firstComma <= 4) {
-		throw new TypeError('malformed data: URI');
-	}
+		// split the URI up into the "metadata" and the "data" portions
+		const firstComma = uri.indexOf(',');
+		if (firstComma === -1 || firstComma <= 4) {
+			throw new TypeError('malformed data: URI');
+		}
 
-	// remove the "data:" scheme and parse the metadata
-	const meta = uri.substring(5, firstComma).split(';');
+		// remove the "data:" scheme and parse the metadata
+		const meta = uri.substring(5, firstComma).split(';');
 
-	let charset = '';
-	let base64 = false;
-	const type = meta[0] || 'text/plain';
-	let typeFull = type;
-	for (let i = 1; i < meta.length; i++) {
-		if (meta[i] === 'base64') {
-			base64 = true;
-		} else if (meta[i]) {
-			typeFull += `;${meta[i]}`;
-			if (meta[i].indexOf('charset=') === 0) {
-				charset = meta[i].substring(8);
+		let charset = '';
+		let base64 = false;
+		const type = meta[0] || 'text/plain';
+		let typeFull = type;
+		for (let i = 1; i < meta.length; i++) {
+			if (meta[i] === 'base64') {
+				base64 = true;
+			} else if (meta[i]) {
+				typeFull += `;${meta[i]}`;
+				if (meta[i].indexOf('charset=') === 0) {
+					charset = meta[i].substring(8);
+				}
 			}
 		}
-	}
-	// defaults to US-ASCII only if type is not provided
-	if (!meta[0] && !charset.length) {
-		typeFull += ';charset=US-ASCII';
-		charset = 'US-ASCII';
-	}
+		// defaults to US-ASCII only if type is not provided
+		if (!meta[0] && !charset.length) {
+			typeFull += ';charset=US-ASCII';
+			charset = 'US-ASCII';
+		}
 
-	// get the encoded data portion and decode URI-encoded chars
-	const data = unescape(uri.substring(firstComma + 1));
-	const buffer = base64 ? convert.base64ToArrayBuffer(data) : convert.stringToBuffer(data);
+		// get the encoded data portion and decode URI-encoded chars
+		const data = unescape(uri.substring(firstComma + 1));
+		const buffer = base64
+			? convert.base64ToArrayBuffer(data)
+			: convert.stringToBuffer(data);
 
-	return {
-		type,
-		typeFull,
-		charset,
-		buffer,
+		return {
+			type,
+			typeFull,
+			charset,
+			buffer,
+		};
 	};
-}
diff --git a/packages/data-uri-to-buffer/src/index.ts b/packages/data-uri-to-buffer/src/index.ts
@@ -1,6 +1,6 @@
 import { makeDataUriToBuffer } from './common';
 
-export type { ParsedDataURI } from  './common';
+export type { ParsedDataURI } from './common';
 
 function base64ToArrayBuffer(base64: string) {
 	const chars =
@@ -55,4 +55,7 @@ function stringToBuffer(str: string): ArrayBuffer {
  *
  * @param {String} uri Data URI to turn into a Buffer instance
  */
-export const dataUriToBuffer = makeDataUriToBuffer({ stringToBuffer, base64ToArrayBuffer });
+export const dataUriToBuffer = makeDataUriToBuffer({
+	stringToBuffer,
+	base64ToArrayBuffer,
+});
diff --git a/packages/data-uri-to-buffer/src/node.ts b/packages/data-uri-to-buffer/src/node.ts
@@ -1,6 +1,6 @@
 import { makeDataUriToBuffer } from './common';
 
-export type { ParsedDataURI } from  './common';
+export type { ParsedDataURI } from './common';
 
 function nodeBuffertoArrayBuffer(nodeBuf: Buffer) {
 	if (nodeBuf.byteLength === nodeBuf.buffer.byteLength) {
@@ -25,4 +25,7 @@ function stringToBuffer(str: string): ArrayBuffer {
  *
  * @param {String} uri Data URI to turn into a Buffer instance
  */
-export const dataUriToBuffer = makeDataUriToBuffer({ stringToBuffer, base64ToArrayBuffer });
+export const dataUriToBuffer = makeDataUriToBuffer({
+	stringToBuffer,
+	base64ToArrayBuffer,
+});
diff --git a/packages/degenerator/tsconfig.json b/packages/degenerator/tsconfig.json
@@ -1,7 +1,7 @@
 {
   "extends": "tsconfig/base.json",
   "compilerOptions": {
-    "outDir": "dist",
+    "outDir": "dist"
   },
   "include": ["src"],
   "exclude": ["node_modules"]
diff --git a/packages/get-uri/tsconfig.json b/packages/get-uri/tsconfig.json
@@ -8,10 +8,7 @@
     "outDir": "dist",
     "sourceMap": true,
     "declaration": true,
-    "typeRoots": [
-      "./@types",
-      "./node_modules/@types"
-    ]
+    "typeRoots": ["./@types", "./node_modules/@types"]
   },
   "include": ["src/**/*"],
   "exclude": ["node_modules"]
diff --git a/packages/http-proxy-agent/tsconfig.json b/packages/http-proxy-agent/tsconfig.json
@@ -1,7 +1,7 @@
 {
   "extends": "tsconfig/base.json",
   "compilerOptions": {
-    "outDir": "dist",
+    "outDir": "dist"
   },
   "include": ["src"],
   "exclude": ["node_modules"]
diff --git a/packages/https-proxy-agent/test/e2e.test.ts b/packages/https-proxy-agent/test/e2e.test.ts
@@ -9,8 +9,7 @@ interface NordVPNServer {
 	locations: {
 		country: {
 			code: string;
-		}
-
+		};
 	}[];
 	technologies: {
 		identifier: string;
diff --git a/packages/https-proxy-agent/tsconfig.json b/packages/https-proxy-agent/tsconfig.json
@@ -1,7 +1,7 @@
 {
   "extends": "tsconfig/base.json",
   "compilerOptions": {
-    "outDir": "dist",
+    "outDir": "dist"
   },
   "include": ["src"],
   "exclude": ["node_modules"]
diff --git a/packages/pac-proxy-agent/test/test.ts b/packages/pac-proxy-agent/test/test.ts
@@ -188,7 +188,10 @@ describe('PacProxyAgent', () => {
 			)}`;
 			const agent = new PacProxyAgent(uri);
 
-			const res = await req(new URL('/test', httpServerUrl), { agent, headers: { upgrade: 'websocket' } });
+			const res = await req(new URL('/test', httpServerUrl), {
+				agent,
+				headers: { upgrade: 'websocket' },
+			});
 			const data = await json(res);
 			assert.equal(httpServerUrl.host, data.host);
 			assert(!('via' in data)); // Used CONNECT rather than plain HTTP proxy
diff --git a/packages/pac-proxy-agent/tsconfig.json b/packages/pac-proxy-agent/tsconfig.json
@@ -1,7 +1,7 @@
 {
   "extends": "tsconfig/base.json",
   "compilerOptions": {
-    "outDir": "dist",
+    "outDir": "dist"
   },
   "include": ["src"],
   "exclude": ["node_modules"]
diff --git a/packages/pac-resolver/src/ip.ts b/packages/pac-resolver/src/ip.ts
@@ -7,28 +7,35 @@ export const ip = {
 		// Default to `ipv4`
 		const family = normalizeFamily();
 
-		const all = Object.values(interfaces).map((addrs = []) => {
-			const addresses = addrs.filter((details) => {
-				const detailsFamily = normalizeFamily(details.family);
-				if (detailsFamily !== family || ip.isLoopback(details.address)) {
-					return false;
-				}
-				return true;
-
-			});
-
-			return addresses.length ? addresses[0].address : undefined;
-		}).filter(Boolean);
-
-		return !all.length ? ip.loopback(family) : all[0] as string;
+		const all = Object.values(interfaces)
+			.map((addrs = []) => {
+				const addresses = addrs.filter((details) => {
+					const detailsFamily = normalizeFamily(details.family);
+					if (
+						detailsFamily !== family ||
+						ip.isLoopback(details.address)
+					) {
+						return false;
+					}
+					return true;
+				});
+
+				return addresses.length ? addresses[0].address : undefined;
+			})
+			.filter(Boolean);
+
+		return !all.length ? ip.loopback(family) : (all[0] as string);
 	},
 
 	isLoopback(addr: string): boolean {
-		return /^(::f{4}:)?127\.([0-9]{1,3})\.([0-9]{1,3})\.([0-9]{1,3})/
-			.test(addr)
-			|| /^fe80::1$/.test(addr)
-			|| /^::1$/.test(addr)
-			|| /^::$/.test(addr);
+		return (
+			/^(::f{4}:)?127\.([0-9]{1,3})\.([0-9]{1,3})\.([0-9]{1,3})/.test(
+				addr
+			) ||
+			/^fe80::1$/.test(addr) ||
+			/^::1$/.test(addr) ||
+			/^::$/.test(addr)
+		);
 	},
 
 	loopback(family: IpFamily): string {
@@ -40,8 +47,7 @@ export const ip = {
 		}
 
 		return family === 'ipv4' ? '127.0.0.1' : 'fe80::1';
-	}
-
+	},
 };
 
 function normalizeFamily(family?: unknown): IpFamily {
@@ -51,7 +57,7 @@ function normalizeFamily(family?: unknown): IpFamily {
 	if (family === 6) {
 		return 'ipv6';
 	}
-	return family ? (family as string).toLowerCase() as IpFamily : 'ipv4';
+	return family ? ((family as string).toLowerCase() as IpFamily) : 'ipv4';
 }
 
-type IpFamily = 'ipv4' | 'ipv6'
+type IpFamily = 'ipv4' | 'ipv6';
diff --git a/packages/pac-resolver/tsconfig.json b/packages/pac-resolver/tsconfig.json
@@ -1,7 +1,7 @@
 {
   "extends": "tsconfig/base.json",
   "compilerOptions": {
-    "outDir": "dist",
+    "outDir": "dist"
   },
   "include": ["src"],
   "exclude": ["node_modules"]
diff --git a/packages/proxy-agent/src/index.ts b/packages/proxy-agent/src/index.ts
diff --git a/packages/proxy-agent/tsconfig.json b/packages/proxy-agent/tsconfig.json
diff --git a/packages/proxy/tsconfig.json b/packages/proxy/tsconfig.json
diff --git a/packages/socks-proxy-agent/test/test.ts b/packages/socks-proxy-agent/test/test.ts
diff --git a/packages/socks-proxy-agent/tsconfig.json b/packages/socks-proxy-agent/tsconfig.json
diff --git a/packages/tsconfig/base.json b/packages/tsconfig/base.json
diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`{`
`2`		`- "singleQuote": true`
	`2`	`+ "singleQuote": true`
`3`	`3`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"extends": "tsconfig/base.json",`
`3`	`3`	`"compilerOptions": {`
`4`		`- "outDir": "dist",`
	`4`	`+ "outDir": "dist"`
`5`	`5`	`},`
`6`	`6`	`"include": ["src"],`
`7`	`7`	`"exclude": ["node_modules"]`