style: fix all JSDoc lint warnings and enforce zero-warning policy#317
Merged
takaokouji merged 1 commit intodevelopfrom Mar 16, 2026
Merged
style: fix all JSDoc lint warnings and enforce zero-warning policy#317takaokouji merged 1 commit intodevelopfrom
takaokouji merged 1 commit intodevelopfrom
Conversation
Fix 23 JSDoc warnings across 11 files in scratch-gui: - Add missing @param and @returns declarations - Remove @param that doesn't match function signature - Escape inline JSDoc tags (@ruby → `@ruby`, @A → `@a`) - Fix type casing (Object → object) - Add missing JSDoc comments for exported functions - Remove extra blank line after block description Enforce --max-warnings 0 in scratch-gui's lint script so warnings are treated as errors in both local development and CI. Update CLAUDE.md and .claude/rules/code-style.md to document the zero-warning lint policy. Closes #316 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
🚀 Preview deployed: https://smalruby.jp/smalruby3-editor/style/fix-lint-warnings/ |
github-actions bot
pushed a commit
that referenced
this pull request
Mar 16, 2026
…t-warnings style: fix all JSDoc lint warnings and enforce zero-warning policy
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
1 participant
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.
Summary
--max-warnings 0in scratch-gui's lint script so warnings are treated as errors.claude/rules/code-style.mdto document the zero-warning lint policyChanges Made
JSDoc fixes (11 source files)
@paramand@returnsdeclarations@paramthat doesn't match function signature (ruby-downloader.jsx)@ruby→`@ruby`,@a→`@a`)Object→object)face_sensing.js)module-sync.js)Lint enforcement
packages/scratch-gui/package.json:"lint": "eslint"→"lint": "eslint --max-warnings 0"Documentation
CLAUDE.md: Add note about zero-warning policy.claude/rules/code-style.md: Document that warnings (including JSDoc) must be fixed before committingImplementation Steps
--max-warnings 0in scratch-gui lint scriptDefinition of Done
Closes #316