[Docs Improvement] Add Linting Cheatsheet to Linting.md #7571
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.
@burtonator wrote a cheatsheet for handling common linting issues.
I've integrated that cheatsheet with our current knowledge base entry,
Linting.md
. Some (relatively minor) changes were made to the cheatsheet's contents, either to (1) remove redundancies with the existing documentation, (2) reorganize information from the cheatsheet into another, more relevant section of the entry, or (3) bring it in line stylistically with the knowledge base. Nothing major, but just flagging this explicitly @burtonator so you're aware, and scan over it accordingly!I've also reviewed and refreshed the existing documentation on linting and formatting to the best of my knowledge—however, I don't use these tools day in and day out, so I'd welcome eyes from @masvelio, @kurtisassad or any other team member. (Picking on you two since you've expressed opinions in the past...)
Link to Issue
Closes: #7537
Description of Changes
eslint-diff
plugin—@burtonator, if the inclination strikes you, feel free to suggest more language/info here"Deployment Plan"
Will mark as "Certified Fresh" in the change log once I get some approvals / feedback.