core/src

Enumerations

Extension

Defined in: core/src/types.ts:36

Enum for specialized ESLint extensions and strict rule sets

Enumeration Members

A11y: "a11y"

Defined in: core/src/types.ts:41

Accessibility (a11y) rules for JSX and Vue

AstroDoctor

AstroDoctor: "astro-doctor"

Defined in: core/src/types.ts:46

Astro Doctor performance, accessibility, security, and best-practice rules

BestPractices

BestPractices: "best-practices"

Defined in: core/src/types.ts:52

Built-in best-practice rules: no-console, no-alert, cyclomatic complexity, max nesting depth. No extra dependencies required.

Biome

Biome: "biome"

Defined in: core/src/types.ts:57

Disables formatting rules that conflict with Biome

Boundaries

Boundaries: "boundaries"

Defined in: core/src/types.ts:62

Import boundary rules for common app, workspace, and generated-code edges.

Compat

Compat: "compat"

Defined in: core/src/types.ts:67

Browser compatibility checks against the project browserslist

DeMorgan

DeMorgan: "de-morgan"

Defined in: core/src/types.ts:72

Simplifies negated logical expressions (De Morgan’s laws)

Depend

Depend: "depend"

Defined in: core/src/types.ts:77

Suggests lighter or native alternatives to heavy dependencies

Node

Node: "node"

Defined in: core/src/types.ts:82

Node.js rules from eslint-plugin-n for server-side codebases

NoOnlyTests

NoOnlyTests: "no-only-tests"

Defined in: core/src/types.ts:87

Prevents test.only / describe.only from being committed

Oxlint

Oxlint: "oxlint"

Defined in: core/src/types.ts:92

Disables rules already covered by Oxlint for hybrid linting setups

Perfectionist

Perfectionist: "perfectionist"

Defined in: core/src/types.ts:93

Regexp

Regexp: "regexp"

Defined in: core/src/types.ts:94

Security

Security: "security"

Defined in: core/src/types.ts:95

Sonarjs

Sonarjs: "sonarjs"

Defined in: core/src/types.ts:96

Unicorn

Unicorn: "unicorn"

Defined in: core/src/types.ts:98

Format

Defined in: core/src/types.ts:104

Enum for linting non-JS/TS file formats

Enumeration Members

Css

Css: "css"

Defined in: core/src/types.ts:105

Graphql

Graphql: "graphql"

Defined in: core/src/types.ts:106

Html

Html: "html"

Defined in: core/src/types.ts:107

Jsonc

Jsonc: "jsonc"

Defined in: core/src/types.ts:108

Markdown

Markdown: "markdown"

Defined in: core/src/types.ts:109

Mdx

Mdx: "mdx"

Defined in: core/src/types.ts:110

PackageJson

PackageJson: "package-json"

Defined in: core/src/types.ts:111

Toml

Toml: "toml"

Defined in: core/src/types.ts:112

Yaml

Yaml: "yaml"

Defined in: core/src/types.ts:113

Library

Defined in: core/src/types.ts:119

Enum for application-level runtime dependencies and styling

Enumeration Members

AiSdk

AiSdk: "ai-sdk"

Defined in: core/src/types.ts:120

Autogen

Autogen: "autogen"

Defined in: core/src/types.ts:121

Drizzle

Drizzle: "drizzle"

Defined in: core/src/types.ts:122

GoogleGenAi

GoogleGenAi: "google-genai"

Defined in: core/src/types.ts:123

I18next

I18next: "i18next"

Defined in: core/src/types.ts:124

Langchain

Langchain: "langchain"

Defined in: core/src/types.ts:125

LlamaIndex

LlamaIndex: "llamaindex"

Defined in: core/src/types.ts:126

Mastra

Mastra: "mastra"

Defined in: core/src/types.ts:127

Mcp

Mcp: "mcp"

Defined in: core/src/types.ts:128

MikroOrm

MikroOrm: "mikro-orm"

Defined in: core/src/types.ts:129

OpenAiAgents

OpenAiAgents: "openai-agents"

Defined in: core/src/types.ts:130

Prisma

Prisma: "prisma"

Defined in: core/src/types.ts:131

Sequelize

Sequelize: "sequelize"

Defined in: core/src/types.ts:132

Stencil

Stencil: "stencil"

Defined in: core/src/types.ts:133

Storybook

Storybook: "storybook"

Defined in: core/src/types.ts:134

Tailwind

Tailwind: "tailwind"

Defined in: core/src/types.ts:135

TanstackQuery

TanstackQuery: "tanstack-query"

Defined in: core/src/types.ts:136

TanstackRouter

TanstackRouter: "tanstack-router"

Defined in: core/src/types.ts:137

Turbo

Turbo: "turbo"

Defined in: core/src/types.ts:138

Typeorm

Typeorm: "typeorm"

Defined in: core/src/types.ts:139

Zod

Zod: "zod"

Defined in: core/src/types.ts:140

NextMode

