Forbid console.log and console.info
#835
Open
Conversation
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
Console calls, IMO, should be for debugging only. They're useful for users facing bugs to share information about any unexpected events. Instead of using `console.log` as a catch-all, I'd like to think more carefully about the purpose of each message, and either omit or log it as an error, warning, or debug message.
Remove log and info calls or convert them to other calls. Clean up some messages.
|
|
mfisher87
changed the title
console.log and console.info
mfisher87
commented
Jul 25, 2025
| @@ -302,8 +302,6 @@ const activate = async ( | |||
| }); | |||
| } | |||
| } | |||
|
|
|||
| console.log('@jupytergis/jupytergis-qgis:qgisplugin is activated!'); | |||
There was a problem hiding this comment.
Should we keep these as console.debug? I figured it wasn't important to print this information, but I could be missing the point :)
mfisher87
force-pushed
the
forbid-console-log
branch
from
1b70c8e to
af6807f
Compare
|
Integration tests report: appsharing.space |
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.
Description
Console calls, IMO, should be for debugging only. They're useful for users facing bugs to share information about any unexpected events. Instead of using
console.logas a catch-all, I'd like to think more carefully about the purpose of each message, and either omit or log it as an error, warning, or debug message.What do you all think?
If I've removed any calls that you all feel are important, let's change them to
console.debugcalls?Checklist
Resolves #XXX.Failing lint checks can be resolved with:
pre-commit run --all-filesjlpm run lint📚 Documentation preview: https://jupytergis--835.org.readthedocs.build/en/835/
💡 JupyterLite preview: https://jupytergis--835.org.readthedocs.build/en/835/lite