Santi020k ESLint

Appearance

@santi020k/eslint-config-basic

basic/src ​

Enumerations ​

Extension ​

Defined in: core/dist/types.d.ts:54

Enum for specialized ESLint extensions and strict rule sets

Enumeration Members ​

Perfectionist ​

Perfectionist: "perfectionist"

Defined in: core/dist/types.d.ts:59

Regexp ​

Regexp: "regexp"

Defined in: core/dist/types.d.ts:55

Security ​

Security: "security"

Defined in: core/dist/types.d.ts:58

Sonarjs ​

Sonarjs: "sonarjs"

Defined in: core/dist/types.d.ts:57

Unicorn ​

Unicorn: "unicorn"

Defined in: core/dist/types.d.ts:56

Format ​

Defined in: core/dist/types.d.ts:34

Enum for linting non-JS/TS file formats

Enumeration Members ​

Graphql ​

Graphql: "graphql"

Defined in: core/dist/types.d.ts:40

Jsonc ​

Jsonc: "jsonc"

Defined in: core/dist/types.d.ts:37

Markdown ​

Markdown: "markdown"

Defined in: core/dist/types.d.ts:36

Mdx ​

Mdx: "mdx"

Defined in: core/dist/types.d.ts:35

Toml ​

Toml: "toml"

Defined in: core/dist/types.d.ts:39

Yaml ​

Yaml: "yaml"

Defined in: core/dist/types.d.ts:38

Library ​

Defined in: core/dist/types.d.ts:13

Enum for application-level runtime dependencies and styling

Enumeration Members ​

I18next ​

I18next: "i18next"

Defined in: core/dist/types.d.ts:15

Stencil ​

Stencil: "stencil"

Defined in: core/dist/types.d.ts:16

Storybook ​

Storybook: "storybook"

Defined in: core/dist/types.d.ts:19

Tailwind ​

Tailwind: "tailwind"

Defined in: core/dist/types.d.ts:14

TanstackQuery ​

TanstackQuery: "tanstack-query"

Defined in: core/dist/types.d.ts:17

TanstackRouter ​

TanstackRouter: "tanstack-router"

Defined in: core/dist/types.d.ts:18

NextMode ​

Defined in: core/dist/types.d.ts:6

Enum for Next.js mode options

Enumeration Members ​

AppRouter ​

AppRouter: "app-router"

Defined in: core/dist/types.d.ts:8

Pages ​

Pages: "pages"

Defined in: core/dist/types.d.ts:7

Preset ​

Defined in: core/dist/types.d.ts:82

Enum for named presets

Enumeration Members ​

All ​

All: "all"

Defined in: core/dist/types.d.ts:86

All configs + all optionals

Basic ​

Basic: "basic"

Defined in: core/dist/types.d.ts:84

Core JS config only

Browser ​

Browser: "browser"

Defined in: core/dist/types.d.ts:90

Core + TS + Browser runtime

Node ​

Node: "node"

Defined in: core/dist/types.d.ts:88

Core + TS + Node runtime

Runtime ​

Defined in: core/dist/types.d.ts:71

Enum for runtime environment presets

Enumeration Members ​

Browser ​

Browser: "browser"

Defined in: core/dist/types.d.ts:75

Only Browser globals (window, document, etc.)

Node ​

Node: "node"

Defined in: core/dist/types.d.ts:73

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

Universal ​

Universal: "universal"

Defined in: core/dist/types.d.ts:77

Both Node.js and Browser globals (default)

Setting ​

Defined in: core/dist/types.d.ts:64

Enum for settings options in ESLint

Enumeration Members ​

Gitignore ​

Gitignore: "gitignore"

Defined in: core/dist/types.d.ts:65

NoGitignore ​

NoGitignore: "no-gitignore"

Defined in: core/dist/types.d.ts:66

Testing ​

Defined in: core/dist/types.d.ts:24

Enum for testing frameworks and environments

Enumeration Members ​

Cypress ​

Cypress: "cypress"

Defined in: core/dist/types.d.ts:28

Jest ​

Jest: "jest"

Defined in: core/dist/types.d.ts:27

Playwright ​

Playwright: "playwright"

Defined in: core/dist/types.d.ts:26

TestingLibrary ​

TestingLibrary: "testing-library"

Defined in: core/dist/types.d.ts:29

Vitest ​

Vitest: "vitest"

Defined in: core/dist/types.d.ts:25

Tool ​

Defined in: core/dist/types.d.ts:45

Enum for integrating external standalone utilities

Enumeration Members ​

Cspell ​

Cspell: "cspell"

Defined in: core/dist/types.d.ts:47

Jsdoc ​

Jsdoc: "jsdoc"

Defined in: core/dist/types.d.ts:48

