@zokugun/eslint-config-ts
v0.3.2
Published
ESLint configurations for TypeScript with EditorConfig support.
Readme
@zokugun/eslint-config-ts
A ready-to-use ESLint configuration for TypeScript. Customize files, ignores and rules per project. Integrates EditorConfig to match your coding style.
Features
- Efficient Setup: Quick-start configuration that require minimal boilerplate.
- Flexible Configuration: Easily override default file globs, ignores, or specific rule configurations.
- EditorConfig Integration: Automatically adjusts the coding style based on your project's EditorConfig file.
- Type Safety: Fully typed configuration options via TypeScript for better developer experience.
Installation
npm add @zokugun/eslint-config-tsRequirements
- ESLint:
v10or higher - Node.js:
v20.19or higher - Modules: ECMAScript Modules (
ESM)
Quick Start
import { configure, gitignore, ignores } from '@zokugun/eslint-config';
import { typescript } from '@zokugun/eslint-config-ts';
export default configure([
ignores(),
gitignore(),
typescript(),
]);API reference
type OptionsParserOptions = {
parserOptions?: Partial<ParserOptions>;
filesTypeAware?: string[];
ignoresTypeAware?: string[];
};
type OptionsComponentExts = {
componentExts?: string[];
};
type OptionsTsConfig = {
tsconfigPath?: string;
overridesTypeAware?: CommonsRuleOptions | TypeScriptRuleOptions;
};
function typescript(options?: OptionRules<CommonsRuleOptions | TypeScriptRuleOptions> & OptionFiles & OptionIgnores & OptionOverridesFiles & OptionOverridesIgnores & OptionsComponentExts & OptionsParserOptions & OptionsTsConfig): Configurator;Contributions
Contributions are most welcome. Please:
- Open issues and feature requests under the repository discussions.
- Follow the
CONTRIBUTING.md.
Donations
Support this project by becoming a financial contributor.
License
Copyright © 2026-present Baptiste Augrain
Licensed under the MIT license.
