Repository navigation
Remove code comments and fail lint on new ones - #2
Merged
Merged
Conversation
Every comment in src, tests, index.html and vite.config.ts is gone. Where a comment carried meaning, it became a name (GameMs/RealMs types, LineCounts, substitutionCost, named play-test runs) or a unit test. npm run lint runs scripts/no-comments.mjs, which uses the TypeScript parser for scripts and small scanners for CSS and HTML. Vitest covers the rule and the game logic. A GitHub Actions workflow runs lint, typecheck and unit tests. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Code comments in t3type drifted and repeated what the code said. Now there are none, and
npm run lintfails if one comes back. If code needs explaining, it gets a clearer name or a test.scripts/no-comments.mjsfinds comments in TS, TSX, JS, CSS and HTML, including inline<script>and<style>. It uses the TypeScript parser, so//inside strings, regexes and JSX text is not flagged.GameMsandRealMstypes,LineCounts,substitutionCost, named play-test runs) or vitest tests (typo alignment, WPM math, thread draws, the lint rule itself).Proof: lint, build and 24 vitest tests pass. The Playwright play test passes all 25 checks. New lint tests fail on the first version of the scanner.
Reviewed with sol-loop: 2 rounds with gpt-6.1-sol. Sol verdict: approved
Created with Claude Opus 5.5 in Claude Code.
🤖 Generated with Claude Code