Defined in: core/src/types.ts:146

Enum for Next.js mode options

Enumeration Members

AppRouter

AppRouter: "app-router"

Defined in: core/src/types.ts:147

Pages

Pages: "pages"

Defined in: core/src/types.ts:148

Preset

Defined in: core/src/types.ts:154

Enum for named presets

Enumeration Members

All

All: "all"

Defined in: core/src/types.ts:157

All configs + all optionals

App

App: "app"

Defined in: core/src/types.ts:160

Browser application defaults with TypeScript and Prettier

Basic

Basic: "basic"

Defined in: core/src/types.ts:163

Core JS config only

Browser

Browser: "browser"

Defined in: core/src/types.ts:166

Core + TS + Browser runtime

CI

CI: "ci"

Defined in: core/src/types.ts:169

CI-oriented defaults with strict severities

Library

Library: "library"

Defined in: core/src/types.ts:172

TypeScript package/library defaults for published packages

Monorepo

Monorepo: "monorepo"

Defined in: core/src/types.ts:175

Monorepo-friendly defaults for mixed workspaces

Node

Node: "node"

Defined in: core/src/types.ts:178

Core + TS + Node runtime

Worker

Worker: "worker"

Defined in: core/src/types.ts:181

Core + TS + Worker runtime

Runtime

Defined in: core/src/types.ts:187

Enum for runtime environment presets

Enumeration Members

Browser

Browser: "browser"

Defined in: core/src/types.ts:190

Only Browser globals (window, document, etc.)

Bun

Bun: "bun"

Defined in: core/src/types.ts:193

Bun runtime globals

Cloudflare

Cloudflare: "cloudflare"

Defined in: core/src/types.ts:196

Cloudflare Workers globals

Deno

Deno: "deno"

Defined in: core/src/types.ts:199

Deno runtime globals

Node

Node: "node"

Defined in: core/src/types.ts:202

Only Node.js globals (process, __dirname, etc.)

Universal

Universal: "universal"

Defined in: core/src/types.ts:205

Both Node.js and Browser globals (default)

Worker

Worker: "worker"

Defined in: core/src/types.ts:208

Service Worker and Fetch API globals for edge runtimes

Setting

Defined in: core/src/types.ts:214

Enum for settings options in ESLint

Enumeration Members

NoDefaultIgnores

NoDefaultIgnores: "no-default-ignores"

Defined in: core/src/types.ts:217

Disable the built-in default ignore globs (dist, build, coverage, etc.).

NoGeneratedCodeIgnores

NoGeneratedCodeIgnores: "no-generated-code-ignores"

Defined in: core/src/types.ts:220

Disable generated-code ignore globs.

NoGitignore

NoGitignore: "no-gitignore"

Defined in: core/src/types.ts:223

Disable automatic .gitignore-based ignores.

Testing

Defined in: core/src/types.ts:229

Enum for testing frameworks and environments

Enumeration Members

Cypress

Cypress: "cypress"

Defined in: core/src/types.ts:230

Jest

Jest: "jest"

Defined in: core/src/types.ts:231

JestDom

JestDom: "jest-dom"

Defined in: core/src/types.ts:232

Playwright

Playwright: "playwright"

Defined in: core/src/types.ts:233

TestingLibrary

TestingLibrary: "testing-library"

Defined in: core/src/types.ts:234

Vitest

Vitest: "vitest"

Defined in: core/src/types.ts:235

Tool

Defined in: core/src/types.ts:241

Enum for integrating external standalone utilities

Enumeration Members

Command

Command: "command"

Defined in: core/src/types.ts:242

Cspell

Cspell: "cspell"

Defined in: core/src/types.ts:243

Docker

Docker: "docker"

Defined in: core/src/types.ts:244

GithubActions

GithubActions: "github-actions"

Defined in: core/src/types.ts:245

Jsdoc

Jsdoc: "jsdoc"

Defined in: core/src/types.ts:246

Nx

Nx: "nx"

Defined in: core/src/types.ts:247

Pnpm

Pnpm: "pnpm"

Defined in: core/src/types.ts:248

Prettier

Prettier: "prettier"

Defined in: core/src/types.ts:249

Swagger

Swagger: "swagger"

Defined in: core/src/types.ts:250

Interfaces

DetectionOptions

Defined in: core/src/types.ts:256

Controls automatic project detection by category.

Properties

extensions?

optional extensions?: boolean

Defined in: core/src/types.ts:257

formats?

optional formats?: boolean

Defined in: core/src/types.ts:258

frameworks?

optional frameworks?: boolean

Defined in: core/src/types.ts:259

libraries?

optional libraries?: boolean

Defined in: core/src/types.ts:260

nextMode?

optional nextMode?: boolean

Defined in: core/src/types.ts:261

projects?

optional projects?: boolean

Defined in: core/src/types.ts:262

runtime?

optional runtime?: boolean

Defined in: core/src/types.ts:263

testing?

optional testing?: boolean

