Update linting rules (#90)

Author: timacdonald

.eslintrc.cjs

@@ -0,0 +1,49 @@
+import typescriptEslint from '@typescript-eslint/eslint-plugin'
+import stylistic from '@stylistic/eslint-plugin'
+import globals from 'globals'
+import tsParser from '@typescript-eslint/parser'
+import path from 'node:path'
+import { fileURLToPath } from 'node:url'
+import js from '@eslint/js'
+import { FlatCompat } from '@eslint/eslintrc'
+
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = path.dirname(__filename)
+const compat = new FlatCompat({
+    baseDirectory: __dirname,
+    recommendedConfig: js.configs.recommended,
+    allConfig: js.configs.all,
+})
+
+export default [
+    ...compat.extends('eslint:recommended', 'plugin:@typescript-eslint/recommended'),
+    {
+        plugins: {
+            '@typescript-eslint': typescriptEslint,
+            '@stylistic': stylistic,
+        },
+
+        languageOptions: {
+            globals: {
+                ...globals.browser,
+                ...globals.node,
+            },
+
+            parser: tsParser,
+        },
+
+        rules: {
+            quotes: ['error', 'single'],
+            'no-trailing-spaces': ['error'],
+            'object-curly-spacing': ['error', 'always'],
+            'comma-dangle': ['error', 'always-multiline'],
+            semi: ['error', 'never'],
+            '@typescript-eslint/no-non-null-assertion': ['off'],
+            '@typescript-eslint/ban-ts-comment': ['off'],
+            '@typescript-eslint/no-explicit-any': ['off'],
+            '@stylistic/no-extra-semi': ['error'],
+            '@stylistic/arrow-parens': ['error'],
+            '@stylistic/space-infix-ops': ['error'],
+        },
+    },
+]

eslint.config.mjs

@@ -18,8 +18,12 @@
         "test": "npm run test --workspaces --if-present"
     },
     "devDependencies": {
-        "@typescript-eslint/eslint-plugin": "^7.10.0",
-        "@typescript-eslint/parser": "^7.10.0",
-        "eslint": "^8.56.0"
+        "@eslint/eslintrc": "^3.1.0",
+        "@eslint/js": "^9.9.1",
+        "@stylistic/eslint-plugin": "^2.6.4",
+        "@typescript-eslint/eslint-plugin": "^8.3.0",
+        "@typescript-eslint/parser": "^8.3.0",
+        "eslint": "^9.9.1",
+        "globals": "^15.9.0"
     }
 }

package.json

