Skip to content
Interfaceeslint-configv2.5.0

CreateConfigOptions

interface CreateConfigOptions

generalIgnores

Additional glob patterns to extend the shared ignore list

generalIgnores?: string[]

mdxFiles

File globs to lint as MDX (typically every .mdx). Registers the eslint-mdx parser + mdx plugin and runs no-unused-expressions on embedded JS/JSX. Does not lint markdown prose.

mdxFiles?: string[]

registerImportPlugin

How much of the eslint-plugin-import-x rule set to run. Drop to 'fast' when lint time matters more than catching import cycles and deprecated imports.

registerImportPlugin?: ImportPluginLevel

Default:'all'

registerSecurityPlugin

Toggle registration of the eslint-plugin-security plugin

registerSecurityPlugin?: boolean

Default:true

registerTsdocPlugin

Toggle registration of the eslint-plugin-tsdoc plugin

registerTsdocPlugin?: boolean

Default:true

registerTypescriptConfigs

Toggle registration of TypeScript ESLint configs. 'no-type-checked' keeps the presets and turns off the rules that read the type checker, the slowest ones in a run. The parser keeps its project either way, since the seedcord and discordjs rules read types of their own.

'rules-only' applies seedcord's TypeScript rules without the typescript-eslint presets. Use it when another config in the array already loads the @typescript-eslint plugin, like eslint-config-next. ESLint throws when two configs load different copies of one plugin.

registerTypescriptConfigs?: TypescriptConfigsLevel

Default:true

registerUnicornPlugin

Toggle registration of the eslint-plugin-unicorn plugin. unicorn requires eslint =10.4, so consumers still on eslint 9 must set this to false.

registerUnicornPlugin?: boolean

Default:true

relativeImports

'parent' reports an import path that starts with ../. A ./ import and a path alias like #src/... pass.

relativeImports?: RelativeImportsMode

Default:'allow'

tailwindCalleeFunctions

Function names whose string arguments are scanned for non-canonical Tailwind classes. The tw tagged template is handled by tailwindTaggedTemplates.

['cn']

tailwindCalleeFunctions?: string[]

tailwindEntryPoint

Absolute path to the consumer's Tailwind entry CSS (@import 'tailwindcss'). When set, the canonical-class rules run as warn, off when omitted. Shared packages without a globals.css can pass a sibling app's entry via resolveSharedTailwindEntry. Requires tailwindcss.

tailwindEntryPoint?: string

tailwindTaggedTemplates

Tagged-template names whose content is scanned for non-canonical Tailwind classes. Only better-tailwindcss supports tagged templates.

['tw']

tailwindTaggedTemplates?: string[]

tsconfigRootDir

Root directory for TypeScript configuration

tsconfigRootDir?: string

Default:process.cwd()

userConfigs

Additional user-defined ESLint configuration items to merge

userConfigs?: FlatConfigItem[]