@zokugun/eslint-config-glossary

This package registers two word lists for ESLint: preserved acronyms like API and TypeScript, and minor words like a, the, and. ESLint should keep acronyms intact while allowing common words to be ignored by spelling-focused rules in your project configuration.

Installation

npm add @zokugun/eslint-config-glossary

Requirements

• Node.js: v18.20 or higher
• Modules: ECMAScript Modules (ESM) or CommonJS (CJS)

Quick Start

import { configure, gitignore, ignores } from '@zokugun/eslint-config';
import { glossary } from '@zokugun/eslint-config-glossary';
import { markdown } from '@zokugun/eslint-config-md';

export default configure([
	ignores(),
	gitignore(),
	glossary(),
	markdown(), // The `markdown` configurator is using the glossary to configure the `markdown` rules.
]);

API Reference

function glossary(options: {
    minorWords?: string[];
    preserveWords?: string[];
    overrides?: {
        minorWords?: string[];
        preserveWords?: 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.