@santi020k/eslint-config-basic

---

core/src

Enumerations

Extension

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

Enum for specialized ESLint extensions and strict rule sets

Enumeration Members

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:122

Enum for named presets

Enumeration Members

All

All: "all"

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

All configs + all optionals

Basic

Basic: "basic"

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

Core JS config only

Browser

Browser: "browser"

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

Core + TS + Browser runtime

Node

Node: "node"

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

Core + TS + Node runtime

---

Runtime

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

Enum for runtime environment presets

Enumeration Members

Browser

Browser: "browser"

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

Only Browser globals (window, document, etc.)

Node

Node: "node"

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

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

Universal

Universal: "universal"

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

Both Node.js and Browser globals (default)

---

Setting

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

Enum for settings options in ESLint

Enumeration Members

Gitignore

Gitignore: "gitignore"

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

NoGitignore

NoGitignore: "no-gitignore"

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

---

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:169

ESLint configuration interface

Properties

extensions?

optional extensions?: Extension[]

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

List of specialized ESLint rules and extensions

formats?

optional formats?: Format[]

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

Additional non-JS/TS file formats to lint

frameworks?

optional frameworks?: object

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

Framework and library specific configurations. If a value is provided, its rules and globals are automatically enabled.

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:181

List of application-level dependencies configurations

nextMode?

optional nextMode?: NextMode

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

Next.js specific routing mode

preset?

optional preset?: Preset

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

High-level configuration preset

runtime?

optional runtime?: Runtime

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

Runtime environment preset (Node, Browser, Universal)

settings?

optional settings?: Setting[]

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

List of global settings and behavioral flags

strict?

optional strict?: boolean

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

If true, all 'warn' rules are promoted to 'error'

testing?

optional testing?: Testing[]

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

List of testing frameworks and testing environments

tools?

optional tools?: Tool[]

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

List of integrations for external standalone tools

tsconfigRootDir?

optional tsconfigRootDir?: string

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

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

typescript?

optional typescript?: boolean | TsOptions

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

Enable TypeScript support with optional settings

---

TsOptions

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

TypeScript configuration options

Properties

project?

optional project?: string | boolean | string[]

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

Type Aliases

FlatConfigArray

FlatConfigArray = TSESLint.FlatConfig.ConfigArray

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

Type alias for ESLint flat config array

---

ImportedFramework

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

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

Type to handle both direct config arrays and imported modules with a default export. A boolean flag may appear in detected project options, but user-facing framework options should pass imported config arrays/modules explicitly.

Variables

coreConfig

const coreConfig: TSESLint.FlatConfig.ConfigArray

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

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

---

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:3

---

ReactConfigKeys

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

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

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:35

Functions

createCoreConfig()

createCoreConfig(runtime?): ConfigArray

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

Creates the core config with the specified runtime globals

Parameters

runtime?

Runtime = Runtime.Universal

Returns

ConfigArray

---

detectProjectOptions()

detectProjectOptions(cwd?): EslintConfigOptions

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

Automatically detects project settings based on package.json content

Parameters

cwd?

string = ...

Current working directory (defaults to process.cwd())

Returns

EslintConfigOptions

Detected ESLint configuration options

---

getGlobalsForRuntime()

getGlobalsForRuntime(runtime?): GlobalsConfig | undefined

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

Returns the appropriate globals for the given runtime option

Parameters

runtime?

Runtime = Runtime.Universal

Returns

GlobalsConfig | 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.

References

jsConfig

Renames and re-exports coreConfig