Defined in: core/src/types.ts:264

tools?

optional tools?: boolean

Defined in: core/src/types.ts:265

typescript?

optional typescript?: boolean

Defined in: core/src/types.ts:266

EslintConfigOptions

Defined in: core/src/types.ts:370

ESLint configuration interface

Properties

autoFrameworks?

optional autoFrameworks?: boolean

Defined in: core/src/types.ts:376

Enables bundled framework configs detected from dependencies. Disable this when you want manual framework control only.

detectedFrameworks?

optional detectedFrameworks?: DetectedFrameworkName[]

Defined in: core/src/types.ts:382

Frameworks detected from package.json by detectProjectOptions(). In v2, eslintConfig() enables these bundled framework configs by default.

detection?

optional detection?: boolean | DetectionOptions

Defined in: core/src/types.ts:388

Enables or disables automatic project detection by category. Use false to disable all detection, or an object for granular control.

detectRootDir?

optional detectRootDir?: string

Defined in: core/src/types.ts:394

Root directory used for automatic project detection. Defaults to process.cwd().

extensions?

optional extensions?: ExtensionOption[]

Defined in: core/src/types.ts:397

List of specialized ESLint rules and extensions

features?

optional features?: Partial<Record<OptionalConfigName, boolean>>

Defined in: core/src/types.ts:404

Simple optional-config switchboard. Enables or disables entries from extensions, formats, libraries, testing, and tools using their string names. integrations is an alias for the same map.

formats?

optional formats?: FormatOption[]

Defined in: core/src/types.ts:407

Additional non-JS/TS file formats to lint

frameworks?

optional frameworks?: object

Defined in: core/src/types.ts:416

Framework and library specific configurations.

Set a framework to true to use the bundled v2 config from @santi020k/eslint-config-basic, or pass a config array/factory when you need to override the bundled config.

angular?

optional angular?: ImportedFramework

astro?

optional astro?: ImportedFramework

expo?

optional expo?: ImportedFramework

hono?

optional hono?: ImportedFramework

lit?

optional lit?: ImportedFramework

nest?

optional nest?: ImportedFramework

next?

optional next?: ImportedFramework

nuxt?

optional nuxt?: ImportedFramework

preact?

optional preact?: ImportedFramework

qwik?

optional qwik?: ImportedFramework

react?

optional react?: ImportedFramework

react-router?

optional react-router?: ImportedFramework

New name for Remix projects on React Router v7+.

remix?

optional remix?: ImportedFramework

Deprecated

Remix merged into React Router v7 — use react-router instead.

slidev?

optional slidev?: ImportedFramework

solid?

optional solid?: ImportedFramework

svelte?

optional svelte?: ImportedFramework

tanstack-start?

optional tanstack-start?: ImportedFramework

TanStack Start (React/Solid full-stack framework).

vite?

optional vite?: ImportedFramework

vue?

optional vue?: ImportedFramework

ignores?

optional ignores?: string[]

Defined in: core/src/types.ts:450

Extra global ignore globs (flat config ignores only, no files). Patterns are relative to ESLint’s working directory, like a manual ignore block. Not merged from presets or detection. For projects entries, patterns are not auto-prefixed with the subproject path; use repo-root-relative globs when needed.

integrations?

optional integrations?: Partial<Record<OptionalConfigName, boolean>>

Defined in: core/src/types.ts:453

List of application-level dependencies configurations

libraries?

optional libraries?: LibraryOption[]

Defined in: core/src/types.ts:455

nextMode?

optional nextMode?: NextModeOption

Defined in: core/src/types.ts:458

Next.js specific routing mode

optionMergeStrategy?

optional optionMergeStrategy?: "merge" | "replace"

Defined in: core/src/types.ts:465

Controls how explicit arrays/frameworks combine with auto-detected and preset values.

merge (default): union detected + preset + explicit values
replace: explicit values fully replace detected/preset values

preset?

optional preset?: PresetOption

Defined in: core/src/types.ts:468

High-level configuration preset

projectDefaults?

optional projectDefaults?: ProjectConfigOptions

Defined in: core/src/types.ts:475

Defaults inherited by every entry in projects. Project-level values override scalar defaults while arrays and option maps merge unless that project uses optionMergeStrategy: 'replace'.

projects?

optional projects?: Record<string, ProjectConfigOptions>

Defined in: core/src/types.ts:481

Package-aware subproject configuration for monorepos. Each key is a workspace-relative folder and each value is scoped to that folder.

runtime?

optional runtime?: RuntimeOption

Defined in: core/src/types.ts:484

Runtime environment preset (Node, Browser, Universal)

settings?

optional settings?: SettingOption[]

Defined in: core/src/types.ts:487

List of global settings and behavioral flags

strict?

optional strict?: StrictMode

Defined in: core/src/types.ts:495

Severity profile.

false / recommended: keep recommended severities
true / ci: promote warnings to errors
pedantic: promote warnings and enable built-in best-practice rules

