feat: enhance type checking for OptionalLogger methods#41
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR tightens TypeScript type-checking for OptionalLogger methods by adding explicit this typing so extracted/unbound calls are rejected at compile time.
Changes:
- Adds
thisparameters toOptionalLoggermethod function types to prevent calling extracted methods without binding. - Updates
OptionalLoggerImplmethod property types to match the interface changes. - Adds a (currently skipped) test intended to assert the new type-checking behavior via
@ts-expect-error.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
src/logger.ts |
Updates OptionalLogger / OptionalLoggerImpl method types to require an appropriate this context. |
src/logger.test.ts |
Adds a type-checking-focused test that validates extracted-method calls fail to type-check. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+93
to
+107
| readonly debug?: | ||
| | ((this: OptionalLogger<Error, Warn, Info, Debug>, ...args: Debug) => void) | ||
| | undefined = undefined; | ||
| readonly info?: | ||
| | ((this: OptionalLogger<Error, Warn, Info, Debug>, ...args: Info) => void) | ||
| | undefined = undefined; | ||
| readonly warn?: | ||
| | ((this: OptionalLogger<Error, Warn, Info, Debug>, ...args: Warn) => void) | ||
| | undefined = undefined; | ||
| readonly error?: | ||
| | ((this: OptionalLogger<Error, Warn, Info, Debug>, ...args: Error) => void) | ||
| | undefined = undefined; | ||
| readonly flush: ( | ||
| this: OptionalLogger<Error, Warn, Info, Debug>, | ||
| ) => Promise<void>; |
Contributor
Author
|
But Co-pilot is right. Let me do that. |
Contributor
Author
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.
No description provided.