feat: enable perfectionist/sort-imports et al, close #456

antfu · antfu · commit a6efa0957a61 · 2024-09-06T04:49:07.000+02:00
diff --git a/eslint.config.ts b/eslint.config.ts
@@ -1,5 +1,6 @@
 // @ts-expect-error missing types
 import styleMigrate from '@stylistic/eslint-plugin-migrate'
+
 import { antfu } from './src'
 
 export default antfu(
diff --git a/scripts/typegen.ts b/scripts/typegen.ts
@@ -1,6 +1,8 @@
 import fs from 'node:fs/promises'
-import { flatConfigsToRulesDTS } from 'eslint-typegen/core'
+
 import { builtinRules } from 'eslint/use-at-your-own-risk'
+import { flatConfigsToRulesDTS } from 'eslint-typegen/core'
+
 import { astro, combine, comments, formatters, imports, javascript, jsdoc, jsonc, jsx, markdown, node, perfectionist, react, regexp, solid, sortPackageJson, stylistic, svelte, test, toml, typescript, unicorn, unocss, vue, yaml } from '../src'
 
 const configs = await combine(
diff --git a/src/cli/constants.ts b/src/cli/constants.ts
@@ -1,5 +1,7 @@
 import c from 'picocolors'
+
 import pkgJson from '../../package.json'
+
 import type { ExtraLibrariesOption, FrameworkOption, PromItem } from './types'
 
 export { pkgJson }
diff --git a/src/cli/index.ts b/src/cli/index.ts
@@ -1,10 +1,12 @@
 import process from 'node:process'
+
+import * as p from '@clack/prompts'
 import c from 'picocolors'
-import { hideBin } from 'yargs/helpers'
 import yargs from 'yargs'
-import * as p from '@clack/prompts'
-import { run } from './run'
+import { hideBin } from 'yargs/helpers'
+
 import { pkgJson } from './constants'
+import { run } from './run'
 
 function header(): void {
   // eslint-disable-next-line no-console
diff --git a/src/cli/run.ts b/src/cli/run.ts
@@ -2,15 +2,17 @@
 import fs from 'node:fs'
 import path from 'node:path'
 import process from 'node:process'
-import c from 'picocolors'
+
 import * as p from '@clack/prompts'
+import c from 'picocolors'
 
 import { extra, extraOptions, frameworkOptions, frameworks } from './constants'
-import { isGitClean } from './utils'
-import type { ExtraLibrariesOption, FrameworkOption, PromItem, PromptResult } from './types'
-import { updatePackageJson } from './stages/update-package-json'
 import { updateEslintFiles } from './stages/update-eslint-files'
+import { updatePackageJson } from './stages/update-package-json'
 import { updateVscodeSettings } from './stages/update-vscode-settings'
+import { isGitClean } from './utils'
+
+import type { ExtraLibrariesOption, FrameworkOption, PromItem, PromptResult } from './types'
 
 export interface CliRunOptions {
   /**
diff --git a/src/cli/stages/update-eslint-files.ts b/src/cli/stages/update-eslint-files.ts
@@ -1,13 +1,15 @@
 import fs from 'node:fs'
 import fsp from 'node:fs/promises'
-import process from 'node:process'
 import path from 'node:path'
-import c from 'picocolors'
-import * as p from '@clack/prompts'
+import process from 'node:process'
 
+import * as p from '@clack/prompts'
 // @ts-expect-error missing types
 import parse from 'parse-gitignore'
+import c from 'picocolors'
+
 import { getEslintConfigContent } from '../utils'
+
 import type { PromptResult } from '../types'
 
 export async function updateEslintFiles(result: PromptResult): Promise<void> {
diff --git a/src/cli/stages/update-package-json.ts b/src/cli/stages/update-package-json.ts
@@ -1,10 +1,12 @@
-import path from 'node:path'
 import fsp from 'node:fs/promises'
+import path from 'node:path'
 import process from 'node:process'
-import c from 'picocolors'
+
 import * as p from '@clack/prompts'
+import c from 'picocolors'
 
 import { dependenciesMap, pkgJson } from '../constants'
+
 import type { ExtraLibrariesOption, PromptResult } from '../types'
 
 export async function updatePackageJson(result: PromptResult): Promise<void> {
diff --git a/src/cli/stages/update-vscode-settings.ts b/src/cli/stages/update-vscode-settings.ts
@@ -1,11 +1,13 @@
-import path from 'node:path'
-import fsp from 'node:fs/promises'
 import fs from 'node:fs'
+import fsp from 'node:fs/promises'
+import path from 'node:path'
 import process from 'node:process'
-import c from 'picocolors'
+
 import * as p from '@clack/prompts'
+import c from 'picocolors'
 
 import { vscodeSettingsString } from '../constants'
+
 import type { PromptResult } from '../types'
 
 export async function updateVscodeSettings(result: PromptResult): Promise<void> {
diff --git a/src/configs/astro.ts b/src/configs/astro.ts
@@ -1,7 +1,8 @@
-import type { OptionsFiles, OptionsOverrides, OptionsStylistic, TypedFlatConfigItem } from '../types'
 import { GLOB_ASTRO } from '../globs'
 import { interopDefault } from '../utils'
 
+import type { OptionsFiles, OptionsOverrides, OptionsStylistic, TypedFlatConfigItem } from '../types'
+
 export async function astro(
   options: OptionsOverrides & OptionsStylistic & OptionsFiles = {},
 ): Promise<TypedFlatConfigItem[]> {
diff --git a/src/configs/command.ts b/src/configs/command.ts
@@ -1,4 +1,5 @@
 import createCommand from 'eslint-plugin-command/config'
+
 import type { TypedFlatConfigItem } from '../types'
 
 export async function command(): Promise<TypedFlatConfigItem[]> {
diff --git a/src/configs/comments.ts b/src/configs/comments.ts
@@ -1,6 +1,7 @@
-import type { TypedFlatConfigItem } from '../types'
 import { pluginComments } from '../plugins'
 
+import type { TypedFlatConfigItem } from '../types'
+
 export async function comments(): Promise<TypedFlatConfigItem[]> {
   return [
     {
diff --git a/src/configs/disables.ts b/src/configs/disables.ts
@@ -1,4 +1,5 @@
 import { GLOB_SRC, GLOB_SRC_EXT } from '../globs'
+
 import type { TypedFlatConfigItem } from '../types'
 
 export async function disables(): Promise<TypedFlatConfigItem[]> {
diff --git a/src/configs/formatters.ts b/src/configs/formatters.ts
@@ -1,10 +1,12 @@
 import { isPackageExists } from 'local-pkg'
+
 import { GLOB_ASTRO, GLOB_ASTRO_TS, GLOB_CSS, GLOB_GRAPHQL, GLOB_HTML, GLOB_LESS, GLOB_MARKDOWN, GLOB_POSTCSS, GLOB_SCSS, GLOB_SVG, GLOB_XML } from '../globs'
-import type { VendoredPrettierOptions } from '../vender/prettier-types'
 import { ensurePackages, interopDefault, isPackageInScope, parserPlain } from '../utils'
-import type { OptionsFormatters, StylisticConfig, TypedFlatConfigItem } from '../types'
 import { StylisticConfigDefaults } from './stylistic'
 
+import type { OptionsFormatters, StylisticConfig, TypedFlatConfigItem } from '../types'
+import type { VendoredPrettierOptions } from '../vender/prettier-types'
+
 export async function formatters(
   options: OptionsFormatters | true = {},
   stylistic: StylisticConfig = {},
diff --git a/src/configs/ignores.ts b/src/configs/ignores.ts
@@ -1,6 +1,7 @@
-import type { TypedFlatConfigItem } from '../types'
 import { GLOB_EXCLUDE } from '../globs'
 
+import type { TypedFlatConfigItem } from '../types'
+
 export async function ignores(userIgnores: string[] = []): Promise<TypedFlatConfigItem[]> {
   return [
     {
diff --git a/src/configs/imports.ts b/src/configs/imports.ts
@@ -1,6 +1,7 @@
-import type { OptionsStylistic, TypedFlatConfigItem } from '../types'
 import { pluginAntfu, pluginImport } from '../plugins'
 
+import type { OptionsStylistic, TypedFlatConfigItem } from '../types'
+
 export async function imports(options: OptionsStylistic = {}): Promise<TypedFlatConfigItem[]> {
   const {
     stylistic = true,
@@ -24,7 +25,6 @@ export async function imports(options: OptionsStylistic = {}): Promise<TypedFlat
         'import/no-named-default': 'error',
         'import/no-self-import': 'error',
         'import/no-webpack-loader-syntax': 'error',
-        'import/order': 'error',
 
         ...stylistic
           ? {
diff --git a/src/configs/index.ts b/src/configs/index.ts
@@ -1,17 +1,19 @@
 export * from './astro'
 export * from './command'
 export * from './comments'
+export * from './disables'
 export * from './formatters'
 export * from './ignores'
 export * from './imports'
 export * from './javascript'
 export * from './jsdoc'
-export * from './jsx'
 export * from './jsonc'
+export * from './jsx'
 export * from './markdown'
 export * from './node'
 export * from './perfectionist'
 export * from './react'
+export * from './regexp'
 export * from './solid'
 export * from './sort'
 export * from './stylistic'
@@ -23,5 +25,3 @@ export * from './unicorn'
 export * from './unocss'
 export * from './vue'
 export * from './yaml'
-export * from './regexp'
-export * from './disables'
diff --git a/src/configs/javascript.ts b/src/configs/javascript.ts
@@ -1,7 +1,9 @@
 import globals from 'globals'
-import type { OptionsIsInEditor, OptionsOverrides, TypedFlatConfigItem } from '../types'
+
 import { pluginAntfu, pluginUnusedImports } from '../plugins'
 
+import type { OptionsIsInEditor, OptionsOverrides, TypedFlatConfigItem } from '../types'
+
 export async function javascript(
   options: OptionsIsInEditor & OptionsOverrides = {},
 ): Promise<TypedFlatConfigItem[]> {
@@ -186,17 +188,6 @@ export async function javascript(
         'prefer-rest-params': 'error',
         'prefer-spread': 'error',
         'prefer-template': 'error',
-        'sort-imports': [
-          'error',
-          {
-            allowSeparatedGroups: false,
-            ignoreCase: false,
-            ignoreDeclarationSort: true,
-            ignoreMemberSort: false,
-            memberSyntaxSortOrder: ['none', 'all', 'multiple', 'single'],
-          },
-        ],
-
         'symbol-description': 'error',
         'unicode-bom': ['error', 'never'],
         'unused-imports/no-unused-imports': isInEditor ? 'off' : 'error',
diff --git a/src/configs/jsdoc.ts b/src/configs/jsdoc.ts
@@ -1,4 +1,5 @@
 import { interopDefault } from '../utils'
+
 import type { OptionsStylistic, TypedFlatConfigItem } from '../types'
 
 export async function jsdoc(options: OptionsStylistic = {}): Promise<TypedFlatConfigItem[]> {
diff --git a/src/configs/jsonc.ts b/src/configs/jsonc.ts
@@ -1,7 +1,8 @@
-import type { OptionsFiles, OptionsOverrides, OptionsStylistic, TypedFlatConfigItem } from '../types'
 import { GLOB_JSON, GLOB_JSON5, GLOB_JSONC } from '../globs'
 import { interopDefault } from '../utils'
 
+import type { OptionsFiles, OptionsOverrides, OptionsStylistic, TypedFlatConfigItem } from '../types'
+
 export async function jsonc(
   options: OptionsFiles & OptionsStylistic & OptionsOverrides = {},
 ): Promise<TypedFlatConfigItem[]> {
diff --git a/src/configs/jsx.ts b/src/configs/jsx.ts
@@ -1,6 +1,7 @@
-import type { TypedFlatConfigItem } from '../types'
 import { GLOB_JSX, GLOB_TSX } from '../globs'
 
+import type { TypedFlatConfigItem } from '../types'
+
 export async function jsx(): Promise<TypedFlatConfigItem[]> {
   return [
     {
diff --git a/src/configs/markdown.ts b/src/configs/markdown.ts
@@ -1,8 +1,10 @@
 import { mergeProcessors, processorPassThrough } from 'eslint-merge-processors'
-import type { OptionsComponentExts, OptionsFiles, OptionsOverrides, TypedFlatConfigItem } from '../types'
+
 import { GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_MARKDOWN_IN_MARKDOWN } from '../globs'
 import { interopDefault, parserPlain } from '../utils'
 
+import type { OptionsComponentExts, OptionsFiles, OptionsOverrides, TypedFlatConfigItem } from '../types'
+
 export async function markdown(
   options: OptionsFiles & OptionsComponentExts & OptionsOverrides = {},
 ): Promise<TypedFlatConfigItem[]> {
diff --git a/src/configs/node.ts b/src/configs/node.ts
@@ -1,6 +1,7 @@
-import type { TypedFlatConfigItem } from '../types'
 import { pluginNode } from '../plugins'
 
+import type { TypedFlatConfigItem } from '../types'
+
 export async function node(): Promise<TypedFlatConfigItem[]> {
   return [
     {
diff --git a/src/configs/perfectionist.ts b/src/configs/perfectionist.ts
@@ -1,8 +1,9 @@
-import type { TypedFlatConfigItem } from '../types'
 import { pluginPerfectionist } from '../plugins'
 
+import type { TypedFlatConfigItem } from '../types'
+
 /**
- * Optional perfectionist plugin for props and items sorting.
+ * Perfectionist plugin for props and items sorting.
  *
  * @see https://github.com/azat-io/eslint-plugin-perfectionist
  */
@@ -13,6 +14,25 @@ export async function perfectionist(): Promise<TypedFlatConfigItem[]> {
       plugins: {
         perfectionist: pluginPerfectionist,
       },
+      rules: {
+        'perfectionist/sort-exports': ['error', { order: 'asc', type: 'natural' }],
+        'perfectionist/sort-imports': ['error', {
+          groups: [
+            'builtin',
+            'external',
+            'type',
+            ['internal', 'internal-type'],
+            ['parent', 'sibling', 'index'],
+            ['parent-type', 'sibling-type', 'index-type'],
+            'object',
+            'unknown',
+          ],
+          order: 'asc',
+          type: 'natural',
+        }],
+        'perfectionist/sort-named-exports': ['error', { order: 'asc', type: 'natural' }],
+        'perfectionist/sort-named-imports': ['error', { order: 'asc', type: 'natural' }],
+      },
     },
   ]
 }
diff --git a/src/configs/react.ts b/src/configs/react.ts
@@ -1,7 +1,9 @@
 import { isPackageExists } from 'local-pkg'
+
+import { GLOB_SRC } from '../globs'
 import { ensurePackages, interopDefault, toArray } from '../utils'
+
 import type { OptionsFiles, OptionsOverrides, OptionsTypeScriptWithTypes, TypedFlatConfigItem } from '../types'
-import { GLOB_SRC } from '../globs'
 
 // react refresh
 const ReactRefreshAllowConstantExportPackages = [
diff --git a/src/configs/regexp.ts b/src/configs/regexp.ts
@@ -1,4 +1,5 @@
 import { configs } from 'eslint-plugin-regexp'
+
 import type { OptionsOverrides, OptionsRegExp, TypedFlatConfigItem } from '../types'
 
 export async function regexp(
diff --git a/src/configs/solid.ts b/src/configs/solid.ts
@@ -1,6 +1,7 @@
+import { GLOB_JSX, GLOB_TSX } from '../globs'
 import { ensurePackages, interopDefault, toArray } from '../utils'
+
 import type { OptionsFiles, OptionsHasTypeScript, OptionsOverrides, OptionsTypeScriptWithTypes, TypedFlatConfigItem } from '../types'
-import { GLOB_JSX, GLOB_TSX } from '../globs'
 
 export async function solid(
   options: OptionsHasTypeScript & OptionsOverrides & OptionsFiles & OptionsTypeScriptWithTypes = {},
diff --git a/src/configs/stylistic.ts b/src/configs/stylistic.ts
@@ -1,6 +1,7 @@
+import { pluginAntfu } from '../plugins'
 import { interopDefault } from '../utils'
+
 import type { OptionsOverrides, StylisticConfig, TypedFlatConfigItem } from '../types'
-import { pluginAntfu } from '../plugins'
 
 export const StylisticConfigDefaults: StylisticConfig = {
   indent: 2,
diff --git a/src/configs/svelte.ts b/src/configs/svelte.ts
@@ -1,6 +1,7 @@
+import { GLOB_SVELTE } from '../globs'
 import { ensurePackages, interopDefault } from '../utils'
+
 import type { OptionsFiles, OptionsHasTypeScript, OptionsOverrides, OptionsStylistic, TypedFlatConfigItem } from '../types'
-import { GLOB_SVELTE } from '../globs'
 
 export async function svelte(
   options: OptionsHasTypeScript & OptionsOverrides & OptionsStylistic & OptionsFiles = {},
diff --git a/src/configs/test.ts b/src/configs/test.ts
@@ -1,6 +1,7 @@
+import { GLOB_TESTS } from '../globs'
 import { interopDefault } from '../utils'
+
 import type { OptionsFiles, OptionsIsInEditor, OptionsOverrides, TypedFlatConfigItem } from '../types'
-import { GLOB_TESTS } from '../globs'
 
 // Hold the reference so we don't redeclare the plugin on each call
 let _pluginTest: any
diff --git a/src/configs/toml.ts b/src/configs/toml.ts
@@ -1,7 +1,8 @@
-import type { OptionsFiles, OptionsOverrides, OptionsStylistic, TypedFlatConfigItem } from '../types'
 import { GLOB_TOML } from '../globs'
 import { interopDefault } from '../utils'
 
+import type { OptionsFiles, OptionsOverrides, OptionsStylistic, TypedFlatConfigItem } from '../types'
+
 export async function toml(
   options: OptionsOverrides & OptionsStylistic & OptionsFiles = {},
 ): Promise<TypedFlatConfigItem[]> {
diff --git a/src/configs/typescript.ts b/src/configs/typescript.ts
diff --git a/src/configs/unicorn.ts b/src/configs/unicorn.ts
diff --git a/src/configs/unocss.ts b/src/configs/unocss.ts
diff --git a/src/configs/vue.ts b/src/configs/vue.ts
diff --git a/src/configs/yaml.ts b/src/configs/yaml.ts
diff --git a/src/factory.ts b/src/factory.ts
diff --git a/src/plugins.ts b/src/plugins.ts
diff --git a/src/types.ts b/src/types.ts
diff --git a/src/utils.ts b/src/utils.ts
diff --git a/test/cli.spec.ts b/test/cli.spec.ts
diff --git a/test/fixtures.test.ts b/test/fixtures.test.ts
diff --git a/test/types.ts b/test/types.ts