tailwind?

optional tailwind?: false | TailwindOptions

Defined in: core/src/types.ts:501

Tailwind CSS plugin options. Providing an object enables the Tailwind integration, while false disables auto-detected Tailwind support.

testing?

optional testing?: TestingOption[]

Defined in: core/src/types.ts:504

List of testing frameworks and testing environments

testingFiles?

optional testingFiles?: Partial<Record<"cypress" | "jest" | "jest-dom" | "playwright" | "testing-library" | "vitest", string[]>>

Defined in: core/src/types.ts:512

File globs for test integrations when the defaults do not match your project.

For example, set testingFiles.playwright to the folder that contains your Playwright specs when it differs from the built-in defaults.

tools?

optional tools?: ToolOption[]

Defined in: core/src/types.ts:515

List of integrations for external standalone tools

tsconfigRootDir?

optional tsconfigRootDir?: string

Defined in: core/src/types.ts:521

Root directory of the project. Required if multiple candidate TSConfigRootDirs are present.

typescript?

optional typescript?: boolean | TypeScriptMode | TypeScriptOptions

Defined in: core/src/types.ts:524

Enable TypeScript support with optional settings

workspacePrefixes?

optional workspacePrefixes?: string[]

Defined in: core/src/types.ts:537

Monorepo / workspace package scope prefixes that should sort in their own import group, before external npm packages.

Passed to createImportGroups and applied to simple-import-sort/imports automatically — no manual rule override needed.

Example

// Imports from @acme/* sort between internal app code and external npm packages
defineConfig({ workspacePrefixes: ['@acme'] })

ImportGroupOptions

Defined in: core/src/rules.ts:35

Options for createImportGroups.

Properties

workspacePrefixes?

optional workspacePrefixes?: string[]

Defined in: core/src/rules.ts:46

Workspace / monorepo package prefixes that should sort with internal code rather than external npm packages.

They are placed in their own group before the external npm packages group.

Example

// Treat @acme/ui, @acme/shared, etc. as internal
createImportGroups({ workspacePrefixes: ['@acme'] })

TailwindOptions

Defined in: core/src/types.ts:300

Properties

cwd?

optional cwd?: string

Defined in: core/src/types.ts:305

Working directory used to resolve Tailwind and its entry point. Defaults to detectRootDir, which keeps package-scoped monorepo configs stable.

detectComponentClasses?

optional detectComponentClasses?: boolean

Defined in: core/src/types.ts:306

entryPoint?

optional entryPoint?: string

Defined in: core/src/types.ts:307

ignore?

optional ignore?: string[]

Defined in: core/src/types.ts:308

noUnknownClasses?

optional noUnknownClasses?: false | "error" | "off" | "warn"

Defined in: core/src/types.ts:309

TypeScriptOptions

Defined in: core/src/types.ts:322

Properties

mode?

optional mode?: TypeScriptMode

Defined in: core/src/types.ts:323

project?

optional project?: string | boolean | string[]

Defined in: core/src/types.ts:324

projectService?

optional projectService?: boolean

Defined in: core/src/types.ts:325

tsconfigRootDir?

optional tsconfigRootDir?: string

Defined in: core/src/types.ts:326

Type Aliases

ConfigInput

ConfigInput = false | null | TSESLint.FlatConfig.Config | TSESLint.FlatConfig.ConfigArray | undefined

Defined in: core/src/config-helpers.ts:91

DetectedFrameworkName

DetectedFrameworkName = "angular" | "astro" | "expo" | "hono" | "lit" | "nest" | "next" | "nuxt" | "preact" | "qwik" | "react" | "react-router" | "remix" | "slidev" | "solid" | "svelte" | "tanstack-start" | "vite" | "vue"

Defined in: core/src/types.ts:346

Framework names that can be auto-detected by detectProjectOptions. These are informational only — you still need to import and pass the actual framework config via frameworks.<name> in eslintConfig().

ExtensionName

ExtensionName = `${Extension}`

Defined in: core/src/types.ts:268

ExtensionOption

ExtensionOption = Extension | ExtensionName

Defined in: core/src/types.ts:269

FlatConfigArray

FlatConfigArray = TSESLint.FlatConfig.ConfigArray

Defined in: core/src/types.ts:543

Type alias for ESLint flat config array

FormatName

FormatName = `${Format}`

Defined in: core/src/types.ts:270

FormatOption

FormatOption = Format | FormatName

Defined in: core/src/types.ts:271

ImportedFramework

ImportedFramework = ((options?) => FlatConfigArray | Promise<FlatConfigArray>) | FlatConfigArray | true | { default: ((options?) => FlatConfigArray | Promise<FlatConfigArray>) | FlatConfigArray; }

Defined in: core/src/types.ts:552

Type for framework option values: true enables the bundled v2 config, or pass a config array, a factory function (sync or async, like the lazy framework factories exported from @santi020k/eslint-config-basic), or an imported module with a default export. Any other value throws a descriptive TypeError (see resolveFramework in @santi020k/eslint-config-basic).

