CreateConfigOptions
interface CreateConfigOptions- optional
generalIgnores
Additional glob patterns to extend the shared ignore list
generalIgnores: string[]- optional
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[]- optional
registerImportPlugin
Toggle registration of the eslint-plugin-import-x plugin
registerImportPlugin: boolean;Default:true
- optional
registerPrettierPlugin
Toggle registration of the eslint-plugin-prettier plugin
registerPrettierPlugin: boolean;Default:true
- optional
registerSecurityPlugin
Toggle registration of the eslint-plugin-security plugin
registerSecurityPlugin: boolean;Default:true
- optional
registerTsdocPlugin
Toggle registration of the eslint-plugin-tsdoc plugin
registerTsdocPlugin: boolean;Default:true
- optional
registerTypescriptConfigs
Toggle registration of TypeScript ESLint configs
registerTypescriptConfigs: boolean;Default:true
- optional
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
- optional
tailwindCalleeFunctions
Function names whose string arguments are scanned for non-canonical Tailwind classes. The tw tagged template is handled by tailwindTaggedTemplates.
['cn']
tailwindCalleeFunctions: string[]- optional
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;- optional
tailwindTaggedTemplates
Tagged-template names whose content is scanned for non-canonical Tailwind classes. Only better-tailwindcss supports tagged templates.
['tw']
tailwindTaggedTemplates: string[]- optional
tsconfigRootDir
Root directory for TypeScript configuration
tsconfigRootDir: string;Default:process.cwd()
- optional
userConfigs
Additional user-defined ESLint configuration items to merge
userConfigs: FlatConfigItem[]