Prettier ​

Prettier: "prettier"

Defined in: core/dist/types.d.ts:46

Swagger ​

Swagger: "swagger"

Defined in: core/dist/types.d.ts:49

Interfaces ​

EslintConfigOptions ​

Defined in: core/dist/types.d.ts:114

ESLint configuration interface

Properties ​

extensions? ​

optional extensions?: Extension[]

Defined in: core/dist/types.d.ts:131

List of specialized ESLint rules and extensions

formats? ​

optional formats?: Format[]

Defined in: core/dist/types.d.ts:127

Additional non-JS/TS file formats to lint

frameworks? ​

optional frameworks?: object

Defined in: core/dist/types.d.ts:146

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/dist/types.d.ts:123

List of application-level dependencies configurations

nextMode? ​

optional nextMode?: NextMode

Defined in: core/dist/types.d.ts:141

Next.js specific routing mode

preset? ​

optional preset?: Preset

Defined in: core/dist/types.d.ts:139

High-level configuration preset

runtime? ​

optional runtime?: Runtime

Defined in: core/dist/types.d.ts:137

Runtime environment preset (Node, Browser, Universal)

settings? ​

optional settings?: Setting[]

Defined in: core/dist/types.d.ts:133

List of global settings and behavioral flags

strict? ​

optional strict?: boolean

Defined in: core/dist/types.d.ts:135

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

testing? ​

optional testing?: Testing[]

Defined in: core/dist/types.d.ts:125

List of testing frameworks and testing environments

tools? ​

optional tools?: Tool[]

Defined in: core/dist/types.d.ts:129

List of integrations for external standalone tools

tsconfigRootDir? ​

optional tsconfigRootDir?: string

Defined in: core/dist/types.d.ts:119

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

typescript? ​

optional typescript?: boolean | TsOptions

Defined in: core/dist/types.d.ts:121

Enable TypeScript support with optional settings

Type Aliases ​

FlatConfigArray ​

FlatConfigArray = TSESLint.FlatConfig.ConfigArray

Defined in: core/dist/types.d.ts:161

Type alias for ESLint flat config array

ImportedFramework ​

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

Defined in: core/dist/types.d.ts:102

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/dist/index.d.ts:23

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

createCoreConfig ​

const createCoreConfig: (runtime?) => TSESLint.FlatConfig.ConfigArray

Defined in: core/dist/index.d.ts:18

Creates the core config with the specified runtime globals

Parameters ​

runtime? ​

Runtime

Returns ​

TSESLint.FlatConfig.ConfigArray

cspell ​

const cspell: TSESLint.FlatConfig.ConfigArray

Defined in: optionals/dist/index.d.ts:7

CSpell ESLint configuration Enables spell checking in your codebase

cypress ​

const cypress: TSESLint.FlatConfig.ConfigArray

Defined in: optionals/dist/index.d.ts:82

Cypress ESLint configuration Provides linting rules for Cypress end-to-end test files

detectProjectOptions ​

const detectProjectOptions: (cwd?) => EslintConfigOptions

Defined in: core/dist/utils/index.d.ts:9

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 ​

const getGlobalsForRuntime: (runtime?) => TSESLint.FlatConfig.LanguageOptions["globals"]

Defined in: core/dist/index.d.ts:14

Returns the appropriate globals for the given runtime option

Parameters ​

runtime? ​

Runtime

Returns ​

TSESLint.FlatConfig.LanguageOptions["globals"]

gitignore ​

const gitignore: TSESLint.FlatConfig.ConfigArray

Defined in: core/dist/index.d.ts:9

graphql ​

const graphql: TSESLint.FlatConfig.ConfigArray

Defined in: optionals/dist/index.d.ts:124

GraphQL ESLint configuration Provides linting rules for GraphQL schema and operations

hasReactConfig ​

const hasReactConfig: (options?) => boolean

Defined in: core/dist/utils/index.d.ts:17

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.

i18next ​

const i18next: TSESLint.FlatConfig.ConfigArray

Defined in: optionals/dist/index.d.ts:31

i18next ESLint configuration Enables i18next plugin for internationalization best practices

jest ​

const jest: TSESLint.FlatConfig.ConfigArray

Defined in: optionals/dist/index.d.ts:76

Jest ESLint configuration Provides linting rules for Jest test files

jsdoc ​

const jsdoc: TSESLint.FlatConfig.ConfigArray

Defined in: optionals/dist/index.d.ts:13

JSDoc ESLint configuration Provides rules for TSDoc/JSDoc validation and formatting.

jsonc ​

const jsonc: TSESLint.FlatConfig.ConfigArray

Defined in: optionals/dist/index.d.ts:106

JSON/JSONC ESLint configuration Provides rules for JSON file linting and package.json key sorting