LibraryName

LibraryName = `${Library}`

Defined in: core/src/types.ts:272

LibraryOption

LibraryOption = Library | LibraryName

Defined in: core/src/types.ts:273

NextModeName

NextModeName = `${NextMode}`

Defined in: core/src/types.ts:274

NextModeOption

NextModeOption = NextMode | NextModeName

Defined in: core/src/types.ts:275

NormalizedStrictMode

NormalizedStrictMode = "ci" | "pedantic" | "recommended"

Defined in: core/src/compose.ts:5

OptionalBucket

OptionalBucket = "extensions" | "formats" | "libraries" | "testing" | "tools"

Defined in: core/src/config-helpers.ts:81

OptionalConfigMap

OptionalConfigMap = Partial<Record<OptionalConfigName, boolean>>

Defined in: core/src/types.ts:282

Simple opt-in/opt-out map for optional configs. Keys match the public enum string values, so both features: { zod: true } and libraries: [Library.Zod] resolve to the same underlying config.

OptionalConfigName

OptionalConfigName = ExtensionName | FormatName | LibraryName | TestingName | ToolName

Defined in: core/src/types.ts:283

PresetName

PresetName = `${Preset}`

Defined in: core/src/types.ts:289

PresetOption

PresetOption = Preset | PresetName

Defined in: core/src/types.ts:290

ProjectConfigOptions

ProjectConfigOptions = Omit<EslintConfigOptions, "projectDefaults" | "projects">

Defined in: core/src/types.ts:558

RuntimeName

RuntimeName = `${Runtime}`

Defined in: core/src/types.ts:291

RuntimeOption

RuntimeOption = Runtime | RuntimeName

Defined in: core/src/types.ts:292

SettingName

SettingName = `${Setting}`

Defined in: core/src/types.ts:293

SettingOption

SettingOption = Setting | SettingName

Defined in: core/src/types.ts:294

StrictMode

StrictMode = "ci" | "pedantic" | "recommended" | boolean

Defined in: core/src/types.ts:298

Severity profiles for teams adopting the config progressively.

TestingName

TestingName = `${Testing}`

Defined in: core/src/types.ts:312

TestingOption

TestingOption = Testing | TestingName

Defined in: core/src/types.ts:314

ToolName

ToolName = `${Tool}`

Defined in: core/src/types.ts:316

ToolOption

ToolOption = Tool | ToolName

Defined in: core/src/types.ts:318

TypeScriptMode

TypeScriptMode = "off" | "strict" | "syntax" | "type-aware"

Defined in: core/src/types.ts:320

Variables

__detectionInternals

const __detectionInternals: object

Defined in: core/src/utils/detection.ts:474

Internal detection helpers exposed for focused unit tests. Do not use these in application code.

Type Declaration

clearDetectionCache

clearDetectionCache: () => void

Returns

void

collectAllDependencies

collectAllDependencies: (pkg) => DependencyMap

Parameters

pkg

PackageJson

Returns

DependencyMap

createDefaultOptions

createDefaultOptions: () => EslintConfigOptions

Returns

EslintConfigOptions

createRuntimeSetter

createRuntimeSetter: (options) => (runtime) => void

Parameters

options

EslintConfigOptions

Returns

(runtime) => void

dedupe

dedupe: <T>(values) => T[]

Type Parameters

T

T

Parameters

values?

T[] = \[\]

Returns

T[]

detectExtensions

detectExtensions: (allDeps) => Extension[]

Parameters

allDeps

DependencyMap

Returns

Extension[]

detectFormats

detectFormats: (allDeps, detectRootDir) => Format[]

Parameters

allDeps

DependencyMap

detectRootDir

string

Returns

Format[]

detectFrameworks

detectFrameworks: (allDeps, detectRootDir, setRuntime) => DetectedFrameworkName[] | undefined

Parameters

allDeps

DependencyMap

detectRootDir

string

setRuntime

(runtime) => void

Returns

DetectedFrameworkName[] | undefined

detectLibraries

detectLibraries: (allDeps) => Library[]

Parameters

allDeps

DependencyMap

Returns

Library[]

detectNextMode

detectNextMode: (allDeps, detectRootDir) => NextMode | undefined

Parameters

allDeps

DependencyMap

detectRootDir

string

Returns

NextMode | undefined

detectProjects

detectProjects: (pkg, detectRootDir) => NonNullable<EslintConfigOptions["projects"]>

Parameters

pkg

PackageJson

detectRootDir

string

Returns

NonNullable<EslintConfigOptions["projects"]>

detectRuntime

detectRuntime: (allDeps, detectRootDir, _detectedFrameworks, setRuntime, frameworkHasSetRuntime) => void

Parameters

allDeps

DependencyMap

detectRootDir

string

_detectedFrameworks

DetectedFrameworkName[] | undefined

setRuntime

(runtime) => void

