From a1408ec2ff69c3fffe3f3341888498a470957087 Mon Sep 17 00:00:00 2001 From: nimratcoderabbit Date: Fri, 30 May 2025 17:26:02 -0400 Subject: [PATCH 1/3] Add Pylint docs to tools section --- docs/changelog.md | 16 ++++++++++++++++ docs/tools/list.md | 3 ++- docs/tools/pylint.md | 37 +++++++++++++++++++++++++++++++++++++ 3 files changed, 55 insertions(+), 1 deletion(-) create mode 100644 docs/tools/pylint.md diff --git a/docs/changelog.md b/docs/changelog.md index 70fdf7db..ebbe2772 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -5,6 +5,22 @@ description: The latest updates and changes to CodeRabbit. sidebar_position: 13 --- +## May 30, 2025 + +### New Static Analysis Tool + +We're excited to announce that [Pylint](https://github.com/PyCQA/pylint) is now supported on CodeRabbit! + +- **Pylint**: A widely used static analysis and code quality tool for Python. It checks for errors, enforces a coding standard, and looks for code smells in your Python codebase by analyzing Python files (`.py`). + +Here's why you'll love it: + +- 🐞 **Instantly catches bugs** and style issues in your Python code. +- 🧹 **Enforces clean, consistent code** across your entire team. +- ⚙️ **Fully customizable** to match your project's unique coding standards. + +For more details, please visit our [tools documentation](https://docs.coderabbit.ai/tools/pylint). + ## May 25, 2025 ### New Security and Code Quality Tools diff --git a/docs/tools/list.md b/docs/tools/list.md index b3220568..cace67a9 100644 --- a/docs/tools/list.md +++ b/docs/tools/list.md @@ -33,7 +33,7 @@ For an overview of how CodeRabbit uses these tools when generating code reviews, | Plaintext | [LanguageTool][LanguageTool] | Grammar and Spell Checking | | Java | [PMD][PMD] | Code Quality | | Protobuf | [Buf][Buf] | Code Quality | -| Python | [Ruff][Ruff] | Code Quality | +| Python | [Pylint][Pylint], [Ruff][Ruff] | Code Quality | | Regal | [Regal][Regal] | Code Quality | | Ruby | [RuboCop][RuboCop], [Brakeman][Brakeman] | Code Quality, Code Security | | Rust | [Clippy][Clippy] | Code Quality | @@ -77,3 +77,4 @@ For an overview of how CodeRabbit uses these tools when generating code reviews, [Luacheck]: /tools/luacheck.md [Brakeman]: /tools/brakeman.md [Clippy]: /tools/clippy.md +[Pylint]: /tools/pylint.md diff --git a/docs/tools/pylint.md b/docs/tools/pylint.md new file mode 100644 index 00000000..f6793106 --- /dev/null +++ b/docs/tools/pylint.md @@ -0,0 +1,37 @@ +--- +title: Pylint +sidebar_label: Pylint +description: CodeRabbit's guide to Pylint. +--- + +```mdx-code-block +import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'; + + +``` + +[Pylint](https://pylint.pycqa.org/) is a static code analysis tool for Python. It checks your Python code for errors, enforces a coding standard, and looks for code smells. + +## Supported Files + +Pylint will run on files with the following extensions: + +- `*.py` + +## Features + +Pylint can detect many issues such as: + +- Coding standard violations (PEP8) +- Unused variables and imports +- Undefined variables +- Code smells and refactoring suggestions +- Error-prone constructs +- And many more + +## Links + +- [Pylint Official Website](https://pylint.pycqa.org/) +- [Pylint GitHub Repository](https://github.com/pylint-dev/pylint) +- [Pylint Documentation](https://pylint.pycqa.org/en/latest/) +- [Message Control](https://pylint.pycqa.org/en/latest/user_guide/message-control.html) From 3dad289e79150fb3f5f26b09e094bb5346f5fec3 Mon Sep 17 00:00:00 2001 From: nimratcoderabbit Date: Fri, 30 May 2025 17:33:30 -0400 Subject: [PATCH 2/3] Adding Pylint --- docs/tools/list.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tools/list.md b/docs/tools/list.md index cace67a9..774af58c 100644 --- a/docs/tools/list.md +++ b/docs/tools/list.md @@ -33,7 +33,7 @@ For an overview of how CodeRabbit uses these tools when generating code reviews, | Plaintext | [LanguageTool][LanguageTool] | Grammar and Spell Checking | | Java | [PMD][PMD] | Code Quality | | Protobuf | [Buf][Buf] | Code Quality | -| Python | [Pylint][Pylint], [Ruff][Ruff] | Code Quality | +| Python | [Pylint][Pylint], [Ruff][Ruff] | Code Quality | | Regal | [Regal][Regal] | Code Quality | | Ruby | [RuboCop][RuboCop], [Brakeman][Brakeman] | Code Quality, Code Security | | Rust | [Clippy][Clippy] | Code Quality | From 4a0c123b3fda2856949f9b81282ca818866787fa Mon Sep 17 00:00:00 2001 From: nimratcoderabbit Date: Thu, 5 Jun 2025 15:41:47 -0400 Subject: [PATCH 3/3] Dotenv documentation --- docs/changelog.md | 15 +++++++++++++++ docs/tools/dotenv.md | 18 ++++++++++++++++++ docs/tools/list.md | 3 +++ 3 files changed, 36 insertions(+) create mode 100644 docs/tools/dotenv.md diff --git a/docs/changelog.md b/docs/changelog.md index ebbe2772..23df49c3 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -4,6 +4,21 @@ sidebar_label: Changelog description: The latest updates and changes to CodeRabbit. sidebar_position: 13 --- +## May 30, 2025 + +### New Static Analysis Tool + +We're excited to announce that [Dotenv Linter](https://github.com/dotenv-linter/dotenv-linter) is now supported on CodeRabbit! + +- **Dotenv Linter**: A fast, opinionated linter for `.env` files. It helps prevent misconfigurations by detecting typos, invalid syntax, and duplicated keys. + +Here's why you'll love it: + +- 🧪 **Catches common mistakes** in environment files before they cause runtime errors. +- 🚀 **Super fast** with zero config required. +- 📦 **Supports multiple `.env` formats** like `.env.local`, `.env.production`, and more. + +For more details, visit our [tools documentation](https://docs.coderabbit.ai/tools/dotenv). ## May 30, 2025 diff --git a/docs/tools/dotenv.md b/docs/tools/dotenv.md new file mode 100644 index 00000000..60d33af1 --- /dev/null +++ b/docs/tools/dotenv.md @@ -0,0 +1,18 @@ +# Dotenv Linter + +**Dotenv Linter** is a lightning-fast linter for `.env` files. It helps ensure your environment files are consistent, typo-free, and follow best practices. + +## How It Works in CodeRabbit + +CodeRabbit automatically detects `.env`, `.env.local`, and other dotenv-style files and runs `dotenv-linter` on them. + +Issues like key duplication, missing values, incorrect formatting, or invalid characters are flagged directly in pull request reviews. + +## Configuration + +Dotenv Linter works out-of-the-box with zero config. But if needed, you can ignore rules or configure behavior via comments in the `.env` file or project-level config. + +## Resources + +- [Dotenv Linter GitHub Repo](https://github.com/dotenv-linter/dotenv-linter) + diff --git a/docs/tools/list.md b/docs/tools/list.md index 774af58c..561727d1 100644 --- a/docs/tools/list.md +++ b/docs/tools/list.md @@ -17,6 +17,7 @@ For an overview of how CodeRabbit uses these tools when generating code reviews, | CloudFormation | [Checkov][Checkov] | Code Security | | Cppcheck | [Cppcheck][Cppcheck] | Code Quality | | CSS | [Biome][Biome] | Code Quality | +| Environment Files (.env) | [Dotenv Linter][DotenvLinter] | Code Quality | | Docker | [Hadolint][Hadolint], [Checkov][Checkov] | Code Quality, Code Security | | GitHub Actions | [actionlint][actionlint], [Pipeline Remediation][Pipeline] | Code Quality, CI/CD Failure Remediation | | GitLab Pipelines | [Pipeline Remediation][Pipeline] | CI/CD Failure Remediation | @@ -78,3 +79,5 @@ For an overview of how CodeRabbit uses these tools when generating code reviews, [Brakeman]: /tools/brakeman.md [Clippy]: /tools/clippy.md [Pylint]: /tools/pylint.md +[DotenvLinter]: /tools/dotenv.md + pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.

Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy