chore: Enforce Minimal Code Comments - #2630
Conversation
🎩 PreviewA preview build has been created at: |
morgan-wowk
left a comment
morgan-wowk
left a comment
There was a problem hiding this comment.
🤖 Agent review. Verified no functional directive comments were removed anywhere (no eslint-disable/@ts-*/pragmas/etc.), the one doc value change (MIN_DOCKED_HEIGHT 100→50 in WINDOWS.md) is a correct fix vs the actual constant, and the branch passes pnpm run lint. One cross-PR concern (inline).
| ignores: ["src/components/ui/**"], | ||
| plugins: { local: localRules }, | ||
| rules: { | ||
| "local/no-type-member-comments": "error", |
There was a problem hiding this comment.
🤖 This registers no-type-member-comments at error repo-wide over src (minus ui/). This PR's own tree is clean, but any other in-flight branch that still has a JSDoc/block comment inside an interface or object-type body will start failing the lint CI job after this merges — a silent tax on rebase, not just future contributions. Consider announcing to open-PR owners, or landing as warn first then flipping to error. Minor: the rule also fires on inline object-type literals (TSTypeLiteral), where the 'rename the field' message doesn't quite fit.
2 participants
Description
Claude has been bloating our codebase with spammy code comments for far too long. This PR aims to reign in the AI and assert dominance!
Hopefully after this we will get much less long-winded and pointless code comments. Updated directives to the AI aim to remove the JSDoc standard and reduce self-explanatory code comments. The PR also does an initial high-level sweep and cleans up a few places as a proof of concept.
This should make our code more concise and readable in the long term.
Related Issue and Pull requests
Type of Change
Checklist
Screenshots (if applicable)
Test Instructions
Additional Comments