Skip to content

Comments

Expand API docs to include Logger class (#11)#42

Merged
yentsun merged 2 commits intomasterfrom
claude/review-github-issues-HcgXe
Jan 21, 2026
Merged

Expand API docs to include Logger class (#11)#42
yentsun merged 2 commits intomasterfrom
claude/review-github-issues-HcgXe

Conversation

@yentsun
Copy link
Owner

@yentsun yentsun commented Jan 21, 2026

  • Update docs script to include lib/Logger.js
  • Add logger module to docs template (docs_template.hbs)
  • Remove @Private tag from Logger class to expose it in docs
  • Add @Private tag to Service class (internal use only)
  • Regenerate docs.md with complete Logger documentation

The docs.md file now includes:

  • Logger constructor with all options
  • All logging methods (debug, info, warn, error)
  • setCustomTag method for adding contextual identifiers

Resolves #11

- Update docs script to include lib/Logger.js
- Add logger module to docs template (docs_template.hbs)
- Remove @Private tag from Logger class to expose it in docs
- Add @Private tag to Service class (internal use only)
- Regenerate docs.md with complete Logger documentation

The docs.md file now includes:
- Logger constructor with all options
- All logging methods (debug, info, warn, error)
- setCustomTag method for adding contextual identifiers

Resolves #11
Resolved conflicts:
- package.json: Combined updated test script (node --test) from master with updated docs script (includes lib/Logger.js) from our branch

New changes from master:
- Migrated to Node.js built-in test runner (issue #39)
- Added SessionStart hook for gh CLI installation
- Removed mocha and sinon dependencies
@yentsun yentsun self-assigned this Jan 21, 2026
@coveralls
Copy link

Pull Request Test Coverage Report for Build 21209454518

Details

  • 6 of 6 (100.0%) changed or added relevant lines in 1 file are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+0.03%) to 97.035%

Totals Coverage Status
Change from base Build 21118555571: 0.03%
Covered Lines: 517
Relevant Lines: 533

💛 - Coveralls

@yentsun yentsun merged commit 0a6e212 into master Jan 21, 2026
2 checks passed
@yentsun yentsun deleted the claude/review-github-issues-HcgXe branch January 21, 2026 12:28
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.

Expand API docs

3 participants