feat: allow customize files, close #327

antfu · Nov 22, 2023 · 44d9e94 · 44d9e94
1 parent 86ca184
commit 44d9e94
Show file tree

Hide file tree

Showing 9 changed files with 47 additions and 25 deletions.
diff --git a/src/configs/javascript.ts b/src/configs/javascript.ts
@@ -10,6 +10,7 @@ export async function javascript(
     isInEditor = false,
     overrides = {},
   } = options
+
   return [
     {
       languageOptions: {

diff --git a/src/configs/jsonc.ts b/src/configs/jsonc.ts
@@ -1,9 +1,12 @@
-import type { FlatConfigItem, OptionsOverrides, OptionsStylistic } from '../types'
+import type { FlatConfigItem, OptionsFiles, OptionsOverrides, OptionsStylistic } from '../types'
 import { GLOB_JSON, GLOB_JSON5, GLOB_JSONC } from '../globs'
 import { interopDefault } from '../utils'
 
-export async function jsonc(options: OptionsStylistic & OptionsOverrides = {}): Promise<FlatConfigItem[]> {
+export async function jsonc(
+  options: OptionsFiles & OptionsStylistic & OptionsOverrides = {},
+): Promise<FlatConfigItem[]> {
   const {
+    files = [GLOB_JSON, GLOB_JSON5, GLOB_JSONC],
     overrides = {},
     stylistic = true,
   } = options
@@ -28,7 +31,7 @@ export async function jsonc(options: OptionsStylistic & OptionsOverrides = {}):
       },
     },
     {
-      files: [GLOB_JSON, GLOB_JSON5, GLOB_JSONC],
+      files,
       languageOptions: {
         parser: parserJsonc,
       },

diff --git a/src/configs/markdown.ts b/src/configs/markdown.ts
@@ -1,10 +1,13 @@
-import type { FlatConfigItem, OptionsComponentExts, OptionsOverrides } from '../types'
+import type { FlatConfigItem, OptionsComponentExts, OptionsFiles, OptionsOverrides } from '../types'
 import { GLOB_MARKDOWN, GLOB_MARKDOWN_CODE } from '../globs'
 import { interopDefault } from '../utils'
 
-export async function markdown(options: OptionsComponentExts & OptionsOverrides = {}): Promise<FlatConfigItem[]> {
+export async function markdown(
+  options: OptionsFiles & OptionsComponentExts & OptionsOverrides = {},
+): Promise<FlatConfigItem[]> {
   const {
     componentExts = [],
+    files = [GLOB_MARKDOWN],
     overrides = {},
   } = options
 
@@ -17,7 +20,7 @@ export async function markdown(options: OptionsComponentExts & OptionsOverrides
       },
     },
     {
-      files: [GLOB_MARKDOWN],
+      files,
       name: 'antfu:markdown:processor',
       processor: 'markdown/markdown',
     },

diff --git a/src/configs/react.ts b/src/configs/react.ts
@@ -1,6 +1,6 @@
 import { isPackageExists } from 'local-pkg'
 import { ensurePackages, interopDefault } from '../utils'
-import type { FlatConfigItem, OptionsHasTypeScript, OptionsOverrides, OptionsStylistic } from '../types'
+import type { FlatConfigItem, OptionsFiles, OptionsHasTypeScript, OptionsOverrides } from '../types'
 import { GLOB_JSX, GLOB_TSX } from '../globs'
 
 // react refresh
@@ -9,9 +9,10 @@ const ReactRefreshAllowConstantExportPackages = [
 ]
 
 export async function react(
-  options: OptionsHasTypeScript & OptionsOverrides & OptionsStylistic = {},
+  options: OptionsHasTypeScript & OptionsOverrides & OptionsFiles = {},
 ): Promise<FlatConfigItem[]> {
   const {
+    files = [GLOB_JSX, GLOB_TSX],
     overrides = {},
     typescript = true,
   } = options
@@ -46,7 +47,7 @@ export async function react(
       },
     },
     {
-      files: [GLOB_JSX, GLOB_TSX],
+      files,
       languageOptions: {
         parserOptions: {
           ecmaFeatures: {

diff --git a/src/configs/test.ts b/src/configs/test.ts
@@ -1,9 +1,12 @@
 import { interopDefault } from '../utils'
-import type { FlatConfigItem, OptionsIsInEditor, OptionsOverrides } from '../types'
+import type { FlatConfigItem, OptionsFiles, OptionsIsInEditor, OptionsOverrides } from '../types'
 import { GLOB_TESTS } from '../globs'
 
-export async function test(options: OptionsIsInEditor & OptionsOverrides = {}): Promise<FlatConfigItem[]> {
+export async function test(
+  options: OptionsFiles & OptionsIsInEditor & OptionsOverrides = {},
+): Promise<FlatConfigItem[]> {
   const {
+    files = GLOB_TESTS,
     isInEditor = false,
     overrides = {},
   } = options
@@ -32,7 +35,7 @@ export async function test(options: OptionsIsInEditor & OptionsOverrides = {}):
       },
     },
     {
-      files: GLOB_TESTS,
+      files,
       name: 'antfu:test:rules',
       rules: {
         'node/prefer-global/process': 'off',

diff --git a/src/configs/typescript.ts b/src/configs/typescript.ts
@@ -1,17 +1,22 @@
 import process from 'node:process'
-import type { FlatConfigItem, OptionsComponentExts, OptionsOverrides, OptionsTypeScriptParserOptions, OptionsTypeScriptWithTypes } from '../types'
+import type { FlatConfigItem, OptionsComponentExts, OptionsFiles, OptionsOverrides, OptionsTypeScriptParserOptions, OptionsTypeScriptWithTypes } from '../types'
 import { GLOB_SRC } from '../globs'
 import { pluginAntfu } from '../plugins'
 import { interopDefault, renameRules, toArray } from '../utils'
 
 export async function typescript(
-  options?: OptionsComponentExts & OptionsOverrides & OptionsTypeScriptWithTypes & OptionsTypeScriptParserOptions,
+  options: OptionsFiles & OptionsComponentExts & OptionsOverrides & OptionsTypeScriptWithTypes & OptionsTypeScriptParserOptions = {},
 ): Promise<FlatConfigItem[]> {
   const {
     componentExts = [],
     overrides = {},
     parserOptions = {},
-  } = options ?? {}
+  } = options
+
+  const files = options.files ?? [
+    GLOB_SRC,
+    ...componentExts.map(ext => `**/*.${ext}`),
+  ]
 
   const typeAwareRules: FlatConfigItem['rules'] = {
     'dot-notation': 'off',
@@ -57,10 +62,7 @@ export async function typescript(
       },
     },
     {
-      files: [
-        GLOB_SRC,
-        ...componentExts.map(ext => `**/*.${ext}`),
-      ],
+      files,
       languageOptions: {
         parser: parserTs,
         parserOptions: {

diff --git a/src/configs/vue.ts b/src/configs/vue.ts
@@ -1,11 +1,12 @@
 import { interopDefault } from '../utils'
-import type { FlatConfigItem, OptionsHasTypeScript, OptionsOverrides, OptionsStylistic } from '../types'
+import type { FlatConfigItem, OptionsFiles, OptionsHasTypeScript, OptionsOverrides, OptionsStylistic } from '../types'
 import { GLOB_VUE } from '../globs'
 
 export async function vue(
-  options: OptionsHasTypeScript & OptionsOverrides & OptionsStylistic = {},
+  options: OptionsHasTypeScript & OptionsOverrides & OptionsStylistic & OptionsFiles = {},
 ): Promise<FlatConfigItem[]> {
   const {
+    files = [GLOB_VUE],
     overrides = {},
     stylistic = true,
   } = options
@@ -31,7 +32,7 @@ export async function vue(
       },
     },
     {
-      files: [GLOB_VUE],
+      files,
       languageOptions: {
         parser: parserVue,
         parserOptions: {

diff --git a/src/configs/yaml.ts b/src/configs/yaml.ts
@@ -1,11 +1,12 @@
-import type { FlatConfigItem, OptionsOverrides, OptionsStylistic } from '../types'
+import type { FlatConfigItem, OptionsFiles, OptionsOverrides, OptionsStylistic } from '../types'
 import { GLOB_YAML } from '../globs'
 import { interopDefault } from '../utils'
 
 export async function yaml(
-  options: OptionsOverrides & OptionsStylistic = {},
+  options: OptionsOverrides & OptionsStylistic & OptionsFiles = {},
 ): Promise<FlatConfigItem[]> {
   const {
+    files = [GLOB_YAML],
     overrides = {},
     stylistic = true,
   } = options
@@ -31,7 +32,7 @@ export async function yaml(
       },
     },
     {
-      files: [GLOB_YAML],
+      files,
       languageOptions: {
         parser: parserYaml,
       },

diff --git a/src/types.ts b/src/types.ts
@@ -70,6 +70,13 @@ export type FlatConfigItem = Omit<FlatESLintConfigItem<Rules, false>, 'plugins'>
 
 export type UserConfigItem = FlatConfigItem | Linter.FlatConfig
 
+export interface OptionsFiles {
+  /**
+   * Override the `files` option to provide custom globs.
+   */
+  files?: string[]
+}
+
 export interface OptionsComponentExts {
   /**
    * Additional extensions for components.