@@ -6,7 +6,7 @@ import { Form } from './types.js'
 export { client }
 
 export default function (Alpine: TAlpine) {
-    Alpine.magic('form', (el) => <Data extends Record<string, unknown>>(method: RequestMethod|(() => RequestMethod), url: string|(() => string), inputs: Data, config: ValidationConfig = {}): Data&Form<Data> => {
+    Alpine.magic('form', (el) => <Data extends Record<string, unknown>>(method: RequestMethod | (() => RequestMethod), url: string | (() => string), inputs: Data, config: ValidationConfig = {}): Data & Form<Data> => {
         /**
          * The original data.
          */
@@ -31,7 +31,7 @@ export default function (Alpine: TAlpine) {
         /**
          * The validator instance.
          */
-        const validator = createValidator(client => client[resolveMethod(method)](resolveUrl(url), form.data(), config), originalData)
+        const validator = createValidator((client) => client[resolveMethod(method)](resolveUrl(url), form.data(), config), originalData)
             .on('validatingChanged', () => {
                 form.validating = validator.validating()
             })
@@ -77,7 +77,7 @@ export default function (Alpine: TAlpine) {
         /**
          * Create a new form instance.
          */
-        const createForm = (): Data&Form<Data> => ({
+        const createForm = (): Data & Form<Data> => ({
             ...cloneDeep(inputs),
             data() {
                 const newForm = cloneDeep(form)
@@ -135,9 +135,9 @@ export default function (Alpine: TAlpine) {
 
                 if (names.length === 0) {
                     // @ts-expect-error
-                    originalInputs.forEach(name => (form[name] = original[name]))
+                    originalInputs.forEach((name) => (form[name] = original[name]))
                 } else {
-                    names.forEach(name => set(form, name, get(original, name)))
+                    names.forEach((name) => set(form, name, get(original, name)))
                 }
 
                 validator.reset(...names)
@@ -163,7 +163,7 @@ export default function (Alpine: TAlpine) {
         /**
          * The form instance.
          */
-        const form = Alpine.reactive(createForm()) as Data&Form<Data>
+        const form = Alpine.reactive(createForm()) as Data & Form<Data>
 
         syncWithDom(el, resolveMethod(method), resolveUrl(url), form)
 

packages/alpine/src/index.ts

@@ -4,17 +4,17 @@ export interface Form<Data extends Record<string, unknown>> {
     processing: boolean,
     validating: boolean,
     touched(name: string): boolean,
-    touch(name: string|NamedInputEvent|Array<string>): Data&Form<Data>,
+    touch(name: string | NamedInputEvent | Array<string>): Data & Form<Data>,
     data(): Data,
     errors: Record<string, string>,
     hasErrors: boolean,
     valid(name: string): boolean,
     invalid(name: string): boolean,
-    validate(name?: string|NamedInputEvent|ValidationConfig, config?: ValidationConfig): Data&Form<Data>,
-    setErrors(errors: SimpleValidationErrors|ValidationErrors): Data&Form<Data>
-    forgetError(name: string|NamedInputEvent): Data&Form<Data>
-    setValidationTimeout(duration: number): Data&Form<Data>,
+    validate(name?: string | NamedInputEvent | ValidationConfig, config?: ValidationConfig): Data & Form<Data>,
+    setErrors(errors: SimpleValidationErrors | ValidationErrors): Data & Form<Data>
+    forgetError(name: string | NamedInputEvent): Data & Form<Data>
+    setValidationTimeout(duration: number): Data & Form<Data>,
     submit(config?: Config): Promise<unknown>,
-    reset(...keys: string[]): Data&Form<Data>,
-    validateFiles(): Data&Form<Data>,
+    reset(...keys: string[]): Data & Form<Data>,
+    validateFiles(): Data & Form<Data>,
 }

packages/alpine/src/types.ts

@@ -35,8 +35,8 @@
     },
     "devDependencies": {
         "@types/lodash-es": "^4.17.12",
-        "@types/node": "^20.1.0",
+        "@types/node": "^22.5.0",
         "typescript": "^5.0.0",
-        "vitest": "^1.6.0"
+        "vitest": "^2.0.5"
     }
 }

packages/core/package.json

@@ -83,7 +83,7 @@ const request = (userConfig: Config = {}): Promise<unknown> => {
 
     (config.onStart ?? (() => null))()
 
-    return axiosClient.request(config).then(async response => {
+    return axiosClient.request(config).then(async (response) => {
         if (config.precognitive) {
             validatePrecognitionResponse(response)
         }
@@ -104,7 +104,7 @@ const request = (userConfig: Config = {}): Promise<unknown> => {
             ?? ((response) => response)
 
         return statusHandler(payload) ?? payload
-    }, error => {
+    }, (error) => {
         if (isNotServerGeneratedError(error)) {
             return Promise.reject(error)
         }
@@ -202,7 +202,7 @@ const isNotServerGeneratedError = (error: unknown): boolean => {
 /**
  * Resolve the handler for the given HTTP response status.
  */
-const resolveStatusHandler = (config: Config, code: number): StatusHandler|undefined => ({
+const resolveStatusHandler = (config: Config, code: number): StatusHandler | undefined => ({
     401: config.onUnauthorized,
     403: config.onForbidden,
     404: config.onNotFound,
@@ -237,13 +237,13 @@ export const isFile = (value: unknown): boolean => (typeof File !== 'undefined'
 /**
  * Resolve the url from a potential callback.
  */
-export const resolveUrl = (url: string|(() => string)): string => typeof url === 'string'
+export const resolveUrl = (url: string | (() => string)): string => typeof url === 'string'
     ? url
     : url()
 
 /**
  * Resolve the method from a potential callback.
  */
-export const resolveMethod = (method: RequestMethod|(() => RequestMethod)): RequestMethod => typeof method === 'string'
+export const resolveMethod = (method: RequestMethod | (() => RequestMethod)): RequestMethod => typeof method === 'string'
     ? method.toLowerCase() as RequestMethod
     : method()

packages/core/src/client.ts

@@ -6,11 +6,11 @@ export type ValidationErrors = Record<string, Array<string>>
 
 export type SimpleValidationErrors = Record<string, string>
 
-export type Config = AxiosRequestConfig&{
+export type Config = AxiosRequestConfig & {
     precognitive?: boolean,
-    validate?: Iterable<string>|ArrayLike<string>,
-    fingerprint?: string|null,
-    onBefore?: () => boolean|undefined,
+    validate?: Iterable<string> | ArrayLike<string>,
+    fingerprint?: string | null,
+    onBefore?: () => boolean | undefined,
     onStart?: () => void,
     onSuccess?: (response: AxiosResponse) => unknown,
     onPrecognitionSuccess?: (response: AxiosResponse) => unknown,
@@ -24,15 +24,15 @@ export type Config = AxiosRequestConfig&{
 }
 
 interface RevalidatePayload {
-    data: Record<string, unknown>|null,
+    data: Record<string, unknown> | null,
     touched: Array<string>,
 }
 
-export type ValidationConfig = Config&{
-    onBeforeValidation?: (newRequest: RevalidatePayload, oldRequest: RevalidatePayload) => boolean|undefined,
+export type ValidationConfig = Config & {
+    onBeforeValidation?: (newRequest: RevalidatePayload, oldRequest: RevalidatePayload) => boolean | undefined,
 }
 
-export type RequestFingerprintResolver = (config: Config, axios: AxiosInstance) => string|null
+export type RequestFingerprintResolver = (config: Config, axios: AxiosInstance) => string | null
 
 export type SuccessResolver = (response: AxiosResponse) => boolean
 
@@ -43,21 +43,21 @@ export interface Client {
     put(url: string, data?: Record<string, unknown>, config?: Config): Promise<unknown>,
     delete(url: string, data?: Record<string, unknown>, config?: Config): Promise<unknown>,
     use(axios: AxiosInstance): Client,
-    fingerprintRequestsUsing(callback: RequestFingerprintResolver|null): Client,
+    fingerprintRequestsUsing(callback: RequestFingerprintResolver | null): Client,
     determineSuccessUsing(callback: SuccessResolver): Client,
     axios(): AxiosInstance,
 }
 
 export interface Validator {
     touched(): Array<string>,
-    validate(input?: string|NamedInputEvent|ValidationConfig, value?: unknown, config?: ValidationConfig): Validator,
-    touch(input: string|NamedInputEvent|Array<string>): Validator,
+    validate(input?: string | NamedInputEvent | ValidationConfig, value?: unknown, config?: ValidationConfig): Validator,
+    touch(input: string | NamedInputEvent | Array<string>): Validator,
     validating(): boolean,
     valid(): Array<string>,
     errors(): ValidationErrors,
-    setErrors(errors: ValidationErrors|SimpleValidationErrors): Validator,
+    setErrors(errors: ValidationErrors | SimpleValidationErrors): Validator,
     hasErrors(): boolean,
-    forgetError(error: string|NamedInputEvent): Validator,
+    forgetError(error: string | NamedInputEvent): Validator,
     reset(...names: string[]): Validator,
     setTimeout(duration: number): Validator,
     on(event: keyof ValidatorListeners, callback: () => void): Validator,
@@ -71,7 +71,7 @@ export interface ValidatorListeners {
     validatedChanged: Array<() => void>,
 }
 
-export type RequestMethod = 'get'|'post'|'patch'|'put'|'delete'
+export type RequestMethod = 'get' | 'post' | 'patch' | 'put' | 'delete'
 
 export type ValidationCallback = (client: {
     get(url: string, data?: Record<string, unknown>, config?: ValidationConfig): Promise<unknown>,