cahaselereslint-plugin-vibe-check
ESLint rules to provide warnings and guardrails for AI coding assistance
Installation
npm install eslint-plugin-vibe-check --save-devRequirements
- Node.js >=20.8.1
- ESLint >=8.0.0
Compatibility
This plugin supports both:
- ESLint Flat Config (modern format using
eslint.config.js) - Legacy ESLint Config (traditional format using
.eslintrc.*files)
Usage
Traditional Config (.eslintrc)
Add vibe-check to the plugins section of your .eslintrc configuration file:
{
"plugins": ["vibe-check"]
}Then configure the rules you want to use:
{
"rules": {
"vibe-check/max-file-lines": ["warn", { "max": 300 }]
}
}Or use one of the provided configurations:
{
"extends": ["plugin:vibe-check/recommended"]
}For stricter enforcement (all rules as errors):
{
"extends": ["plugin:vibe-check/strict"]
}Flat Config (eslint.config.js)
For ESLint's new flat config format:
import vibeCheck from 'eslint-plugin-vibe-check/eslint.config.js';
export default [
// Your other configs...
vibeCheck,
// Or configure individually:
{
plugins: {
'vibe-check': vibeCheck.plugins['vibe-check']
},
rules: {
'vibe-check/max-file-lines': ['warn', { max: 300 }]
}
}
];For stricter enforcement (all rules as errors):
import vibeCheckStrict from 'eslint-plugin-vibe-check/eslint.config.strict.js';
export default [
// Your other configs...
vibeCheckStrict
];Or you can use the flat configuration directly:
import vibeCheckPlugin from 'eslint-plugin-vibe-check';
export default [
{
plugins: {
'vibe-check': vibeCheckPlugin
},
rules: {
'vibe-check/max-file-lines': 'warn',
'vibe-check/no-placeholder-comments': 'warn',
'vibe-check/no-hardcoded-credentials': 'warn',
'vibe-check/no-changelog-comments': 'warn',
'vibe-check/never-assume': 'error'
}
}
];Or use one of the predefined configurations:
import vibeCheckPlugin from 'eslint-plugin-vibe-check';
export default [
{
plugins: {
'vibe-check': vibeCheckPlugin
},
extends: ['plugin:vibe-check/recommended'] // or 'plugin:vibe-check/strict'
}
];Rules
max-file-lines
Warns when a file exceeds a configurable maximum number of lines (default: 300).
Options
max: The maximum number of lines allowed in a file (default: 300)
Example
{
"rules": {
"vibe-check/max-file-lines": ["warn", { "max": 250 }]
}
}no-placeholder-comments
Catches placeholder comments indicating shortcuts or unimplemented features (e.g., "in a real app", "TODO: make secure").
no-hardcoded-credentials
Detects hardcoded API keys, tokens, passwords, and other sensitive credentials.
no-changelog-comments
Flags comments containing changelog-like terms such as "added", "updated", "fixed", "changed", etc., that often appear when AI tools explain their changes in comments. This rule is fixable - the VSCode quick fix feature (lightbulb) or ESLint's --fix option will automatically remove these comments.
never-assume
Detects comments containing forms of the word "assume" (such as "assume", "assuming", "assumed", etc.) and flags them as errors. Making assumptions about a codebase can lead to errors and bugs. Instead of making assumptions, developers should check and validate their understanding before making decisions.
Contributing
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature) - Run tests to ensure they pass:
npm test - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
Using Claude Autofix
You can also request Claude to automatically fix issues:
- Create a new issue describing the bug or enhancement
- Add the
claude-fixlabel to the issue - The Claude Autofix workflow will attempt to fix the issue automatically
- If successful, a new pull request will be created with the fix
For more details, see the Claude Autofix documentation.
Release Process
This project uses semantic-release for automated versioning and releases:
- When changes are merged to the
mainbranch, semantic-release analyzes commit messages - Version numbers are automatically determined based on semantic commit messages
fix:- Patch release (1.0.0 -> 1.0.1)feat:- Minor release (1.0.0 -> 1.1.0)feat!:,fix!:,refactor!:, etc. - Major release (1.0.0 -> 2.0.0)
- CHANGELOG.md is automatically updated with release notes
- A GitHub release is created with the same notes
- The package is published to npm automatically
To contribute changes that will be released:
- Make your changes following the Conventional Commits specification
- Create a PR and merge it to the
mainbranch - The GitHub Actions workflow will handle releasing and publishing automatically