lint-message

To write effective ESLint error messages, structure them as What's wrong, Why it matters, and How to fix. This educates developers on underlying principles, prevents specific bugs, and provides clear, actionable remediation steps.

ESLint rule messages should include the problem explanation, the underlying principle or bug risk, and specific remediation instructions. This transforms linting errors into teaching moments, promoting consistent code quality and faster onboarding for junior developers.

Yes, you can use template variables in ESLint rule messages to provide context-specific information. This allows you to dynamically insert relevant code details into the What's wrong, Why it matters, and How to fix structure for clearer guidance.

The best way to structure linting error messages for AI agents is using a What's wrong, Why it matters, and How to fix template. This clear structure ensures both AI agents and junior developers can understand the issue and apply corrective actions consistently.

Custom ESLint rule messages often fail because they lack the Why it matters and How to fix context. Without explaining the underlying principle and offering actionable remediation steps, errors become blockers rather than educational opportunities for developers.

Yes, lint-message supports best practices for explaining why an ESLint rule exists by emphasizing the underlying principle and specific bug prevention. It guides you to include the educational context that makes the error message a learning opportunity.