core/src

@santi020k/eslint-config-basic

Enumerations

Extension

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

Enum for specialized ESLint extensions and strict rule sets

Enumeration Members

BestPractices

BestPractices: "best-practices"

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

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

Perfectionist

Perfectionist: "perfectionist"

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

Regexp

Regexp: "regexp"

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

Security

Security: "security"

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

Sonarjs

Sonarjs: "sonarjs"

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

Unicorn

Unicorn: "unicorn"

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

Format

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

Enum for linting non-JS/TS file formats

Enumeration Members

Graphql

Graphql: "graphql"

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

Jsonc

Jsonc: "jsonc"

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

Markdown

Markdown: "markdown"

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

Mdx

Mdx: "mdx"

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

Toml

Toml: "toml"

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

Yaml

Yaml: "yaml"

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

Library

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

Enum for application-level runtime dependencies and styling

Enumeration Members

I18next

I18next: "i18next"

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

Stencil

Stencil: "stencil"

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

Storybook

Storybook: "storybook"

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

Tailwind

Tailwind: "tailwind"

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

TanstackQuery

TanstackQuery: "tanstack-query"

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

TanstackRouter

TanstackRouter: "tanstack-router"

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

NextMode

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

Enum for Next.js mode options

Enumeration Members

AppRouter

AppRouter: "app-router"

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

Pages

Pages: "pages"

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

Preset

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

Enum for named presets

Enumeration Members

All

All: "all"

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

All configs + all optionals

Basic

Basic: "basic"

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

Core JS config only

Browser

Browser: "browser"

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

Core + TS + Browser runtime

Node

Node: "node"

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

Core + TS + Node runtime

Runtime

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

Enum for runtime environment presets

Enumeration Members

Browser

Browser: "browser"

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

Only Browser globals (window, document, etc.)

Node

Node: "node"

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

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

Universal

Universal: "universal"

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

Both Node.js and Browser globals (default)

Setting

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

Enum for settings options in ESLint

Enumeration Members

Gitignore

Gitignore: "gitignore"

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

NoGitignore

NoGitignore: "no-gitignore"

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

Testing

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

Enum for testing frameworks and environments

Enumeration Members

Cypress

Cypress: "cypress"

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

Jest

Jest: "jest"

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

Playwright

Playwright: "playwright"

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

TestingLibrary

TestingLibrary: "testing-library"

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

Vitest

Vitest: "vitest"

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

Tool

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

Enum for integrating external standalone utilities

Enumeration Members

Cspell

Cspell: "cspell"

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

Jsdoc

Jsdoc: "jsdoc"

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

Prettier

Prettier: "prettier"

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

Swagger

Swagger: "swagger"

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

Interfaces

EslintConfigOptions

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

ESLint configuration interface

Properties

detectedFrameworks?

optional detectedFrameworks?: DetectedFrameworkName[]

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

Frameworks detected from package.json by detectProjectOptions(). This is informational — use it to display what was auto-detected. To actually enable framework linting you still need to import the framework package and pass it via frameworks.<name>.

extensions?

optional extensions?: Extension[]

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

List of specialized ESLint rules and extensions

formats?

optional formats?: Format[]

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

Additional non-JS/TS file formats to lint

frameworks?

optional frameworks?: object

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

Framework and library specific configurations. Each value must be the imported config from the corresponding @santi020k/eslint-config-<framework> package — boolean values are not accepted.

angular?

optional angular?: ImportedFramework

astro?

optional astro?: ImportedFramework

expo?

optional expo?: ImportedFramework

nest?

optional nest?: ImportedFramework

next?

optional next?: ImportedFramework

qwik?

optional qwik?: ImportedFramework

react?

optional react?: ImportedFramework

remix?

optional remix?: ImportedFramework

solid?

optional solid?: ImportedFramework

svelte?

optional svelte?: ImportedFramework

vue?

optional vue?: ImportedFramework

libraries?

optional libraries?: Library[]

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

List of application-level dependencies configurations

nextMode?

optional nextMode?: NextMode

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

Next.js specific routing mode

preset?

optional preset?: Preset

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

High-level configuration preset

runtime?

optional runtime?: Runtime

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

Runtime environment preset (Node, Browser, Universal)

settings?

optional settings?: Setting[]

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

List of global settings and behavioral flags

strict?

optional strict?: boolean

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

If true, all ‘warn’ rules are promoted to ‘error’

testing?

optional testing?: Testing[]

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

List of testing frameworks and testing environments

tools?

optional tools?: Tool[]

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

List of integrations for external standalone tools

tsconfigRootDir?

optional tsconfigRootDir?: string

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

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

typescript?

optional typescript?: boolean | TsOptions

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

Enable TypeScript support with optional settings

TsOptions

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

TypeScript configuration options

Properties

project?

optional project?: string | boolean | string[]

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

Type Aliases

DetectedFrameworkName

DetectedFrameworkName = "react" | "next" | "astro" | "expo" | "vue" | "svelte" | "solid" | "angular" | "nest" | "qwik" | "remix"

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

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().

FlatConfigArray

FlatConfigArray = TSESLint.FlatConfig.ConfigArray

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

Type alias for ESLint flat config array

ImportedFramework

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

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

Type to handle both direct config arrays and imported modules with a default export. User-facing framework options should always pass imported config arrays/modules explicitly — boolean values are not accepted and will throw a descriptive error.