Add golangci-lint, PHPStan, and SwiftLint documentation and configuration

hasit · hasit · commit ba5b5052ed95 · 2024-07-15T09:48:10.000-07:00
diff --git a/docs/guides/tools/golangci-lint.md b/docs/guides/tools/golangci-lint.md
@@ -0,0 +1,29 @@
+---
+title: golangci-lint
+sidebar_label: golangci-lint
+description: CodeRabbit's guide to golangci-lint.
+sidebar_position: 8
+---
+
+[golangci-lint](https://golangci-lint.run/) is a fast Go linters runner.
+
+## Files
+
+golangci-lint will run on files with the following extensions:
+
+- `.go`
+- `go.mod`
+
+## Configuration
+
+golangci-lint supports the following config files:
+
+- 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.
+- `.golangci.yml`
+- `.golangci.yaml`
+- `.golangci.toml`
+- `.golangci.json`
+
+## Links
+
+- [golangci-lint Configuration](https://golangci-lint.run/usage/configuration/)
diff --git a/docs/guides/tools/phpstan.md b/docs/guides/tools/phpstan.md
@@ -0,0 +1,28 @@
+---
+title: PHPStan
+sidebar_label: PHPStan
+description: CodeRabbit's guide to PHPStan.
+sidebar_position: 8
+---
+
+[PHPStan](https://phpstan.org/) is a static analysis tool for PHP.
+
+## Files
+
+PHPStan will run on files with the following extensions:
+
+- `.php`
+
+## Configuration
+
+PHPStan supports the following config files:
+
+- `phpstan.neon`
+- `phpstan.neon.dist`
+- `phpstan.dist.neon`
+
+CodeRabbit will not run PHPStan if no config file is found.
+
+## Links
+
+- [PHPStan Configuration](https://phpstan.org/config-reference)
diff --git a/docs/guides/tools/swiftlint.md b/docs/guides/tools/swiftlint.md
@@ -17,9 +17,9 @@ SwiftLint will run on files with the following extensions:
 
 Ruff supports the following config files:
 
+- 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.
 - `.swiftlint.yaml`
 - `.swiftlint.yml`
-- 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.
 
 CodeRabbit will use the following settings if no config file is found:
 
diff --git a/docs/guides/tools/tools.md b/docs/guides/tools/tools.md
@@ -42,3 +42,5 @@ Remove extraneous f prefix
 - [LanguageTool](./languagetool.md)
 - [Biome](./biome.md)
 - [Hadolint](./hadolint.md)
+- [SwiftLint](./swiftlint.md)
+- [PHPStan](./phpstan.md)
