Skip to content

Add linter documentation #59

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Jul 15, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs: Update linter documentation and configuration
  • Loading branch information
hasit committed Jul 15, 2024
commit 78159d2b713511fa71fee141531cfaa7a2349029
2 changes: 1 addition & 1 deletion docs/guides/tools/biome.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: CodeRabbit's guide to Biome.
sidebar_position: 5
---

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

## Files

Expand Down
42 changes: 42 additions & 0 deletions docs/guides/tools/hadolint.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: Hadolint
sidebar_label: Hadolint
description: CodeRabbit's guide to Hadolint.
sidebar_position: 6
---

[Hadolint](https://github.com/hadolint/hadolint) is a Dockerfile linter.

## Files

Hadolint will run on files with the following file names:

- `Dockerfile`
- `*.dockerfile`
- `Dockerfile.*`

## Configuration

Hadolint supports the following config files:

- `.hadolint.yaml`

CodeRabbit will ignore the following severity levels if no config file is found:

### Chill

- `none`
- `ignore`
- `style`
- `info`
- `warning`

### Assertive

- `none`
- `ignore`
- `style`

## Links

- [Hadolint Configuration](https://github.com/hadolint/hadolint?tab=readme-ov-file#configure)
2 changes: 1 addition & 1 deletion docs/guides/tools/markdownlint.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: CodeRabbit's guide to Markdownlint.
sidebar_position: 3
---

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

## Files

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/tools/ruff.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: CodeRabbit's guide to Ruff.
sidebar_position: 2
---

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

## Files

Expand Down