chore: add eslint rules about import order

.eslintrc

@@ -9,14 +9,37 @@
     "plugin:@typescript-eslint/recommended",
     "plugin:prettier/recommended"
   ],
-  "plugins": ["@typescript-eslint", "prettier"],
+  "plugins": ["@typescript-eslint", "import", "prettier"],
   "rules": {
+    // eslint
     "no-console": "error",
     "eol-last": ["error", "always"],
+    "sort-imports": ["error", {
+      "allowSeparatedGroups": true,
+      "ignoreCase": true,
+      "ignoreDeclarationSort": true,
+      "ignoreMemberSort": false,
+      "memberSyntaxSortOrder": ["none", "all", "multiple", "single"]
+    }],
 
     // typescript
     "@typescript-eslint/ban-types": "off",
-    "@typescript-eslint/no-explicit-any": "off"
+    "@typescript-eslint/no-explicit-any": "off",
+
+    // import
+    "import/order": ["error", {
+      "alphabetize": {
+        "caseInsensitive": true,
+        "order": "asc"
+      },
+      "groups": [
+        ["index"],
+        ["builtin", "external", "object"],
+        ["internal", "parent", "sibling"],
+        ["type"]
+      ],
+      "newlines-between": "always"
+    }]
   },
   "overrides": [
     {

package.json

@@ -55,6 +55,7 @@
     "esbuild-register": "^3.3.2",
     "eslint": "^8.13.0",
     "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-prettier": "^4.0.0",
     "esno": "^0.14.1",
     "fs-extra": "^10.1.0",

packages/core/scripts/publish.ts

@@ -1,7 +1,7 @@
 import { execSync as exec } from 'child_process';
-import path, { resolve } from 'path';
-import { readJSONSync, copyFileSync, removeSync } from 'fs-extra';
 import consola from 'consola';
+import { copyFileSync, readJSONSync, removeSync } from 'fs-extra';
+import path, { resolve } from 'path';
 
 exec('pnpm build', { stdio: 'inherit' });
 

packages/core/scripts/rollup.config.ts

@@ -1,13 +1,13 @@
-import path from 'path';
-import { readJSONSync } from 'fs-extra';
 import commonjs from '@rollup/plugin-commonjs';
 import resolve from '@rollup/plugin-node-resolve';
 import replace from '@rollup/plugin-replace';
+import { readJSONSync } from 'fs-extra';
+import path from 'path';
+import dts from 'rollup-plugin-dts';
 import { terser } from 'rollup-plugin-terser';
 import typescript from 'rollup-plugin-typescript2';
-import dts from 'rollup-plugin-dts';
 
-import type { RollupOptions, OutputOptions } from 'rollup';
+import type { OutputOptions, RollupOptions } from 'rollup';
 
 const { source } = readJSONSync(
   path.resolve(__dirname, '../package.json'),

packages/core/src/composable/useField.ts

@@ -1,5 +1,6 @@
 import { useInternalContext } from './useInternalContext';
-import type { MaybeRef, FieldValidator, UseFormRegisterReturn } from '../types';
+
+import type { FieldValidator, MaybeRef, UseFormRegisterReturn } from '../types';
 
 type UseFieldOptions<Value> = {
   validate?: FieldValidator<Value>;

packages/core/src/composable/useFieldArray.ts

@@ -1,25 +1,24 @@
-import { ref, unref, computed, Ref } from 'vue';
+import { computed, Ref, ref, unref } from 'vue';
 
+import appendAt from '../utils/append';
+import insertAt from '../utils/insert';
+import moveAt from '../utils/move';
+import omit from '../utils/omit';
+import prependAt from '../utils/prepend';
+import removeAt from '../utils/remove';
+import swapAt from '../utils/swap';
+import updateAt from '../utils/update';
 import { useInternalContext } from './useInternalContext';
 
 import type {
-  MaybeRef,
-  FormErrors,
-  FormTouched,
   FieldArrayValidator,
   FieldAttrs,
+  FormErrors,
+  FormTouched,
+  MaybeRef,
   Primitive,
 } from '../types';
 
-import appendAt from '../utils/append';
-import prependAt from '../utils/prepend';
-import swapAt from '../utils/swap';
-import removeAt from '../utils/remove';
-import moveAt from '../utils/move';
-import insertAt from '../utils/insert';
-import updateAt from '../utils/update';
-import omit from '../utils/omit';
-
 interface FieldEntry<Value> {
   key: number;
   value: Value;

packages/core/src/composable/useForm.ts

@@ -1,36 +1,35 @@
-import { computed, reactive, ref, unref, onMounted, provide } from 'vue';
+import deepmerge from 'deepmerge';
 import isEqual from 'fast-deep-equal/es6';
 import { klona as deepClone } from 'klona/full';
-import deepmerge from 'deepmerge';
-
-import { FormContextKey } from './useFormContext';
-import { InternalContextKey } from './useInternalContext';
-import useFormStore from './useFormStore';
+import { computed, onMounted, provide, reactive, ref, unref } from 'vue';
 
+import get from '../utils/get';
+import isFunction from '../utils/isFunction';
 import isPromise from '../utils/isPromise';
 import isString from '../utils/isString';
-import isFunction from '../utils/isFunction';
 import keysOf from '../utils/keysOf';
-import get from '../utils/get';
 import set from '../utils/set';
+import { FormContextKey } from './useFormContext';
+import useFormStore from './useFormStore';
+import { InternalContextKey } from './useInternalContext';
 
-import type { Reducer } from './useFormStore';
 import type {
-  MaybeRef,
-  FormValues,
-  FormState,
+  FieldAttrs,
+  FieldMeta,
   FormErrors,
   FormEventHandler,
-  FieldMeta,
-  FieldAttrs,
+  FormResetState,
+  FormState,
+  FormTouched,
+  FormValues,
+  MaybeRef,
+  ResetForm,
+  SetFieldArrayValue,
   UseFormRegister,
   UseFormReturn,
   ValidateField,
-  SetFieldArrayValue,
-  FormResetState,
-  ResetForm,
-  FormTouched,
 } from '../types';
+import type { Reducer } from './useFormStore';
 
 interface FieldRegistry {
   [field: string]: {

packages/core/src/composable/useFormContext.ts

@@ -1,5 +1,6 @@
 import { inject, InjectionKey } from 'vue';
-import type { UseFormReturn, FormValues } from '../types';
+
+import type { FormValues, UseFormReturn } from '../types';
 
 export type FormContextValues<Values extends FormValues = FormValues> =
   UseFormReturn<Values>;

packages/core/src/composable/useInternalContext.ts

@@ -1,20 +1,21 @@
 import {
-  inject,
+  ComputedRef,
   getCurrentInstance,
+  inject,
   InjectionKey,
   WritableComputedRef,
-  ComputedRef,
 } from 'vue';
+
 import {
-  MaybeRef,
-  FieldValidator,
   FieldArrayValidator,
-  FieldMeta,
   FieldAttrs,
-  SetFieldArrayValue,
-  FormTouched,
+  FieldMeta,
+  FieldValidator,
   FormErrors,
+  FormTouched,
   FormValues,
+  MaybeRef,
+  SetFieldArrayValue,
   UseFormSetFieldValue,
 } from '../types';
 

packages/core/src/types.ts

@@ -1,4 +1,4 @@
-import { ComputedRef, WritableComputedRef, UnwrapNestedRefs, Ref } from 'vue';
+import { ComputedRef, Ref, UnwrapNestedRefs, WritableComputedRef } from 'vue';
 
 export type MaybeRef<T> = T | Ref<T>;
 

packages/core/tests/composiable/useField.test.ts

@@ -1,8 +1,8 @@
-import { describe, expect, it } from 'vitest';
 import { mount } from '@vue/test-utils';
+import { describe, expect, it } from 'vitest';
 import { defineComponent } from 'vue';
 
-import { useForm, useField } from '../../src';
+import { useField, useForm } from '../../src';
 
 const noop = () => {};
 

packages/core/tests/composiable/useFieldArray.test.ts

@@ -1,8 +1,8 @@
-import { describe, expect, it } from 'vitest';
 import { mount } from '@vue/test-utils';
+import { describe, expect, it } from 'vitest';
 import { defineComponent } from 'vue';
 
-import { useForm, useFieldArray } from '../../src';
+import { useFieldArray, useForm } from '../../src';
 
 const noop = () => {};
 

packages/core/tests/composiable/useForm.test.ts

@@ -1,5 +1,5 @@
-import { describe, expect, it, vi } from 'vitest';
 import { mount } from '@vue/test-utils';
+import { describe, expect, it, vi } from 'vitest';
 import { defineComponent, nextTick, ref } from 'vue';
 
 import { useForm } from '../../src';

packages/core/tests/composiable/useFormContext.test.ts

@@ -1,5 +1,5 @@
-import { describe, expect, it } from 'vitest';
 import { mount } from '@vue/test-utils';
+import { describe, expect, it } from 'vitest';
 import { defineComponent, inject, provide } from 'vue';
 
 import { useForm, useFormContext } from '../../src';

packages/core/tests/utils/append.test.ts

@@ -1,4 +1,5 @@
-import { describe, it, expect } from 'vitest';
+import { describe, expect, it } from 'vitest';
+
 import append from '../../src/utils/append';
 
 describe('append', () => {

packages/core/tests/utils/compact.test.ts

@@ -1,4 +1,5 @@
-import { describe, it, expect } from 'vitest';
+import { describe, expect, it } from 'vitest';
+
 import compact from '../../src/utils/compact';
 
 describe('compact', () => {

packages/core/tests/utils/get.test.ts

@@ -1,4 +1,5 @@
-import { describe, it, expect } from 'vitest';
+import { describe, expect, it } from 'vitest';
+
 import get from '../../src/utils/get';
 
 describe('get', () => {

packages/core/tests/utils/insert.test.ts

@@ -1,4 +1,5 @@
-import { describe, it, expect } from 'vitest';
+import { describe, expect, it } from 'vitest';
+
 import insert from '../../src/utils/insert';
 
 describe('insert', () => {

packages/core/tests/utils/isDateObject.test.ts

@@ -1,4 +1,5 @@
-import { describe, it, expect } from 'vitest';
+import { describe, expect, it } from 'vitest';
+
 import isDateObject from '../../src/utils/isDateObject';
 
 describe('isDateObject', () => {

packages/core/tests/utils/isFunction.test.ts

@@ -1,4 +1,5 @@
-import { describe, it, expect } from 'vitest';
+import { describe, expect, it } from 'vitest';
+
 import isFunction from '../../src/utils/isFunction';
 
 describe('isFunction', () => {

packages/core/tests/utils/isKey.test.ts

@@ -1,4 +1,5 @@
-import { describe, it, expect } from 'vitest';
+import { describe, expect, it } from 'vitest';
+
 import isKey from '../../src/utils/isKey';
 
 describe('isKey', () => {

packages/core/tests/utils/isNullOrUndefined.test.ts

@@ -1,4 +1,5 @@
-import { describe, it, expect } from 'vitest';
+import { describe, expect, it } from 'vitest';
+
 import isNullOrUndefined from '../../src/utils/isNullOrUndefined';
 
 describe('isNullOrUndefined', () => {

packages/core/tests/utils/isObject.test.ts

@@ -1,4 +1,5 @@
-import { describe, it, expect } from 'vitest';
+import { describe, expect, it } from 'vitest';
+
 import isObject, { isObjectType } from '../../src/utils/isObject';
 
 describe('isObject', () => {

packages/core/tests/utils/isPromise.test.ts

@@ -1,4 +1,5 @@
-import { describe, it, expect } from 'vitest';
+import { describe, expect, it } from 'vitest';
+
 import isPromise from '../../src/utils/isPromise';
 
 describe('isPromise', () => {

packages/core/tests/utils/isString.test.ts

@@ -1,4 +1,5 @@
-import { describe, it, expect } from 'vitest';
+import { describe, expect, it } from 'vitest';
+
 import isString from '../../src/utils/isString';
 
 describe('isString', () => {

packages/core/tests/utils/isUndefined.test.ts

@@ -1,4 +1,5 @@
-import { describe, it, expect } from 'vitest';
+import { describe, expect, it } from 'vitest';
+
 import isUndefined from '../../src/utils/isUndefined';
 
 describe('isUndefined', () => {

packages/core/tests/utils/keysOf.test.ts

@@ -1,4 +1,5 @@
-import { describe, it, expect } from 'vitest';
+import { describe, expect, it } from 'vitest';
+
 import keysOf from '../../src/utils/keysOf';
 
 describe('keysOf', () => {

packages/core/tests/utils/move.test.ts

@@ -1,4 +1,5 @@
-import { describe, it, expect } from 'vitest';
+import { describe, expect, it } from 'vitest';
+
 import move from '../../src/utils/move';
 
 describe('move', () => {

packages/core/tests/utils/omit.test.ts

@@ -1,4 +1,5 @@
-import { describe, it, expect } from 'vitest';
+import { describe, expect, it } from 'vitest';
+
 import omit from '../../src/utils/omit';
 
 describe('omit', () => {

packages/core/tests/utils/prepend.test.ts

@@ -1,4 +1,5 @@
-import { describe, it, expect } from 'vitest';
+import { describe, expect, it } from 'vitest';
+
 import prepend from '../../src/utils/prepend';
 
 describe('prepend', () => {

packages/core/tests/utils/remove.test.ts

@@ -1,4 +1,5 @@
-import { describe, it, expect } from 'vitest';
+import { describe, expect, it } from 'vitest';
+
 import remove from '../../src/utils/remove';
 
 describe('remove', () => {

packages/core/tests/utils/set.test.ts

@@ -1,4 +1,5 @@
-import { describe, it, expect } from 'vitest';
+import { describe, expect, it } from 'vitest';
+
 import set from '../../src/utils/set';
 
 describe('set', () => {

packages/core/tests/utils/stringToPath.test.ts

@@ -1,4 +1,5 @@
-import { describe, it, expect } from 'vitest';
+import { describe, expect, it } from 'vitest';
+
 import stringToPath from '../../src/utils/stringToPath';
 
 describe('stringToPath', () => {

packages/core/tests/utils/swap.test.ts

@@ -1,4 +1,5 @@
-import { describe, it, expect } from 'vitest';
+import { describe, expect, it } from 'vitest';
+
 import swap from '../../src/utils/swap';
 
 describe('swap', () => {