Overview

medhira-eslint-rules is an ESLint plugin that ships focused, production-ready rules for JSX and TypeScript codebases. It works with ESLint flat config (v9+) and legacy .eslintrc setups.

Features

| | | |---|---| | 🛡️ | Purpose-built rules — enforce real-world best practices | | 📘 | TypeScript ready — built with @typescript-eslint/utils | | ⚛️ | JSX-aware — detects commented-out JSX in block comments | | 🔧 | Configurable — per-rule options with schema validation | | 📦 | Minimal footprint — only compiled lib/ ships to npm |

Quick Start

npm install medhira-eslint-rules eslint @typescript-eslint/parser --save-dev

// eslint.config.js
import medhira from 'medhira-eslint-rules';

export default [
  {
    plugins: { 'medhira-eslint-rules': medhira },
    rules: {
      'medhira-eslint-rules/no-commented-jsx': 'error',
    },
  },
];

Or use the bundled recommended config:

import medhira from 'medhira-eslint-rules';

export default [
  {
    plugins: { 'medhira-eslint-rules': medhira },
    ...medhira.configs['flat/recommended'],
  },
];

Rules

| Rule | Description | Config | |------|-------------|--------| | no-commented-jsx | Disallow commented-out JSX inside {/* ... */} block comments | { ignorePattern?: string } |

Architecture

flowchart TB
    subgraph Consumer["Your project"]
        ESLint["ESLint"]
        Config["eslint.config.js"]
    end

    subgraph Plugin["medhira-eslint-rules"]
        Entry["lib/index.js"]
        Rules["rules"]
        Configs["configs.recommended"]
    end

    Config --> ESLint
    ESLint --> Entry
    Entry --> Rules
    Entry --> Configs
    Rules --> NoCommentedJsx["no-commented-jsx"]

sequenceDiagram
    participant ESLint
    participant Rule as no-commented-jsx
    participant AST as JSXEmptyExpression

    ESLint->>Rule: create(context)
    ESLint->>AST: traverse JSX tree
    AST->>Rule: visit JSXEmptyExpression
    Rule->>Rule: scan comments for JSX tags
    alt JSX found and not ignored
        Rule->>ESLint: report violation
    end

Requirements

| Dependency | Version | |------------|---------| | Node.js | ≥ 18 | | ESLint | ≥ 8.40.0 | | @typescript-eslint/parser | ^8.0.0 (required for JSX/TS files) |

Documentation

Full documentation is available at medhira-eslint-rules.readthedocs.io.

• Installation
• Quick Start
• Architecture

Contributing

Contributions are welcome! See Contributing Guide for setup and PR guidelines.

git clone https://github.com/HELLOMEDHIRA/medhira-eslint-rules.git
cd medhira-eslint-rules
npm install
npm test && npm run lint && npm run build

Sponsor & Support

To keep this library maintained and up-to-date, please consider sponsoring on GitHub.

For private support or customization, reach out at [email protected].

About MEDHIRA

MEDHIRA — Engineering Intelligence Across Everything

• Website: medhira.readthedocs.io
• GitHub: github.com/HELLOMEDHIRA
• Email: [email protected]

License

Apache-2.0