docs: add rule documentation for 89 rules#490
Merged
Conversation
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly enhances the project's documentation by introducing detailed Markdown files for 85 linting rules. This effort aims to improve developer understanding and adherence to coding standards by providing clear explanations, practical examples, and direct references for rules originating from Highlights
Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request adds markdown documentation for a large number of ESLint and typescript-eslint rules. The documentation for each rule is well-structured, providing a clear explanation, examples of incorrect and correct code, and a link to the original documentation. The new documentation is comprehensive and well-written. I have one suggestion to improve the clarity of the code examples for the no-cond-assign rule.
83ccbe3 to
822fed4
Compare
…t rules Add markdown documentation files for ~100 lint rules covering: - 17 ESLint core rules (no-debugger, no-const-assign, etc.) - ~80 @typescript-eslint rules (no-explicit-any, no-floating-promises, etc.) - 2 eslint-plugin-import rules (no-self-import, no-webpack-loader-syntax) Each doc includes rule description, correct/incorrect code examples, and link to the original upstream documentation.
822fed4 to
c1db84c
Compare
hardfist
approved these changes
Mar 4, 2026
hardfist
approved these changes
Mar 4, 2026
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
2 participants
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.
Summary
Add markdown documentation for 89 lint rules (eslint, typescript-eslint, import plugin)
Related Links
Checklist