frameworkHasSetRuntime?

boolean = false

Returns

void

detectTesting

detectTesting: (allDeps) => Testing[]

Parameters

allDeps

DependencyMap

Returns

Testing[]

detectTools

detectTools: (allDeps, detectRootDir) => Tool[]

Parameters

allDeps

DependencyMap

detectRootDir

string

Returns

Tool[]

detectTypescript

detectTypescript: (detectRootDir) => boolean

Parameters

detectRootDir

string

Returns

boolean

parsePnpmWorkspacePatterns

parsePnpmWorkspacePatterns: (detectRootDir) => string[]

Parameters

detectRootDir

string

Returns

string[]

pathExists

pathExists: (path) => boolean

Parameters

path

string

Returns

boolean

resolvePreset

resolvePreset: (options) => Preset

Parameters

options

EslintConfigOptions

Returns

Preset

coreConfig

const coreConfig: TSESLint.FlatConfig.ConfigArray

Defined in: core/src/index.ts:164

Core JavaScript ESLint configuration (Universal runtime by default) This is included by default in all configurations

DEFAULT_IGNORES

const DEFAULT_IGNORES: string[]

Defined in: core/src/config-helpers.ts:22

GENERATED_CODE_IGNORES

const GENERATED_CODE_IGNORES: string[]

Defined in: core/src/config-helpers.ts:60

gitignore

const gitignore: TSESLint.FlatConfig.ConfigArray

Defined in: core/src/settings/gitignore.ts:13

GLOB_ASTRO

const GLOB_ASTRO: string[]

Defined in: core/src/types.ts:13

GLOB_JS

const GLOB_JS: string[]

Defined in: core/src/types.ts:6

Global file patterns for JavaScript-compatible files

GLOB_JS_TS

const GLOB_JS_TS: string[]

Defined in: core/src/types.ts:10

GLOB_JS_TS_ALL

const GLOB_JS_TS_ALL: string[]

Defined in: core/src/types.ts:15

GLOB_SLOT

const GLOB_SLOT: string[]

Defined in: core/src/types.ts:14

GLOB_SVELTE

const GLOB_SVELTE: string[]

Defined in: core/src/types.ts:12

GLOB_TS

const GLOB_TS: string[]

Defined in: core/src/types.ts:8

GLOB_VIRTUAL_TS

const GLOB_VIRTUAL_TS: string[]

Defined in: core/src/types.ts:17

GLOB_VUE

const GLOB_VUE: string[]

Defined in: core/src/types.ts:11

groups

const groups: string[][]

Defined in: core/src/rules.ts:144

Default import sort groups used by the core config. Export allows downstream packages and end users to reference or extend them.

OPTIONAL_BUCKETS

const OPTIONAL_BUCKETS: object

Defined in: core/src/config-helpers.ts:83

Type Declaration

extensions

readonly extensions: Extension[]

formats

readonly formats: Format[]

libraries

readonly libraries: Library[]

testing

readonly testing: Testing[]

tools

readonly tools: Tool[]

ReactConfigKeys

const ReactConfigKeys: readonly ["react", "next", "expo", "react-router", "remix"]

Defined in: core/src/types.ts:333

Array of configurations that require React Note: These are now used internally for auto-detection and globals

rules

const rules: TSESLint.Linter.RulesRecord

Defined in: core/src/rules.ts:148

TAILWIND_ENTRYPOINT_CANDIDATES

const TAILWIND_ENTRYPOINT_CANDIDATES: string[]

Defined in: core/src/config-helpers.ts:72

Functions

applyArrayControls()

applyArrayControls(controls, detected): object

Defined in: core/src/config-helpers.ts:284

Parameters

controls

Required<DetectionOptions>

detected

EslintConfigOptions

Returns

object

detectedFrameworks

detectedFrameworks: DetectedFrameworkName[] | undefined

extensions

extensions: ExtensionOption[] | undefined

formats

formats: FormatOption[] | undefined

libraries

libraries: LibraryOption[] | undefined

testing

testing: TestingOption[] | undefined

tools

tools: ToolOption[] | undefined

applyDetectionControls()

applyDetectionControls(detected, detection, defaults?): EslintConfigOptions

Defined in: core/src/config-helpers.ts:301

Parameters

detected

EslintConfigOptions

detection

boolean | DetectionOptions | undefined

defaults?

Partial<Required<DetectionOptions>>

Returns

EslintConfigOptions

applyFeatureDisables()

applyFeatureDisables<T>(values, options, bucket): T[]

Defined in: core/src/config-helpers.ts:137

Type Parameters

T

T extends string

Parameters

values

T[]

options

EslintConfigOptions | undefined

bucket

OptionalBucket

Returns

T[]

applyScalarControls()

applyScalarControls(controls, detected): object

Defined in: core/src/config-helpers.ts:293

Parameters

controls

Required<DetectionOptions>

detected

EslintConfigOptions

Returns

object

nextMode

nextMode: NextModeOption | undefined

