Migrate to biome for formatting/linting (#232)

* Switch from prettier to biome

* Update to biome 2.0.4

* Write files, tweak config

* Bump typescript from 5.2.2 to 5.8.3

* Separate tsc/biome ci checks

* Revert "Bump typescript from 5.2.2 to 5.8.3"

This reverts commit 4055543.

Author: af

.github/workflows/ci.yml

@@ -26,7 +26,10 @@ jobs:
       - name: Install dependencies
         run: yarn --frozen-lockfile
 
-      - name: ESLint
+      - name: Typescript check
+        run: yarn tsc
+
+      - name: Biome lint check
         run: yarn lint
 
       - name: Unit tests

biome.json

@@ -0,0 +1,48 @@
+{
+  "$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
+  "files": {
+    "includes": [
+      "src/**/*.ts"
+    ]
+  },
+  "formatter": {
+    "enabled": true,
+    "formatWithErrors": false,
+    "indentStyle": "space",
+    "indentWidth": 2,
+    "lineEnding": "lf",
+    "lineWidth": 100,
+    "attributePosition": "auto"
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "recommended": true,
+      "complexity": {
+        "noForEach": "off",
+        "noUselessSwitchCase": "off"
+      },
+      "a11y": {
+        "noSvgWithoutTitle": "off"
+      },
+      "suspicious": {
+        "noArrayIndexKey": "warn",
+        "noDoubleEquals": "off"
+      },
+      "style": {
+        "useImportType": "warn"
+      }
+    }
+  },
+  "javascript": {
+    "formatter": {
+      "quoteProperties": "asNeeded",
+      "semicolons": "asNeeded",
+      "arrowParentheses": "always",
+      "bracketSpacing": true,
+      "bracketSameLine": false,
+      "quoteStyle": "single",
+      "attributePosition": "auto"
+    }
+  }
+}

package.json

@@ -18,7 +18,8 @@
     "start": "tsc --watch",
     "prepare": "tsc",
     "coverage": "jest --coverage",
-    "lint": "tsc && prettier --list-different --write src tests",
+    "tsc": "tsc --noEmit",
+    "lint": "biome lint --diagnostic-level=error src",
     "test": "jest"
   },
   "repository": {
@@ -39,26 +40,20 @@
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "0.15.4",
+    "@biomejs/biome": "2.0.4",
     "@types/jest": "29.5.12",
     "@types/node": "20.12.5",
     "expect-type": "^0.19.0",
     "husky": "9.0.11",
     "jest": "29.7.0",
-    "prettier": "3.2.5",
     "ts-jest": "29.1.2",
     "typescript": "5.2.2"
   },
   "author": "Aaron Franks",
   "license": "MIT",
-  "prettier": {
-    "printWidth": 100,
-    "semi": false,
-    "singleQuote": true,
-    "trailingComma": "all"
-  },
   "husky": {
     "hooks": {
-      "pre-commit": "yarn lint",
+      "pre-commit": "yarn lint && yarn tsc",
       "pre-push": "yarn test"
     }
   }

src/core.ts

@@ -1,5 +1,5 @@
 import { EnvError, EnvMissingError } from './errors'
-import { CleanOptions, SpecsOutput, Spec, ValidatorSpec } from './types'
+import type { CleanOptions, SpecsOutput, Spec, ValidatorSpec } from './types'
 import { defaultReporter } from './reporter'
 
 export const testOnlySymbol = Symbol('envalid - test only')
@@ -56,7 +56,7 @@ export function getSanitizedEnv<S>(
   specs: S,
   options: CleanOptions<SpecsOutput<S>> = {},
 ): SpecsOutput<S> {
-  let cleanedEnv = {} as SpecsOutput<S>
+  const cleanedEnv = {} as SpecsOutput<S>
   const castedSpecs = specs as unknown as Record<keyof S, ValidatorSpec<unknown>>
   const errors = {} as Record<keyof S, Error>
   const varKeys = Object.keys(castedSpecs) as Array<keyof S>
@@ -72,7 +72,7 @@ export function getSanitizedEnv<S>(
       if (rawValue === undefined) {
         // Use devDefault values only if NODE_ENV was explicitly set, and isn't 'production'
         const usingDevDefault =
-          rawNodeEnv && rawNodeEnv !== 'production' && spec.hasOwnProperty('devDefault')
+          rawNodeEnv && rawNodeEnv !== 'production' && Object.hasOwn(spec, 'devDefault')
 
         if (usingDevDefault) {
           cleanedEnv[k] = spec.devDefault

src/envalid.ts

@@ -1,4 +1,4 @@
-import { CleanedEnv, CleanOptions } from './types'
+import type { CleanedEnv, CleanOptions } from './types'
 import { getSanitizedEnv, testOnlySymbol } from './core'
 import { applyDefaultMiddleware } from './middleware'
 

src/makers.ts

@@ -1,4 +1,4 @@
-import { Spec, BaseValidator, StructuredValidator, ExactValidator } from './types'
+import type { Spec, BaseValidator, StructuredValidator, ExactValidator } from './types'
 
 const internalMakeValidator = <T>(parseFn: (input: string) => T) => {
   return (spec?: Spec<unknown>) => ({ ...spec, _parse: parseFn })

src/middleware.ts

@@ -1,4 +1,4 @@
-import { CleanedEnvAccessors, StrictProxyMiddlewareOptions } from './types'
+import type { CleanedEnvAccessors, StrictProxyMiddlewareOptions } from './types'
 
 export const strictProxyMiddleware = <T extends object>(
   envObj: T,
@@ -43,7 +43,7 @@ export const strictProxyMiddleware = <T extends object>(
         return target[name]
       }
 
-      const varExists = target.hasOwnProperty(name)
+      const varExists = Object.hasOwn(target, name)
       if (!varExists) {
         if (typeof rawEnv === 'object' && rawEnv?.hasOwnProperty?.(name)) {
           throw new ReferenceError(

src/reporter.ts

@@ -1,6 +1,5 @@
-/* eslint-disable no-console */
 import { EnvMissingError } from './errors'
-import { ReporterOptions } from './types'
+import type { ReporterOptions } from './types'
 
 type Errors<T> = Partial<Record<keyof T, Error>>
 type Logger = (data: any, ...args: any[]) => void

src/validators.ts

@@ -5,7 +5,7 @@ import { makeExactValidator, makeStructuredValidator, makeValidator } from './ma
 const isFQDN = (input: string) => {
   if (!input.length) return false
   const parts = input.split('.')
-  for (let part, i = 0; i < parts.length; i++) {
+  for (let part: string, i = 0; i < parts.length; i++) {
     part = parts[i]
     if (!/^[a-z\u00a1-\uffff0-9-]+$/i.test(part)) return false
     if (/[\uff01-\uff5e]/.test(part)) return false // disallow full-width chars

tests/basics.test.ts

@@ -1,4 +1,4 @@
-import { cleanEnv, str, num, testOnly, ReporterOptions } from '../src'
+import { cleanEnv, str, num, testOnly, type ReporterOptions } from '../src'
 import { assertPassthrough } from './utils'
 import { expectTypeOf } from 'expect-type'