markdown ​

const markdown: TSESLint.FlatConfig.ConfigArray

Defined in: optionals/dist/index.d.ts:100

Markdown ESLint configuration Lints markdown files for common issues

mdx ​

const mdx: TSESLint.FlatConfig.ConfigArray

Defined in: optionals/dist/index.d.ts:94

MDX ESLint configuration Lints MDX files with proper code block handling

perfectionist ​

const perfectionist: TSESLint.FlatConfig.ConfigArray

Defined in: optionals/dist/index.d.ts:151

Perfectionist ESLint configuration Provides rules for sorting and organizing code (imports, exports, object keys, etc.)

playwright ​

const playwright: TSESLint.FlatConfig.ConfigArray

Defined in: optionals/dist/index.d.ts:70

Playwright ESLint configuration Provides linting rules for Playwright end-to-end test files

prettier ​

const prettier: TSESLint.FlatConfig.ConfigArray

Defined in: optionals/dist/index.d.ts:19

Prettier interop configuration Disables all ESLint rules that conflict with Prettier formatting

ReactConfigKeys ​

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

Defined in: core/dist/types.d.ts:96

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

regexp ​

const regexp: TSESLint.FlatConfig.ConfigArray

Defined in: optionals/dist/index.d.ts:137

RegExp ESLint configuration Catches common regex mistakes like exponential backtracking, unnecessary escapes, and optimizable character classes

security ​

const security: TSESLint.FlatConfig.ConfigArray

Defined in: optionals/dist/index.d.ts:145

Security ESLint configuration Provides rules for catching common security vulnerabilities.

sonarjs ​

const sonarjs: TSESLint.FlatConfig.ConfigArray

Defined in: optionals/dist/index.d.ts:139

stencil ​

const stencil: TSESLint.FlatConfig.ConfigArray

Defined in: optionals/dist/index.d.ts:37

Stencil ESLint configuration Enforces best practices for Stencil.js components

storybook ​

const storybook: TSESLint.FlatConfig.ConfigArray

Defined in: optionals/dist/index.d.ts:58

Storybook ESLint configuration Provides rules for Storybook story best practices

swagger ​

const swagger: TSESLint.FlatConfig.ConfigArray

Defined in: optionals/dist/index.d.ts:25

Swagger/NestJS documentation ESLint configuration Provides rules from the nestjs-typed plugin for Swagger decorator validation

tailwind ​

const tailwind: TSESLint.FlatConfig.ConfigArray

Defined in: optionals/dist/index.d.ts:43

Tailwind CSS ESLint configuration Enforces Tailwind CSS best practices using eslint-plugin-better-tailwindcss

tanstackQuery ​

const tanstackQuery: TSESLint.FlatConfig.ConfigArray

Defined in: optionals/dist/index.d.ts:48

TanStack Query ESLint configuration

tanstackRouter ​

const tanstackRouter: TSESLint.FlatConfig.ConfigArray

Defined in: optionals/dist/index.d.ts:52

TanStack Router ESLint configuration

testingLibrary ​

const testingLibrary: TSESLint.FlatConfig.ConfigArray

Defined in: optionals/dist/index.d.ts:88

Testing Library ESLint configuration Provides linting rules for Testing Library usage in tests

toml ​

const toml: TSESLint.FlatConfig.ConfigArray

Defined in: optionals/dist/index.d.ts:118

TOML ESLint configuration Provides rules for TOML file linting

typescriptConfig ​

const typescriptConfig: tsEslint.FlatConfig.ConfigArray

Defined in: typescript/dist/index.d.ts:13

unicorn ​

const unicorn: TSESLint.FlatConfig.ConfigArray

Defined in: optionals/dist/index.d.ts:130

Unicorn ESLint configuration Modern JavaScript best practices from eslint-plugin-unicorn

vitest ​

const vitest: TSESLint.FlatConfig.ConfigArray

Defined in: optionals/dist/index.d.ts:64

Vitest ESLint configuration Provides linting rules for Vitest test files with best practices

yaml ​

const yaml: TSESLint.FlatConfig.ConfigArray

Defined in: optionals/dist/index.d.ts:112

YAML ESLint configuration Provides rules for YAML file linting

Functions ​

eslintConfig() ​

eslintConfig(options?): ConfigArray

Defined in: basic/src/index.ts:84

Generates the ESLint configuration array, applying configurations and optional settings based on the input configuration.

Parameters ​

options? ​

EslintConfigOptions

Configuration and optional settings

Returns ​

ConfigArray

The final ESLint configuration array

References ​

jsConfig ​

Renames and re-exports coreConfig

tsConfig ​

Renames and re-exports typescriptConfig

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

MIT Licensed