eslint-walrus-config

Comprehensive ESLint configuration for TypeScript and React projects with code quality, import organization, and formatting rules.

Installation

npm install --save-dev eslint-walrus-config
# or
yarn add -D eslint-walrus-config

Usage

Basic Configuration (TypeScript only)

// eslint.config.js
import { configs } from "eslint-walrus-config";

export default [
  configs.ignores,
  ...configs.createMainConfig({
    rootDir: process.cwd(),
  }),
];

With React Support

// eslint.config.js
import { configs } from "eslint-walrus-config";

export default [
  configs.ignores,
  ...configs.createMainConfig({
    rootDir: process.cwd(),
    react: true, // Включает React правила и плагины
  }),
];

With Markdown Support

// eslint.config.js
import { configs } from "eslint-walrus-config";

export default [
  configs.ignores,
  ...configs.createMainConfig({
    rootDir: process.cwd(),
    react: true, // Опционально
  }),
  ...configs.createMarkdownConfig(),
];

Features

• ✅ TypeScript support with strict typing
• ✅ Optional React and React Hooks rules
• ✅ Import organization and sorting
• ✅ Architecture boundaries (eslint-plugin-boundaries)
• ✅ Code quality (SonarJS)
• ✅ Accessibility (jsx-a11y) - only with React
• ✅ Prettier integration
• ✅ Markdown linting
• ✅ Modern ESLint Flat Config format

Configuration

createMainConfig(options)

Creates the main ESLint configuration.

Options:

• rootDir (optional): root directory of the project
• include (optional): file patterns to include (default: ['**/*.{ts,tsx,mts,mjs,cjs,js,jsx}'])
• react (optional): include React rules and plugins (default: false)

createMarkdownConfig()

Creates configuration for linting Markdown files.

ignores

Pre-configured ignore patterns (node_modules, dist, build, etc.)

Included Plugins

Base Plugins (always included)

• @typescript-eslint
• @stylistic/eslint-plugin
• eslint-plugin-import
• eslint-plugin-boundaries
• eslint-plugin-sonarjs
• eslint-plugin-prettier
• @eslint/markdown
• eslint-plugin-simple-import-sort
• eslint-plugin-sort-keys-fix
• eslint-plugin-typescript-sort-keys

React Plugins (only with react: true)

• eslint-plugin-react
• eslint-plugin-react-hooks
• eslint-plugin-jsx-a11y

License

MIT © Andrey Pakhomov