preset

preset: PresetOption | undefined

projects

projects: Record<string, ProjectConfigOptions> | undefined

runtime

runtime: RuntimeOption | undefined

typescript

typescript: boolean | TypeScriptMode | TypeScriptOptions | undefined

applyStrictMode()

applyStrictMode(configs, strict): ConfigArray

Defined in: core/src/compose.ts:32

Applies strict mode by promoting all ‘warn’ rules to ‘error’.

Parameters

configs

ConfigArray

strict

boolean | NormalizedStrictMode | undefined

Returns

ConfigArray

applyStrictProfileDefaults()

applyStrictProfileDefaults(extensions, strict): Extension[]

Defined in: core/src/config-helpers.ts:316

Parameters

extensions

Extension[]

strict

StrictMode | undefined

Returns

Extension[]

createCoreConfig()

createCoreConfig(runtime?): ConfigArray

Defined in: core/src/index.ts:72

Creates the core config with the specified runtime globals

Parameters

runtime?

Runtime = Runtime.Universal

Returns

ConfigArray

createImportGroups()

createImportGroups(options?): string[][]

Defined in: core/src/rules.ts:70

Creates the groups array for simple-import-sort/imports.

Group ordering (each becomes its own import section):

Side effects — polyfills, reflect-metadata, zone.js
Node built-ins — node:fs and legacy fs
Framework virtual modules — Vite virtual:, Astro astro:, SvelteKit $app/$env/$lib, Nuxt #imports
Internal UI / presentation layer — components/, @/pages/, etc.
Internal application / logic layer — store/, @/hooks/, etc.
Style imports — .css, .scss, .sass, @/styles/theme.css, ./Button.module.css
Workspace packages (when workspacePrefixes is set) — @acme/shared
External npm packages — react, @tanstack/query
Remaining internal aliases — @/, ~/, #, custom extras
Parent-relative imports — ../
Same-directory relative imports — ./

Why internal layers and styles come before externals: Bare internal paths like components/Button and bare CSS like theme.css match ^@?\w. Placing these groups first ensures correct classification before falling through to the npm packages group.

Parameters

options?

ImportGroupOptions = {}

Returns

string[][]

createModuleLoader()

createModuleLoader(resolveFn): <T>(specifier) => Promise<T>

Defined in: core/src/lazy.ts:23

Parameters

resolveFn

(specifier) => string

Returns

<T>(specifier) => Promise<T>

detectProjectOptions()

detectProjectOptions(detectRootDir?): EslintConfigOptions

Defined in: core/src/utils/detection.ts:500

Automatically detects project settings based on package.json content

Parameters

detectRootDir?

string = ...

Root directory used for dependency/file detection (defaults to process.cwd())

Returns

EslintConfigOptions

Detected ESLint configuration options

findTailwindEntryPoint()

findTailwindEntryPoint(rootDir): string | undefined

Defined in: core/src/config-helpers.ts:361

Parameters

rootDir

string

Returns

string | undefined

flattenConfigInputs()

flattenConfigInputs(configs): ConfigArray

Defined in: core/src/config-helpers.ts:93

Parameters

configs

ConfigInput[]

Returns

ConfigArray

getFeatureEntries()

getFeatureEntries(options, bucket, enabled): string[]

Defined in: core/src/config-helpers.ts:126

Parameters

options

EslintConfigOptions | undefined

bucket

OptionalBucket

enabled

boolean

Returns

string[]

getGlobalsForRuntime()

getGlobalsForRuntime(runtime?): GlobalsConfig | undefined

Defined in: core/src/index.ts:22

Returns the appropriate globals for the given runtime option

Parameters

runtime?

Runtime = Runtime.Universal

Returns

GlobalsConfig | undefined

getStrictMode()

getStrictMode(explicitStrict, presetStrict): StrictMode | undefined

Defined in: core/src/config-helpers.ts:311

Parameters

explicitStrict

StrictMode | undefined

presetStrict

StrictMode | undefined

Returns

StrictMode | undefined

hasReactConfig()

hasReactConfig(options?): boolean

Defined in: core/src/utils/index.ts:9

Checks if the provided EslintConfigOptions includes any React-specific configurations.

Parameters

options?

EslintConfigOptions

ESLint configuration options.

Returns

boolean

True if any React configuration is detected, false otherwise.

hasTsconfig()

hasTsconfig(rootDir): boolean

Defined in: core/src/config-helpers.ts:325

Parameters

rootDir

string

Returns

boolean

isOptionalBucketValue()

isOptionalBucketValue(bucket, value): boolean

Defined in: core/src/config-helpers.ts:120

Parameters

bucket

OptionalBucket

value

string

Returns

boolean

loadModule()

loadModule<T>(specifier): Promise<T>

Defined in: core/src/lazy.ts:48

Type Parameters

T

T = unknown

Parameters

specifier

string

Returns

Promise<T>

mergeArrayOption()

