@darkobits/eslint-config
v5.0.0
Published
ESLint configuration presets for TypeScript projects.
Downloads
64
Readme
ESLint configuration presets for TypeScript and TypeScript + React projects.
Requirements
- ESLint
>=9.0.0. - Your project must be using ESLint's new flat configuration format.
Install
npm install --save-dev @darkobits/eslint-configUse
This package provides two presets: ts for TypeScript
projects and tsx for TypeScript projects that use
JSX and React.
If you do not need to modify the preset in any way, simply re-export the desired configuration preset:
eslint.config.ts
export { configs } from '@darkobits/eslint-config'
export default configs.ts
// Or
export default.configs.tsxIf you need to extend a preset, the defineConfig helper should be used:
eslint.config.ts
import { configs } from '@darkobits/eslint-config'
import { defineConfig } from 'eslint/config'
export default defineConfig({
// Any global ignores should be defined early in a separate config object.
ignores: []
}, {
extends: [configs.ts],
rules: {
// ...
}
})See:
Additional Utilities
This package's configuration presets automatically ignore patterns in the first
.gitignore file found at or above the directory where tsconfig.json is
located. If you need to specify additional ignore files, this package re-exports
the includeIgnoreFile and convertIgnorePatternToMinimatch utilities from
@eslint/compat:
eslint.config.ts
import { configs, includeIgnoreFile } from '@darkobits/eslint-config'
import { defineConfig } from 'eslint/config'
export default defineConfig({
ignores: [includeIgnoreFile('path/to/.ignore-file')]
}, {
extends: [configs.ts],
rules: {
// ...
}
})Configuration Inspector
You can use ESLint's new Configuration Inspector to see an exhaustive list of all rules (and their settings) applied in your project by running the following:
npx eslint --inspect-config