build(lint): throw error on JSON.stringify within a logging statement #5878
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.
Problem
contributors often use
JSON.stringifyto get a printable form of an object in log messages, but this is hard for humans to read.Solution
Implement a custom eslint rule that checks for instances of
JSON.stringifyinside of a logging statement. The implementation involves a few heuristics for catching edge cases that are explained in the comments.In addition to implementing the lint rule, existing cases are migrated to use
%Ostring substitution.Within the lint message, we mention the depth limit. There is a workaround this depth limit by manually converting it to a string first with
util.format: https://stackoverflow.com/questions/10729276/how-can-i-get-the-full-object-in-node-jss-console-log-rather-than-object, but seems rather involved, and uncommon enough to leave out of suggestion message.License: I confirm that my contribution is made under the terms of the Apache 2.0 license.