docs(lint): document 11 ported oxlint unicorn rules#3377
Open
bartlomieju wants to merge 2 commits into
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
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.
Adds documentation pages for the eleven oxlint "unicorn" correctness rules
being ported to deno_lint as native rules. Each page follows the existing
lint/rules/*.mdformat —recommendedfrontmatter tag, a shortdescription, prose explaining the rationale, and Invalid/Valid code
examples. The rule list is generated by walking
lint/rules/, so no indexchanges are needed.
Documented rules:
no-await-in-promise-methods,no-empty-file,no-invalid-fetch-options,no-invalid-remove-event-listener,no-new-array,no-single-promise-in-promise-methods,no-thenable,no-unnecessary-await,no-useless-fallback-in-spread,no-useless-length-check, andprefer-set-size.These pair with the rule implementations in deno_lint (PRs #1520, #1522–
#1531). All eleven rules are tagged
recommended, mirroring the tag on therule implementations; that on-by-default choice is pending maintainer
sign-off on the deno_lint PRs, so the
recommendedfrontmatter here shouldbe confirmed alongside those.