Skip to content

Commit 78159d2

Browse files
committed
docs: Update linter documentation and configuration
1 parent 2303cd0 commit 78159d2

File tree

4 files changed

+45
-3
lines changed

4 files changed

+45
-3
lines changed

docs/guides/tools/biome.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: CodeRabbit's guide to Biome.
55
sidebar_position: 5
66
---
77

8-
[Biome](https://biomejs.dev/) is linter for JavaScript, TypeScript, JSX, TSX, JSON, JSONC, CSS files.
8+
[Biome](https://biomejs.dev/) is linter for JavaScript, TypeScript, JSX, TSX, JSON, JSONC, CSS.
99

1010
## Files
1111

docs/guides/tools/hadolint.md

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: Hadolint
3+
sidebar_label: Hadolint
4+
description: CodeRabbit's guide to Hadolint.
5+
sidebar_position: 6
6+
---
7+
8+
[Hadolint](https://github.com/hadolint/hadolint) is a Dockerfile linter.
9+
10+
## Files
11+
12+
Hadolint will run on files with the following file names:
13+
14+
- `Dockerfile`
15+
- `*.dockerfile`
16+
- `Dockerfile.*`
17+
18+
## Configuration
19+
20+
Hadolint supports the following config files:
21+
22+
- `.hadolint.yaml`
23+
24+
CodeRabbit will ignore the following severity levels if no config file is found:
25+
26+
### Chill
27+
28+
- `none`
29+
- `ignore`
30+
- `style`
31+
- `info`
32+
- `warning`
33+
34+
### Assertive
35+
36+
- `none`
37+
- `ignore`
38+
- `style`
39+
40+
## Links
41+
42+
- [Hadolint Configuration](https://github.com/hadolint/hadolint?tab=readme-ov-file#configure)

docs/guides/tools/markdownlint.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: CodeRabbit's guide to Markdownlint.
55
sidebar_position: 3
66
---
77

8-
[Markdownlint](https://github.com/DavidAnson/markdownlint) is a linter for Markdown files.
8+
[Markdownlint](https://github.com/DavidAnson/markdownlint) is a linter for Markdown.
99

1010
## Files
1111

docs/guides/tools/ruff.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: CodeRabbit's guide to Ruff.
55
sidebar_position: 2
66
---
77

8-
[Ruff](https://docs.astral.sh/ruff/) is a linter and code formatter for Python.
8+
[Ruff](https://docs.astral.sh/ruff/) is a linter for Python.
99

1010
## Files
1111

0 commit comments

Comments
 (0)