Log levels #590
Merged
Log levels #590
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
| @@ -9,6 +9,7 @@ | |||
| "Uint8Array": true | |||
| }, | |||
| "rules": { | |||
| "strict": [2, "global"] | |||
| "strict": [2, "global"], | |||
| "no-console": [1] | |||
| }; | ||
|
|
||
| loggers.error = function() { | ||
| if(config.logging > 0) { |
There was a problem hiding this comment.
Was mainly because console.error marks it red as an error. Should I add it for consistency?
There was a problem hiding this comment.
I think the prefix would be useful for users that want to capture the console and process the messages.
|
💃 |
| **It is important to note that logging is turned off by default in v1.13.0 onwards.** | ||
| To turn logging on for development, you will want to run | ||
| `Plotly.setPlotConfig({ logging: 2 })` before any plotting. | ||
| See [this file](https://github.com/plotly/plotly.js/blob/master/src/lib/loggers.js) for more details. |
There was a problem hiding this comment.
Cool. I'd vote for leaving this block up until September and then remove it.
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.
Resolves #565.
In brief:
Lib.markTimecalls - these can be done usingconsole.timeandconsole.timeEndwhile developing, then should be removed before committing/pushingLib.log,Lib.warn, andLib.errorwhich can be toggled by setting theloggingconfig value12There is a downside: the line number when logged shows up as from the
lib/index.jsfile. I have somewhat "fixed" this by having stack traces printed with logs, but it is not ideal (in my mind) and the methods for circumventing this aren't very robust and don't work withstrict mode(usingarguments.caller.calleeor overwritingError.prepareStackTrace).I think any downsides (i.e. having to click to see the stacktrace on a log message) is worth the benefits of keeping the library quiet in a production setting.