4.1.1 • Published 1 month ago

eslint-config-vladpuz

Licence

MIT

Version

4.1.1

Deps

Vulns

Weekly

Stars

Summary Dependency Versions

eslint-config-vladpuz

My ESLint config

Features:

Supports JavaScript, TypeScript, mixed codebases and framework-agnostic JSX (pure base for use with any framework!)
Auto fix for formatting via eslint-stylistic (targeted for use without Prettier)
Does not conflict with TypeScript regardless of tsconfig.json options (TypeScript fully replaces some rules)
Supports .gitignore by default
Ability to customize your own stylistic preferences
Does not use other pre-configured setups, all rules are manually reviewed (except stylistic, uses a custom preset)
No warn severity, only error

Principles:

Safety
Consistency
Minimal for readability
Stability for diff

If you need React, use eslint-config-vladpuz-react.

Installation

npm install --save-dev eslint eslint-config-vladpuz

Usage

Create a file eslint.config.js:

import vladpuz from 'eslint-config-vladpuz'

export default vladpuz()

If you want to use Prettier for formatting other file types (json, md, html, css, ...), disable Prettier for JavaScript and TypeScript files. For this, create a file .prettierignore:

# javascript
*.js
*.jsx
*.mjs
*.cjs

# typescript
*.ts
*.tsx
*.mts
*.cts

Run ESLint in check mode:

eslint .

Run ESLint in fix mode:

eslint --fix .

Options

Overview:

interface Options {
  filesJs?: string[] // Default - ['**/*.js', '**/*.jsx', '**/*.mjs', '**/*.cjs']
  filesTs?: string[] // Default - ['**/*.ts', '**/*.tsx', '**/*.mts', '**/*.cts']
  env?: Array<keyof typeof globals> // Default - ['builtin', 'node', 'browser']
  gitignore?: boolean | GitignoreOptions // Default - true
  typescript?: boolean | ParserOptions // Default - true
  stylistic?: boolean | StylisticOptions // Default - true
  jsx?: boolean // Default - true
}

filesJs, filesTs

Type: string[]

Default for js: ['**/*.js', '**/*.jsx', '**/*.mjs', '**/*.cjs']

Default for ts: ['**/*.ts', '**/*.tsx', '**/*.mts', '**/*.cts']

Override patterns for js and ts files:

import vladpuz, { FILES_JS, FILES_TS } from 'eslint-config-vladpuz'

// For example any additional extensions
export default vladpuz({
  filesJs: [...FILES_JS, '**/*.extension'],
  filesTs: [...FILES_TS, '**/*.extension'],
})

env

Type: string[]

Default: ['builtin', 'node', 'browser']

Overrides environments providing predefined global variables:

import vladpuz from 'eslint-config-vladpuz'

export default vladpuz({
  env: ['node'], // For example only node
})

gitignore

Type: boolean | GitignoreOptions

Default: true

Enables/disables support for .gitignore or configures its search options.

import vladpuz from 'eslint-config-vladpuz'

export default vladpuz({
  // Default gitignore config is:
  gitignore: {
    strict: false,
  },
  // You can disable gitignore:
  // gitignore: false,
})

typescript

Type: boolean | ParserOptions

Default: true

Enables/disables TypeScript or customizes its parser options.

import vladpuz from 'eslint-config-vladpuz'

export default vladpuz({
  // Default typescript config is:
  typescript: {
    projectService: true,
  },
  // You can disable typescript:
  // typescript: false,
})

stylistic

Type: boolean | StylisticOptions

Default: true

Enables/disables Stylistic or configures your own stylistic preferences:

import vladpuz from 'eslint-config-vladpuz'

export default vladpuz({
  // Default stylistic config is:
  stylistic: {
    indent: 2,
    quotes: 'single',
    semi: false,
  },
  // You can disable stylistic:
  // stylistic: false,
})

jsx

Type: boolean

Default: true

Enables/disables JSX:

import vladpuz from 'eslint-config-vladpuz'

export default vladpuz({
  jsx: false,
})

Additional

errorify(target)

Converts severity of rules warn/1 to error/2.

target (Linter.Config[] | Linter.Config | Linter.RulesRecord)

Return: Linter.Config[] | Linter.Config | Linter.RulesRecord

Intended for adding external configs while preserving the overall severity style (without warn):

import vladpuz, { errorify } from 'eslint-config-vladpuz'
import x from 'eslint-plugin-x'

export default [...vladpuz(), errorify(x.configs.recommended)]

getCompilerOptions(parserOptions?, force?)

Gets compiler options from tsconfig.json.

parserOptions (ParserOptions = {}) - Parser options for searching tsconfig.json.
force (boolean = false) - Disables cache.

Return: CompilerOptions

Intended for dynamic management of rules depending on compiler options from tsconfig.json:

import { getCompilerOptions } from 'eslint-config-vladpuz'

const compilerOptions = getCompilerOptions()

console.log(compilerOptions.strict)
console.log(compilerOptions.noEmit)

testPluginConfig(pluginName, pluginRules, config, recommendedRules?)

Tests plugin config via node:test.

pluginName (string | null) - Plugin name.
pluginRules (Record<string, Rule.RuleModule>) - Plugin rules.
config (Linter.Config) - Tested config.
recommendedRules (Partial<Linter.RulesRecord> = {}) - Preset of recommended plugin rules. It will throw an error if at least one recommended rule is disabled in the tested configuration.

Return: void

Intended for testing plugin configs inside eslint-config-vladpuz and extended configs (e.g. eslint-config-vladpuz-react/src/configs.test.ts):

import { testPluginConfig } from 'eslint-config-vladpuz'
import unicorn from 'eslint-plugin-unicorn'

testPluginConfig(
  'unicorn',
  unicorn.rules ?? {},
  {
    name: 'vladpuz/unicorn',
    plugins: {
      unicorn,
    },
    rules: {
      // ...
    },
  },
  unicorn.configs.unopinionated.rules ?? {},
)

FAQ

Versioning Policy

This project follows Semantic Versioning. However, since this is just a configuration requiring opinions and many changeable components, we don't consider rule changes critical.

Keywords

eslint eslintconfig typescript