Install comment policy rules for AI code editors (Cursor, Windsurf, Copilot, Codex, Cline, and 30+ more)
npm install comment-rules
> Install comment policy rules for AI code editors and agents.
Ever been frustrated by code filled with more comments than actual functionality—random emojis everywhere 🚀✅❌, excessive step-by-step explanations, or distracting notes?
Meet comment-rules: a CLI tool to enforce strict comment policies for AI code editors and assistants—eliminate clutter, remove unnecessary comments, and keep only high-quality JSDoc.
This package provides two rules:
1. jsdoc-over-inline-comments (always apply) - Prefer JSDoc over inline comments
2. manual-cleanup-comments (on-demand) - Clean up existing comments
Run directly with npx (no install required):
``bash`
npx comment-rules
Or install globally:
`bash`
npm install -g comment-rules
`bash`
npx comment-rules
Features:
- Use Up/Down arrows to navigate
- Press Space to toggle selection
- Press A to select all, N to select none
- Press Enter to confirm
`bashCursor (installs to current directory)
npx comment-rules cursor
$3
bash
Install only manual-cleanup-comments rule
npx comment-rules cursor --rule manualInstall both rules
npx comment-rules cursor --rule all
`$3
Use
or -g flag to install rules to your home directory:`bash
Cursor (installs to ~/)
npx comment-rules cursor --globalAll editors globally
npx comment-rules --all -g
`$3
bash
Project scope (current directory)
npx comment-rules --allGlobal scope (home directory)
npx comment-rules --all --global
`$3
bash
npx comment-rules --list
`$3
| Option | Description |
| --------------- | ------------------------------------------------------ |
|
| Install to home directory instead of current directory |
| -a, --all | Install for all supported editors |
| -l, --list | List all supported editors |
| -h, --help | Show help message |
| --rule | Select rule: jsdoc, manual, or all |Supported Editors/Agents (30+)
| Editor | Config File |
| -------------- | -------------------------------------------------- |
| Aider |
CONVENTIONS.md |
| Antigravity | .agent/rules/jsdoc-over-inline-comments.md |
| Claude Code | CLAUDE.md |
| Cline | .clinerules |
| CodeBuddy | .codebuddy/rules/jsdoc-over-inline-comments.md |
| Codex | AGENTS.md |
| Command Code | .commandcode/rules/jsdoc-over-inline-comments.md |
| Continue | .continue/rules/jsdoc-over-inline-comments.md |
| Crush | .crush/rules/jsdoc-over-inline-comments.md |
| Cursor | .cursor/rules/jsdoc-over-inline-comments.mdc |
| Droid | .droid/rules/jsdoc-over-inline-comments.md |
| Gemini CLI | GEMINI.md |
| GitHub Copilot | .github/copilot-instructions.md |
| Goose | .goose/rules/jsdoc-over-inline-comments.md |
| Junie | .junie/rules/jsdoc-over-inline-comments.md |
| Kilo Code | .kilocode/rules/jsdoc-over-inline-comments.md |
| Kiro CLI | .kiro/rules/jsdoc-over-inline-comments.md |
| Kode | .kode/rules/jsdoc-over-inline-comments.md |
| MCPJam | .mcpjam/rules/jsdoc-over-inline-comments.md |
| Moltbot | .moltbot/rules/jsdoc-over-inline-comments.md |
| Mux | .mux/rules/jsdoc-over-inline-comments.md |
| Neovate | .neovate/rules/jsdoc-over-inline-comments.md |
| OpenCode | .opencode/rules/jsdoc-over-inline-comments.md |
| OpenHands | .openhands/rules/jsdoc-over-inline-comments.md |
| Pi | .pi/rules/jsdoc-over-inline-comments.md |
| Pochi | .pochi/rules/jsdoc-over-inline-comments.md |
| Qoder | .qoder/rules/jsdoc-over-inline-comments.md |
| Qwen Code | .qwencode/rules/jsdoc-over-inline-comments.md |
| Roo Code | .roo/rules/jsdoc-over-inline-comments.md |
| Trae | .trae/rules/jsdoc-over-inline-comments.md |
| Windsurf | .windsurfrules |
| Zed | .zed/rules/jsdoc-over-inline-comments.md |
| Zencoder | .zencoder/rules/jsdoc-over-inline-comments.md |Manual Installation
If you prefer not to use npx, you can manually copy the rule content to your editor's config file.
$3
These agents use a single markdown file in your project root:
| Agent | File | Command |
| ----------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------- |
| Claude Code |
CLAUDE.md | curl -o CLAUDE.md https://raw.githubusercontent.com/khoidh24/comment-rules/master/jsdoc-over-inline-comments.mdc |
| Gemini CLI | GEMINI.md | curl -o GEMINI.md https://raw.githubusercontent.com/khoidh24/comment-rules/master/jsdoc-over-inline-comments.mdc |
| Codex | AGENTS.md | curl -o AGENTS.md https://raw.githubusercontent.com/khoidh24/comment-rules/master/jsdoc-over-inline-comments.mdc |
| Aider | CONVENTIONS.md | curl -o CONVENTIONS.md https://raw.githubusercontent.com/khoidh24/comment-rules/master/jsdoc-over-inline-comments.mdc |$3
These editors use a rules directory:
Cursor:
`bash
mkdir -p .cursor/rules
curl -o .cursor/rules/jsdoc-over-inline-comments.mdc https://raw.githubusercontent.com/khoidh24/comment-rules/master/jsdoc-over-inline-comments.mdc
`Windsurf:
bash
curl -o .windsurfrules https://raw.githubusercontent.com/khoidh24/comment-rules/master/jsdoc-over-inline-comments.mdc
`GitHub Copilot:
bash
mkdir -p .github
curl -o .github/copilot-instructions.md https://raw.githubusercontent.com/khoidh24/comment-rules/master/jsdoc-over-inline-comments.mdc
`Cline:
bash
curl -o .clinerules https://raw.githubusercontent.com/khoidh24/comment-rules/master/jsdoc-over-inline-comments.mdc
`Roo Code:
bash
mkdir -p .roo/rules
curl -o .roo/rules/jsdoc-over-inline-comments.md https://raw.githubusercontent.com/khoidh24/comment-rules/master/jsdoc-over-inline-comments.mdc
`Continue:
bash
mkdir -p .continue/rules
curl -o .continue/rules/jsdoc-over-inline-comments.md https://raw.githubusercontent.com/khoidh24/comment-rules/master/jsdoc-over-inline-comments.mdc
`$3
To install globally, use
prefix:`bash
Cursor (global)
mkdir -p ~/.cursor/rules
curl -o ~/.cursor/rules/jsdoc-over-inline-comments.mdc https://raw.githubusercontent.com/khoidh24/comment-rules/master/jsdoc-over-inline-comments.mdcClaude Code (global)
curl -o ~/CLAUDE.md https://raw.githubusercontent.com/khoidh24/comment-rules/master/jsdoc-over-inline-comments.mdc
`$3
powershell
Cursor
New-Item -ItemType Directory -Force -Path .cursor\rules
Invoke-WebRequest -Uri "https://raw.githubusercontent.com/khoidh24/comment-rules/master/jsdoc-over-inline-comments.mdc" -OutFile ".cursor\rules\jsdoc-over-inline-comments.mdc"Claude Code
Invoke-WebRequest -Uri "https://raw.githubusercontent.com/khoidh24/comment-rules/master/jsdoc-over-inline-comments.mdc" -OutFile "CLAUDE.md"
`The Rule
$3
- DO NOT add inline or line-by-line comments
- Prefer clear naming + small functions over comments
- Write JSDoc for exported functions/classes and public methods
$3
- Purpose (1 sentence)
-
for each parameter
- @returns (or void)
- Important constraints$3
`ts
/**
* Normalizes a user-provided phone number into E.164-like format.
* @param input - Raw phone number string from UI.
* @param defaultCountry - ISO country code used when input has no prefix.
* @returns Normalized string or null if invalid.
*/
export function normalizePhone(
input: string,
defaultCountry: string
): string | null {
// implementation...
}
`$3
ts
// get user
const user = await getUser(id);
// update user
user.name = name;
// save user
await saveUser(user);
`Contributing
Pull requests welcome! If you want to add support for a new editor, edit
and add the editor config to the EDITORS` object.MIT