mergeArrayOption<T>(detectedValues, presetValues, explicitValues, strategy): T[]

Defined in: core/src/config-helpers.ts:99

Type Parameters

T

T

Parameters

detectedValues

T[]

presetValues

T[] | undefined

explicitValues

T[] | undefined

strategy

"merge" | "replace"

Returns

T[]

mergeFrameworkOption()

mergeFrameworkOption(detectedFrameworks, presetFrameworks, explicitFrameworks, strategy): object

Defined in: core/src/config-helpers.ts:168

Parameters

detectedFrameworks

Record<string, ImportedFramework>

presetFrameworks

Record<string, ImportedFramework> | undefined

explicitFrameworks

Record<string, ImportedFramework> | undefined

strategy

"merge" | "replace"

Returns

angular?

optional angular?: ImportedFramework

astro?

optional astro?: ImportedFramework

expo?

optional expo?: ImportedFramework

hono?

optional hono?: ImportedFramework

lit?

optional lit?: ImportedFramework

nest?

optional nest?: ImportedFramework

next?

optional next?: ImportedFramework

nuxt?

optional nuxt?: ImportedFramework

preact?

optional preact?: ImportedFramework

qwik?

optional qwik?: ImportedFramework

react?

optional react?: ImportedFramework

react-router?

optional react-router?: ImportedFramework

New name for Remix projects on React Router v7+.

remix?

optional remix?: ImportedFramework

Deprecated

Remix merged into React Router v7 — use react-router instead.

slidev?

optional slidev?: ImportedFramework

solid?

optional solid?: ImportedFramework

svelte?

optional svelte?: ImportedFramework

tanstack-start?

optional tanstack-start?: ImportedFramework

TanStack Start (React/Solid full-stack framework).

vite?

optional vite?: ImportedFramework

vue?

optional vue?: ImportedFramework

mergeOptionalBucket()

mergeOptionalBucket<T>(bucket, detectedValues, presetValues, explicitValues, options, strategy): T[]

Defined in: core/src/config-helpers.ts:147

Type Parameters

T

T extends string

Parameters

bucket

OptionalBucket

detectedValues

T[]

presetValues

T[] | undefined

explicitValues

T[] | undefined

options

EslintConfigOptions | undefined

strategy

"merge" | "replace"

Returns

T[]

mergeProjectOptions()

mergeProjectOptions(defaults, project): ProjectConfigOptions

Defined in: core/src/config-helpers.ts:218

Applies shared monorepo defaults to one project configuration. Scalar values are overridden by the project, while arrays and option maps inherit and merge unless the project selects the replace strategy.

Parameters

normalizeStrictMode()

normalizeStrictMode(strict): NormalizedStrictMode

Defined in: core/src/compose.ts:7

Parameters

strict

boolean | NormalizedStrictMode | undefined

Returns

NormalizedStrictMode

patchImportGroups()

patchImportGroups(allConfigs, workspacePrefixes): ConfigArray

Defined in: core/src/config-helpers.ts:429

Parameters

allConfigs

ConfigArray

workspacePrefixes

string[]

Returns

ConfigArray

patchImportGroupsConfig()

patchImportGroupsConfig(config, workspacePatterns): Config

Defined in: core/src/config-helpers.ts:401

Parameters

config

Config

workspacePatterns

string[]

Returns

Config

resolveDetectionOptions()

resolveDetectionOptions(detection, defaults?): Required<DetectionOptions>

Defined in: core/src/config-helpers.ts:250

Parameters

detection

boolean | DetectionOptions | undefined

defaults?

Partial<Required<DetectionOptions>> = {}

Returns

Required<DetectionOptions>

resolveTsconfigRootDir()

resolveTsconfigRootDir(rootDir, typescript, explicitRootDir): string | undefined

Defined in: core/src/config-helpers.ts:351

Parameters

rootDir

string

typescript

boolean | TypeScriptMode | TypeScriptOptions | undefined

explicitRootDir

string | undefined

Returns

string | undefined

resolveTypescriptOptions()

resolveTypescriptOptions(typescript): false | TypeScriptOptions & object

Defined in: core/src/config-helpers.ts:334

Parameters

typescript

boolean | TypeScriptMode | TypeScriptOptions | undefined

Returns

false | TypeScriptOptions & object

scopeConfigToProject()

scopeConfigToProject(config, projectPath): Config

Defined in: core/src/config-helpers.ts:382

Parameters

config

Config

projectPath

string

Returns

Config

scopeFilePattern()

scopeFilePattern(projectPath, pattern): unknown

Defined in: core/src/config-helpers.ts:366

Parameters

projectPath

string

pattern

unknown

Returns

unknown

toUniqueArray()

toUniqueArray<T>(values): T[]

Defined in: core/src/config-helpers.ts:20

Type Parameters

T

T

Parameters

values

T[]

Returns

T[]

References

jsConfig

Renames and re-exports coreConfig

Did this page help?

One click helps us spot documentation that needs another pass. No personal data is sent.