Skip to content

Commit 3e2f7fa

Browse files
Dotenv documentation
1 parent 35720e8 commit 3e2f7fa

File tree

3 files changed

+35
-0
lines changed

3 files changed

+35
-0
lines changed

docs/changelog.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,21 @@ sidebar_label: Changelog
44
description: The latest updates and changes to CodeRabbit.
55
sidebar_position: 13
66
---
7+
## June 5, 2025
8+
9+
### New Static Analysis Tool
10+
11+
We're excited to announce that [Dotenv Linter](https://github.com/dotenv-linter/dotenv-linter) is now supported on CodeRabbit!
12+
13+
- **Dotenv Linter**: A fast, opinionated linter for `.env` files. It helps prevent misconfigurations by detecting typos, invalid syntax, and duplicated keys.
14+
15+
Here's why you'll love it:
16+
17+
- 🧪 **Catches common mistakes** in environment files before they cause runtime errors.
18+
- 🚀 **Super fast** with zero config required.
19+
- 📦 **Supports multiple `.env` formats** like `.env.local`, `.env.production`, and more.
20+
21+
For more details, visit our [tools documentation](https://docs.coderabbit.ai/tools/dotenv).
722

823
### May 30, 2025
924

docs/tools/dotenv.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Dotenv Linter
2+
3+
**Dotenv Linter** is a lightning-fast linter for `.env` files. It helps ensure your environment files are consistent, typo-free, and follow best practices.
4+
5+
## How It Works in CodeRabbit
6+
7+
CodeRabbit automatically detects `.env`, `.env.local`, and other dotenv-style files and runs `dotenv-linter` on them.
8+
9+
Issues like key duplication, missing values, incorrect formatting, or invalid characters are flagged directly in pull request reviews.
10+
11+
## Configuration
12+
13+
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.
14+
15+
## Resources
16+
17+
- [Dotenv Linter GitHub Repo](https://github.com/dotenv-linter/dotenv-linter)
18+

docs/tools/list.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ For an overview of how CodeRabbit uses these tools when generating code reviews,
1818
| Cppcheck | [Cppcheck][Cppcheck] | Code Quality |
1919
| CSS | [Biome][Biome] | Code Quality |
2020
| Docker | [Hadolint][Hadolint], [Checkov][Checkov] | Code Quality, Code Security |
21+
| Environment Files (.env) | [Dotenv Linter][DotenvLinter] | Code Quality |
2122
| GitHub Actions | [actionlint][actionlint], [Pipeline Remediation][Pipeline] | Code Quality, CI/CD Failure Remediation |
2223
| GitLab Pipelines | [Pipeline Remediation][Pipeline] | CI/CD Failure Remediation |
2324
| Go | [golangci-lint][golangci-lint] | Code Quality |
@@ -78,3 +79,4 @@ For an overview of how CodeRabbit uses these tools when generating code reviews,
7879
[Brakeman]: /tools/brakeman.md
7980
[Clippy]: /tools/clippy.md
8081
[Pylint]: /tools/pylint.md
82+
[DotenvLinter]: /tools/dotenv.md

0 commit comments

Comments
 (0)