chore: Enable eslint rules from query repo (#595)

lachlancollins · web-flow · commit eb4801c5202c · 2024-02-04T09:12:08.000+11:00
* chore: Enable eslint rules from query

* Enable sort-imports

* More import options

* Fix prettier
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
@@ -41,7 +41,10 @@ const config = {
     '@typescript-eslint/ban-types': 'off',
     '@typescript-eslint/ban-ts-comment': 'off',
     '@typescript-eslint/consistent-type-definitions': 'off',
-    '@typescript-eslint/consistent-type-imports': 'error',
+    '@typescript-eslint/consistent-type-imports': [
+      'error',
+      { prefer: 'type-imports' },
+    ],
     '@typescript-eslint/explicit-module-boundary-types': 'off',
     '@typescript-eslint/no-empty-interface': 'off',
     '@typescript-eslint/no-explicit-any': 'off',
@@ -50,18 +53,38 @@ const config = {
     '@typescript-eslint/no-unused-vars': 'off',
     '@typescript-eslint/no-inferrable-types': [
       'error',
-      {
-        ignoreParameters: true,
-      },
+      { ignoreParameters: true },
     ],
-    'no-shadow': 'error',
+    'import/default': 'off',
+    'import/export': 'off',
+    'import/namespace': 'off',
+    'import/newline-after-import': 'error',
     'import/no-cycle': 'error',
+    'import/no-duplicates': 'off',
+    'import/no-named-as-default-member': 'off',
     'import/no-unresolved': ['error', { ignore: ['^@tanstack/'] }],
     'import/no-unused-modules': ['off', { unusedExports: true }],
+    'import/order': [
+      'error',
+      {
+        groups: [
+          'builtin',
+          'external',
+          'internal',
+          'parent',
+          'sibling',
+          'index',
+          'object',
+          'type',
+        ],
+      },
+    ],
     'no-async-promise-executor': 'off',
     'no-empty': 'off',
     'no-redeclare': 'off',
+    'no-shadow': 'error',
     'no-undef': 'off',
+    'sort-imports': ['error', { ignoreDeclarationSort: true }],
   },
   overrides: [
     {
diff --git a/examples/react/next-server-actions/src/app/client-component.tsx b/examples/react/next-server-actions/src/app/client-component.tsx
@@ -2,9 +2,10 @@
 'use client'
 
 import { useFormState } from 'react-dom'
+import { mergeForm, useTransform } from '@tanstack/react-form'
 import someAction from './action'
 import { formFactory } from './shared-code'
-import { useTransform, mergeForm, type FormApi } from '@tanstack/react-form'
+import type { FormApi } from '@tanstack/react-form'
 
 export const ClientComp = () => {
   const [state, action] = useFormState(someAction, formFactory.initialFormState)
diff --git a/examples/solid/simple/src/index.tsx b/examples/solid/simple/src/index.tsx
@@ -1,7 +1,8 @@
 /* @refresh reload */
 import { render } from 'solid-js/web'
 
-import { createForm, type FieldApi } from '@tanstack/solid-form'
+import { createForm } from '@tanstack/solid-form'
+import type { FieldApi } from '@tanstack/solid-form'
 
 interface FieldInfoProps {
   field: FieldApi<any, any, any, any>
diff --git a/examples/solid/valibot/src/index.tsx b/examples/solid/valibot/src/index.tsx
@@ -1,9 +1,10 @@
 /* @refresh reload */
 import { render } from 'solid-js/web'
 
-import { createForm, type FieldApi } from '@tanstack/solid-form'
+import { createForm } from '@tanstack/solid-form'
 import { valibotValidator } from '@tanstack/valibot-form-adapter'
 import { customAsync, minLength, string, stringAsync } from 'valibot'
+import type { FieldApi } from '@tanstack/solid-form'
 
 interface FieldInfoProps {
   field: FieldApi<any, any, any, any>
diff --git a/examples/solid/yup/src/index.tsx b/examples/solid/yup/src/index.tsx
@@ -1,9 +1,10 @@
 /* @refresh reload */
 import { render } from 'solid-js/web'
 
-import { createForm, type FieldApi } from '@tanstack/solid-form'
+import { createForm } from '@tanstack/solid-form'
 import { yupValidator } from '@tanstack/yup-form-adapter'
 import * as yup from 'yup'
+import type { FieldApi } from '@tanstack/solid-form'
 
 interface FieldInfoProps {
   field: FieldApi<any, any, any, any>
diff --git a/examples/solid/zod/src/index.tsx b/examples/solid/zod/src/index.tsx
@@ -1,9 +1,10 @@
 /* @refresh reload */
 import { render } from 'solid-js/web'
 
-import { createForm, type FieldApi } from '@tanstack/solid-form'
+import { createForm } from '@tanstack/solid-form'
 import { zodValidator } from '@tanstack/zod-form-adapter'
 import { z } from 'zod'
+import type { FieldApi } from '@tanstack/solid-form'
 
 interface FieldInfoProps {
   field: FieldApi<any, any, any, any>
diff --git a/packages/form-core/src/FieldApi.ts b/packages/form-core/src/FieldApi.ts
@@ -1,4 +1,5 @@
 import { Store } from '@tanstack/store'
+import { getAsyncValidatorArray, getSyncValidatorArray } from './utils'
 import type { FormApi } from './FormApi'
 import type {
   ValidationCause,
@@ -7,7 +8,6 @@ import type {
   Validator,
 } from './types'
 import type { DeepKeys, DeepValue, Updater } from './utils'
-import { getAsyncValidatorArray, getSyncValidatorArray } from './utils'
 
 export type FieldValidateFn<
   TParentData,
diff --git a/packages/form-core/src/FormApi.ts b/packages/form-core/src/FormApi.ts
@@ -1,21 +1,21 @@
 import { Store } from '@tanstack/store'
-import type { DeepKeys, DeepValue, Updater } from './utils'
 import {
-  getAsyncValidatorArray,
-  getSyncValidatorArray,
   deleteBy,
   functionalUpdate,
+  getAsyncValidatorArray,
   getBy,
+  getSyncValidatorArray,
   isNonEmptyArray,
   setBy,
 } from './utils'
+import type { DeepKeys, DeepValue, Updater } from './utils'
 import type { FieldApi, FieldMeta } from './FieldApi'
 import type {
+  ValidationCause,
   ValidationError,
   ValidationErrorMap,
-  Validator,
-  ValidationCause,
   ValidationErrorMapKeys,
+  Validator,
 } from './types'
 
 export type FormValidateFn<
diff --git a/packages/react-form/src/createFormFactory.ts b/packages/react-form/src/createFormFactory.ts
@@ -1,8 +1,9 @@
-import type { FormApi, FormOptions, Validator } from '@tanstack/form-core'
-
-import { type UseField, type FieldComponent, Field, useField } from './useField'
+import { Field, useField } from './useField'
 import { useForm } from './useForm'
-import { type ValidateFormData, getValidateFormData } from './validateFormData'
+import { getValidateFormData } from './validateFormData'
+import type { ValidateFormData } from './validateFormData'
+import type { FieldComponent, UseField } from './useField'
+import type { FormApi, FormOptions, Validator } from '@tanstack/form-core'
 
 export type FormFactory<
   TFormData,
diff --git a/packages/react-form/src/formContext.ts b/packages/react-form/src/formContext.ts
@@ -1,5 +1,5 @@
-import type { FormApi, Validator } from '@tanstack/form-core'
 import { createContext, useContext } from 'rehackt'
+import type { FormApi, Validator } from '@tanstack/form-core'
 
 export const formContext = createContext<{
   formApi: FormApi<any, Validator<any, unknown> | undefined>
diff --git a/packages/react-form/src/tests/useField.test.tsx b/packages/react-form/src/tests/useField.test.tsx
@@ -3,8 +3,9 @@ import * as React from 'react'
 import { render, waitFor } from '@testing-library/react'
 import userEvent from '@testing-library/user-event'
 import '@testing-library/jest-dom'
-import { type FormApi, createFormFactory } from '..'
+import { createFormFactory } from '..'
 import { sleep } from './utils'
+import type { FormApi } from '..'
 
 const user = userEvent.setup()
 
diff --git a/packages/react-form/src/types.ts b/packages/react-form/src/types.ts
@@ -1,7 +1,7 @@
 import type {
-  FieldOptions,
   DeepKeys,
   DeepValue,
+  FieldOptions,
   Validator,
 } from '@tanstack/form-core'
 
diff --git a/packages/react-form/src/useField.tsx b/packages/react-form/src/useField.tsx
@@ -1,16 +1,16 @@
 import React, { useRef, useState } from 'rehackt'
 import { useStore } from '@tanstack/react-store'
+import { FieldApi, functionalUpdate } from '@tanstack/form-core'
+import { formContext, useFormContext } from './formContext'
+import { useIsomorphicLayoutEffect } from './useIsomorphicLayoutEffect'
+import { useIsomorphicEffectOnce } from './useIsomorphicEffectOnce'
+import type { UseFieldOptions } from './types'
 import type {
   DeepKeys,
   DeepValue,
   Narrow,
   Validator,
 } from '@tanstack/form-core'
-import { FieldApi, functionalUpdate } from '@tanstack/form-core'
-import { useFormContext, formContext } from './formContext'
-import type { UseFieldOptions } from './types'
-import { useIsomorphicLayoutEffect } from './useIsomorphicLayoutEffect'
-import { useIsomorphicEffectOnce } from './useIsomorphicEffectOnce'
 
 declare module '@tanstack/form-core' {
   // eslint-disable-next-line no-shadow
diff --git a/packages/react-form/src/useForm.tsx b/packages/react-form/src/useForm.tsx
@@ -1,15 +1,16 @@
-import type { FormState, FormOptions, Validator } from '@tanstack/form-core'
 import { FormApi, functionalUpdate } from '@tanstack/form-core'
-import type { NoInfer } from '@tanstack/react-store'
 import { useStore } from '@tanstack/react-store'
 import React, {
   type PropsWithChildren,
   type ReactNode,
   useState,
 } from 'rehackt'
-import { type UseField, type FieldComponent, Field, useField } from './useField'
+import { Field, useField } from './useField'
 import { formContext } from './formContext'
 import { useIsomorphicLayoutEffect } from './useIsomorphicLayoutEffect'
+import type { NoInfer } from '@tanstack/react-store'
+import type { FormOptions, FormState, Validator } from '@tanstack/form-core'
+import type { FieldComponent, UseField } from './useField'
 
 declare module '@tanstack/form-core' {
   // eslint-disable-next-line no-shadow
diff --git a/packages/react-form/src/useIsomorphicEffectOnce.ts b/packages/react-form/src/useIsomorphicEffectOnce.ts
@@ -1,5 +1,6 @@
-import { useRef, useState, type EffectCallback } from 'rehackt'
+import { useRef, useState } from 'rehackt'
 import { useIsomorphicLayoutEffect } from './useIsomorphicLayoutEffect'
+import type { EffectCallback } from 'rehackt'
 
 /**
  * This hook handles StrictMode and prod mode
diff --git a/packages/solid-form/src/createForm.tsx b/packages/solid-form/src/createForm.tsx
@@ -1,14 +1,15 @@
-import type { FormOptions, FormState, Validator } from '@tanstack/form-core'
 import { FormApi, functionalUpdate } from '@tanstack/form-core'
-import { createComputed, onMount, type JSXElement } from 'solid-js'
+import { createComputed, onMount } from 'solid-js'
 import { useStore } from '@tanstack/solid-store'
 import {
-  Field,
-  createField,
   type CreateField,
+  Field,
   type FieldComponent,
+  createField,
 } from './createField'
 import { formContext } from './formContext'
+import type { JSXElement } from 'solid-js'
+import type { FormOptions, FormState, Validator } from '@tanstack/form-core'
 
 type NoInfer<T> = [T][T extends any ? 0 : never]
 
diff --git a/packages/solid-form/src/createFormFactory.ts b/packages/solid-form/src/createFormFactory.ts
@@ -1,13 +1,12 @@
-import type { FormApi, FormOptions, Validator } from '@tanstack/form-core'
-
+import { mergeProps } from 'solid-js'
 import {
   type CreateField,
-  type FieldComponent,
   Field,
+  type FieldComponent,
   createField,
 } from './createField'
 import { createForm } from './createForm'
-import { mergeProps } from 'solid-js'
+import type { FormApi, FormOptions, Validator } from '@tanstack/form-core'
 
 export type FormFactory<
   TFormData,
diff --git a/packages/solid-form/src/types.ts b/packages/solid-form/src/types.ts
@@ -1,7 +1,7 @@
 import type {
-  FieldOptions,
   DeepKeys,
   DeepValue,
+  FieldOptions,
   Validator,
 } from '@tanstack/form-core'
 
diff --git a/packages/valibot-form-adapter/src/tests/FieldApi.spec.ts b/packages/valibot-form-adapter/src/tests/FieldApi.spec.ts
@@ -1,8 +1,8 @@
 import { expect } from 'vitest'
 
-import { FormApi, FieldApi } from '@tanstack/form-core'
-import { valibotValidator } from '../validator'
+import { FieldApi, FormApi } from '@tanstack/form-core'
 import { customAsync, minLength, string, stringAsync } from 'valibot'
+import { valibotValidator } from '../validator'
 import { sleep } from './utils'
 
 describe('valibot field api', () => {
diff --git a/packages/valibot-form-adapter/src/tests/FieldApi.test-d.ts b/packages/valibot-form-adapter/src/tests/FieldApi.test-d.ts
@@ -1,7 +1,7 @@
-import { valibotValidator } from '../validator'
-import { string, object } from 'valibot'
+import { object, string } from 'valibot'
 import { FieldApi, FormApi } from '@tanstack/form-core'
 import { assertType } from 'vitest'
+import { valibotValidator } from '../validator'
 
 it('should allow a Valibot validator to be passed in', () => {
   const form = new FormApi({
diff --git a/packages/valibot-form-adapter/src/tests/FormApi.test-d.ts b/packages/valibot-form-adapter/src/tests/FormApi.test-d.ts
@@ -1,7 +1,7 @@
-import { string, object } from 'valibot'
-import { valibotValidator } from '../validator'
+import { object, string } from 'valibot'
 import { FieldApi, FormApi } from '@tanstack/form-core'
 import { assertType } from 'vitest'
+import { valibotValidator } from '../validator'
 
 it('should allow a Valibot validator to be passed in', () => {
   const form = new FormApi({
diff --git a/packages/vue-form/src/createFormFactory.ts b/packages/vue-form/src/createFormFactory.ts
@@ -1,7 +1,7 @@
-import type { FormApi, FormOptions, Validator } from '@tanstack/form-core'
-
-import { type UseField, type FieldComponent, Field, useField } from './useField'
+import { Field, useField } from './useField'
 import { useForm } from './useForm'
+import type { FormApi, FormOptions, Validator } from '@tanstack/form-core'
+import type { FieldComponent, UseField } from './useField'
 
 export type FormFactory<
   TFormData,
diff --git a/packages/vue-form/src/formContext.ts b/packages/vue-form/src/formContext.ts
@@ -1,5 +1,5 @@
-import type { FormApi, Validator } from '@tanstack/form-core'
 import { inject, provide } from 'vue'
+import type { FormApi, Validator } from '@tanstack/form-core'
 
 export type FormContext<
   TFormData = any,
diff --git a/packages/vue-form/src/tests/useField.test.tsx b/packages/vue-form/src/tests/useField.test.tsx
@@ -1,10 +1,11 @@
 /// <reference lib="dom" />
-import { h, defineComponent } from 'vue'
+import { defineComponent, h } from 'vue'
 import { render, waitFor } from '@testing-library/vue'
 import '@testing-library/jest-dom'
-import { createFormFactory, type FieldApi, provideFormContext } from '../index'
 import userEvent from '@testing-library/user-event'
+import { createFormFactory, provideFormContext } from '../index'
 import { sleep } from './utils'
+import type { FieldApi } from '../index'
 
 const user = userEvent.setup()
 
diff --git a/packages/vue-form/src/tests/useForm.test.tsx b/packages/vue-form/src/tests/useForm.test.tsx
@@ -2,7 +2,7 @@
 import '@testing-library/jest-dom'
 import userEvent from '@testing-library/user-event'
 import { render, waitFor } from '@testing-library/vue'
-import { h, defineComponent, ref } from 'vue'
+import { defineComponent, h, ref } from 'vue'
 import {
   ValidationError,
   createFormFactory,
diff --git a/packages/vue-form/src/types.ts b/packages/vue-form/src/types.ts
@@ -1,7 +1,7 @@
 import type {
-  FieldOptions,
   DeepKeys,
   DeepValue,
+  FieldOptions,
   Validator,
 } from '@tanstack/form-core'
 
diff --git a/packages/vue-form/src/useField.tsx b/packages/vue-form/src/useField.tsx
@@ -8,7 +8,7 @@ import type {
   Narrow,
   Validator,
 } from '@tanstack/form-core'
-import type { SlotsType, SetupContext, Ref } from 'vue'
+import type { Ref, SetupContext, SlotsType } from 'vue'
 import type { UseFieldOptions } from './types'
 
 declare module '@tanstack/form-core' {
diff --git a/packages/vue-form/src/useForm.tsx b/packages/vue-form/src/useForm.tsx
diff --git a/packages/yup-form-adapter/src/tests/FieldApi.spec.ts b/packages/yup-form-adapter/src/tests/FieldApi.spec.ts
diff --git a/packages/yup-form-adapter/src/tests/FieldApi.test-d.ts b/packages/yup-form-adapter/src/tests/FieldApi.test-d.ts
diff --git a/packages/yup-form-adapter/src/tests/FormApi.spec.ts b/packages/yup-form-adapter/src/tests/FormApi.spec.ts
diff --git a/packages/yup-form-adapter/src/tests/FormApi.test-d.ts b/packages/yup-form-adapter/src/tests/FormApi.test-d.ts
diff --git a/packages/yup-form-adapter/src/validator.ts b/packages/yup-form-adapter/src/validator.ts
diff --git a/packages/zod-form-adapter/src/tests/FieldApi.spec.ts b/packages/zod-form-adapter/src/tests/FieldApi.spec.ts
diff --git a/packages/zod-form-adapter/src/tests/FieldApi.test-d.ts b/packages/zod-form-adapter/src/tests/FieldApi.test-d.ts
diff --git a/packages/zod-form-adapter/src/tests/FormApi.spec.ts b/packages/zod-form-adapter/src/tests/FormApi.spec.ts
diff --git a/packages/zod-form-adapter/src/tests/FormApi.test-d.ts b/packages/zod-form-adapter/src/tests/FormApi.test-d.ts
