8000 Add golangci-lint, PHPStan, and SwiftLint documentation and configura… · coderabbitai/coderabbit-docs@ba5b505 · GitHub
[go: up one dir, main page]
Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit ba5b505

Browse files
hasithasit
committed
Add golangci-lint, PHPStan, and SwiftLint documentation and configuration
1 parent 23acf22 commit ba5b505

File tree

4 files changed

+60
-1
lines changed

4 files changed

+60
-1
lines changed

‎docs/guides/tools/golangci-lint.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
title: golangci-lint
3+
sidebar_label: golangci-lint
4+
description: CodeRabbit's guide to golangci-lint.
5+
sidebar_position: 8
6+
---
7+
8+
[golangci-lint](https://golangci-lint.run/) is a fast Go linters runner.
9+
10+
## Files
11+
12+
golangci-lint will run on files with the following extensions:
13+
14+
- `.go`
15+
- `go.mod`
16+
17+
## Configuration
18+
19+
golangci-lint supports the following config files:
20+
21+
- User-defined config file set at `reviews.tools.golangci-lint.config_file` in your project's `.coderabbit.yaml` file or setting the "Review → Tools → golangci-lint → Config File" field in CodeRabbit's settings page.
22+
- `.golangci.yml`
23+
- `.golangci.yaml`
24+
- `.golangci.toml`
25+
- `.golangci.json`
26+
27+
## Links
28+
29+
- [golangci-lint Configuration](https://golangci-lint.run/usage/configuration/)

‎docs/guides/tools/phpstan.md

Lines changed: 28 additions & 0 deletions
< 10000 th scope="col">Diff line change
Original file line numberDiff line number
@@ -0,0 +1,28 @@
1+
---
2+
title: PHPStan
3+
sidebar_label: PHPStan
4+
description: CodeRabbit's guide to PHPStan.
5+
sidebar_position: 8
6+
---
7+
8+
[PHPStan](https://phpstan.org/) is a static analysis tool for PHP.
9+
10+
## Files
11+
12+
PHPStan will run on files with the following extensions:
13+
14+
- `.php`
15+
16+
## Configuration
17+
18+
PHPStan supports the following config files:
19+
20+
- `phpstan.neon`
21+
- `phpstan.neon.dist`
22+
- `phpstan.dist.neon`
23+
24+
CodeRabbit will not run PHPStan if no config file is found.
25+
26+
## Links
27+
28+
- [PHPStan Configuration](https://phpstan.org/config-reference)

‎docs/guides/tools/swiftlint.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ SwiftLint will run on files with the following extensions:
1717

1818
Ruff supports the following config files:
1919

20+
- User-defined config file set at `reviews.tools.swiftlint.config_file` in your project's `.coderabbit.yaml` file or setting the "Review → Tools → SwiftLint → Config File" field in CodeRabbit's settings page.
2021
- `.swiftlint.yaml`
2122
- `.swiftlint.yml`
22-
- User-defined config file set at `reviews.tools.swiftlint.config_file` in your project's `.coderabbit.yaml` file or setting the "Review → Tools → SwiftLint → Config File" field in CodeRabbit's settings page.
2323

2424
CodeRabbit will use the following settings if no config file is found:
2525

‎docs/guides/tools/tools.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,3 +42,5 @@ Remove extraneous f prefix
4242
- [LanguageTool](./languagetool.md)
4343
- [Biome](./biome.md)
4444
- [Hadolint](./hadolint.md)
45+
- [SwiftLint](./swiftlint.md)
46+
- [PHPStan](./phpstan.md)

0 commit comments

Comments
 (0)
0