Skip to content

chore: fix jsdoc lint warnings and split merged .gitignore pattern - #15

Merged
tmack8001 merged 1 commit into
mainfrom
chore/lint-jsdoc-gitignore
Oct 27, 2026
Merged

tmack8001 merged 1 commit into
mainfrom
chore/lint-jsdoc-gitignore

Conversation

@tmack8001

Copy link
Copy Markdown
Owner

Description

Small, behaviour-free cleanup split out of the BAP Best of Show work so that PR stays focused.

Type of Change

  • Code refactoring (lint/comment only, no behaviour change)

Changes Made

  • Add the missing @param result.data / @param result.header entries for destructured parameters (competitions.ts x2, bcoem-parser.test.ts).
  • Give @throws a type (bcoem-results.ts, fetch.test.ts).
  • Drop stray asterisks in a doc comment (bcoem-dates.ts).
  • .gitignore had *.tgz*.tsbuildinfo on one line, so neither *.tgz nor *.tsbuildinfo was actually ignored (tsconfig.tsbuildinfo showed as untracked after a build). Split into two patterns.

eslint (after npm run build): 19 warnings -> 11, 0 errors. The 11 left are 2 complexity and 9 max-nested-callbacks warnings, deliberately not touched here since they need refactoring rather than lint fixes.

Platform(s) Affected

  • Core functionality

Testing

  • Existing tests pass (npm test): 557 passing

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • My changes generate no new warnings

Documentation

No docs/CHANGELOG change needed (no user-visible behaviour).


Generated by Claude Code

- add the missing @PARAM result.data / result.header entries for destructured
  parameters, give @throws a type, drop stray asterisks in a doc comment
- .gitignore had '*.tgz*.tsbuildinfo' on one line, so neither *.tgz nor
  *.tsbuildinfo was ignored; split into two patterns

eslint: 19 warnings -> 11 (the remaining are 2 complexity and 9 nested-callback
warnings, left alone as they need refactoring, not lint fixes).

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_012GP39ZPN7EzLLdoKcJkGD4
@tmack8001
tmack8001 merged commit d2c7aeb into main Oct 27, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants