mirror of
https://gitlab.com/soapbox-pub/mkstack.git
synced 2025-08-27 21:19:23 +00:00
Custom ESLint Rules
This directory contains custom ESLint rules for the project.
no-placeholder-comments
This rule detects and flags comments that start with "// In a real" (case-insensitive). These comments typically indicate placeholder implementations that should be replaced with real code.
Examples
❌ Bad - These will trigger the rule:
// In a real application, this would connect to a database
const data = [];
// in a real world scenario, this would be different
const config = {};
/* In a real implementation, we would handle errors */
const handleError = () => {};
✅ Good - These are fine:
// This is a regular comment
const data = [];
// TODO: Implement database connection
const config = {};
// Note: In a real application, consider using a database
const handleError = () => {};
Configuration
The rule is configured in eslint.config.js
as:
"custom/no-placeholder-comments": "error"
You can change the severity level to:
"off"
- Disable the rule"warn"
- Show as warning"error"
- Show as error (current setting)
Purpose
This rule helps ensure that placeholder comments used during development are replaced with actual implementations before code is committed or deployed to production.