docs: document ConsoleLogger class #1914
Merged
Conversation
This file contains 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
Signed-off-by: André Jaenisch <andre.jaenisch@posteo.de>
pdehaan
reviewed
Jul 30, 2021
Signed-off-by: André Jaenisch <andre.jaenisch@posteo.de>
|
Looks good to me, but I don't have merge permissions on this repo so I can't land it. |
|
Will ship with 1.0.1, thanks! |
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.
VS Code is warning me (via CodeMetrics extension), that this class has become quite complex.
As far as I can tell, it's the only logger implementation you have in this repository. That being said, it is possible to overwrite the logger. Given that, I suggest, that you consider defining a BaseLogger class that developers can extend with their own custom logic (for example, use pino for logging).
This way, you can use the class-as-interface pattern while reducing the overhead in this class.
I was a bit unsure, which properties and methods you consider public and which private/protected. I assume, that a leading underscore indicates a „private” property.
Since the variables are pretty self-explaining, I omitted the description blocks in most of them.
Signed-off-by: André Jaenisch andre.jaenisch@posteo.de