@zokugun/eslint-config

This package streamlines ESLint configuration by providing helper functions for ignores, gitignore integration, and dynamic value resolution based on project settings.

Features

• Easy Configuration: Pass a list of functions to generate a complete ESLint config.
• Flexible Configs: Supports both function-based and object-based configs.
• Functional Composition: Chain multiple configurators to build a complex final config.
• Context Resolution: Store and share values across configurator functions.
• EditorConfig Integration: Pull formatting rules from .editorconfig files.
• Git Integration: Returns a configurator that adds ignores from .gitignore.

Installation

npm add @zokugun/eslint-config

Quick Start

import { configure, gitignore, ignores } from '@zokugun/eslint-config';
import { javascript, regexp } from '@zokugun/eslint-config-js';
import { nodejs } from '@zokugun/eslint-config-nodejs';
import { importX, perfectionist, stylistic } from '@zokugun/eslint-config-style';
import { typescript } from '@zokugun/eslint-config-ts';

export default configure([
	ignores(),
	gitignore(),
	nodejs(),
	stylistic(),
	javascript(),
	typescript(),
	importX(),
	perfectionist(),
	regexp(),
]);

API reference

function configure(configurators: Array<Configurator | Linter.Config>, options?: { cwd?: string } | null): Linter.Config[];
function gitignore(): Configurator;
function ignores(...files: string[]): 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.