Skip to content

Repository files navigation

License: MIT NPM Version NodeJS Version Modules Ko-fi Liberapay PayPal

A collection ready-to-use ESLint configurations for JSON, JSONC, and YAML. Customize files, ignores and rules per project. Integrates EditorConfig to match your coding style.

Features

  • Efficient Setup: Quick-start configurations 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-data

Requirements

  • ESLint: v10 or higher
  • Node.js: v20.19 or higher
  • Modules: ECMAScript Modules (ESM)

Quick Start

import { configure, gitignore, ignores } from '@zokugun/eslint-config';
import { json, jsonc, yaml } from '@zokugun/eslint-config-data';

export default configure([
	ignores(),
	gitignore(),
	json(),
	jsonc(),
	yaml(),
]);

API reference

function json(options?: OptionRules<JsonRuleOptions> & OptionFiles & OptionIgnores & OptionOverridesFiles & OptionOverridesIgnores): Configurator;
function jsonc(options?: OptionRules<JsoncRuleOptions> & OptionFiles & OptionIgnores & OptionOverridesFiles & OptionOverridesIgnores): Configurator;
function yaml(options?: OptionRules<YamlRuleOptions> & OptionFiles & OptionIgnores & OptionOverridesFiles & OptionOverridesIgnores): 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.

Ko-fi ko-fi.com/daiyam
Liberapay liberapay.com/daiyam/donate
PayPal paypal.me/daiyam99

License

Copyright © 2026-present Baptiste Augrain

Licensed under the MIT license.

About

No description, website, or topics provided.

Resources

Code of conduct

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages