Santi020k ESLint

Appearance

@santi020k/eslint-config-basic

core/src ​

Enumerations ​

Extension ​

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

Enum for specialized ESLint extensions and strict rule sets

Enumeration Members ​

Perfectionist ​

Perfectionist: "perfectionist"

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

Regexp ​

Regexp: "regexp"

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

Security ​

Security: "security"

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

Sonarjs ​

Sonarjs: "sonarjs"

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

Unicorn ​

Unicorn: "unicorn"

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

Format ​

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

Enum for linting non-JS/TS file formats

Enumeration Members ​

Graphql ​

Graphql: "graphql"

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

Jsonc ​

Jsonc: "jsonc"

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

Markdown ​

Markdown: "markdown"

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

Mdx ​

Mdx: "mdx"

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

Toml ​

Toml: "toml"

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

Yaml ​

Yaml: "yaml"

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

Library ​

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

Enum for application-level runtime dependencies and styling

Enumeration Members ​

I18next ​

I18next: "i18next"

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

Stencil ​

Stencil: "stencil"

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

Storybook ​

Storybook: "storybook"

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

Tailwind ​

Tailwind: "tailwind"

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

TanstackQuery ​

TanstackQuery: "tanstack-query"

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

TanstackRouter ​

TanstackRouter: "tanstack-router"

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

NextMode ​

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

Enum for Next.js mode options

Enumeration Members ​

AppRouter ​

AppRouter: "app-router"

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

Pages ​

Pages: "pages"

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

Preset ​

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

Enum for named presets

Enumeration Members ​

All ​

All: "all"

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

All configs + all optionals

Basic ​

Basic: "basic"

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

Core JS config only

Browser ​

Browser: "browser"

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

Core + TS + Browser runtime

Node ​

Node: "node"

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

Core + TS + Node runtime

Runtime ​

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

Enum for runtime environment presets

Enumeration Members ​

Browser ​

Browser: "browser"

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

Only Browser globals (window, document, etc.)

Node ​

Node: "node"

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

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

Universal ​

Universal: "universal"

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

Both Node.js and Browser globals (default)

Setting ​

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

Enum for settings options in ESLint

Enumeration Members ​

Gitignore ​

Gitignore: "gitignore"

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

NoGitignore ​

NoGitignore: "no-gitignore"

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

Testing ​

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

Enum for testing frameworks and environments

Enumeration Members ​

Cypress ​

Cypress: "cypress"

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

Jest ​

Jest: "jest"

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

Playwright ​

Playwright: "playwright"

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

TestingLibrary ​

TestingLibrary: "testing-library"

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

Vitest ​

Vitest: "vitest"

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

Tool ​

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

Enum for integrating external standalone utilities

Enumeration Members ​

Cspell ​

Cspell: "cspell"

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

Jsdoc ​

Jsdoc: "jsdoc"

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

Prettier ​

Prettier: "prettier"

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

Swagger ​

Swagger: "swagger"

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

Interfaces ​

EslintConfigOptions ​

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

ESLint configuration interface

Properties ​

extensions? ​

optional extensions?: Extension[]

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

List of specialized ESLint rules and extensions

formats? ​

optional formats?: Format[]

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

Additional non-JS/TS file formats to lint

frameworks? ​

optional frameworks?: object

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

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

react? ​

optional react?: ImportedFramework

solid? ​

optional solid?: ImportedFramework

svelte? ​

optional svelte?: ImportedFramework

vue? ​

optional vue?: ImportedFramework

libraries? ​

optional libraries?: Library[]

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

List of application-level dependencies configurations

nextMode? ​

optional nextMode?: NextMode

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

Next.js specific routing mode

preset? ​

optional preset?: Preset

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

High-level configuration preset

runtime? ​

optional runtime?: Runtime

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

Runtime environment preset (Node, Browser, Universal)

settings? ​

optional settings?: Setting[]

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

List of global settings and behavioral flags

strict? ​

optional strict?: boolean

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

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

testing? ​

optional testing?: Testing[]

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

List of testing frameworks and testing environments

tools? ​

optional tools?: Tool[]

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

List of integrations for external standalone tools

tsconfigRootDir? ​

optional tsconfigRootDir?: string

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

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

typescript? ​

optional typescript?: boolean | TsOptions

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

Enable TypeScript support with optional settings

TsOptions ​

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

TypeScript configuration options

Properties ​

project? ​

optional project?: string | boolean | string[]

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

Type Aliases ​

FlatConfigArray ​

FlatConfigArray = TSESLint.FlatConfig.ConfigArray

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

Type alias for ESLint flat config array

ImportedFramework ​

ImportedFramework = FlatConfigArray | { default: FlatConfigArray; } | boolean

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

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

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

groups ​

const groups: string[][]

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

ReactConfigKeys ​

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

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

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

rules ​

const rules: TSESLint.FlatConfig.Rules

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

Functions ​

createCoreConfig() ​

createCoreConfig(runtime?): ConfigArray

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

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

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

Built by Santi020k. Repo and personal site linked throughout the docs.

MIT Licensed