docs: add Pro-tier tools note to various tool guides

coderabbitai · Dec 12, 2024 · 4ff759d · 4ff759d
1 parent 63d32ba
commit 4ff759d
Show file tree

Hide file tree

Showing 23 changed files with 92 additions and 0 deletions.
diff --git a/docs/tools/actionlint.md b/docs/tools/actionlint.md
@@ -7,6 +7,10 @@ description: CodeRabbit's guide to Actionlint.
 [Actionlint](https://github.com/rhysd/actionlint/) is a static checker for
 GitHub Actions workflow files.
 
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
 ## Files
 
 We look for `GitHub Action` files specifically in the following directory:

diff --git a/docs/tools/biome.md b/docs/tools/biome.md
@@ -6,6 +6,10 @@ description: CodeRabbit's guide to Biome.
 
 [Biome](https://biomejs.dev/) is a linter for JavaScript, TypeScript, JSX, TSX, JSON, JSONC, CSS.
 
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
 ## Files
 
 Biome will run on files with the following extensions:

diff --git a/docs/tools/buf.md b/docs/tools/buf.md
@@ -6,6 +6,10 @@ description: CodeRabbit's guide to Buf.
 
 [Buf](https://buf.build/) offers linting for Protobuf files.
 
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
 ## Files
 
 Buf will run on files with the following extensions:

diff --git a/docs/tools/checkov.md b/docs/tools/checkov.md
@@ -6,6 +6,10 @@ description: CodeRabbit's guide to Checkov.
 
 [Checkov](https://www.checkov.io/) is a static code analysis tool for scanning Infrastructure as Code (IaC) files for misconfigurations.
 
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
 ## Files
 
 Checkov will run on files with the following files and extensions:

diff --git a/docs/tools/circleci.md b/docs/tools/circleci.md
@@ -6,6 +6,10 @@ description: CodeRabbit's guide to CircleCi.
 
 [CircleCi](https://circleci.com/) is a static checker and validator for circleci config files.
 
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
 ## Files
 
 We look for `CircleCi Configuration` files specifically in the following directory:

diff --git a/docs/tools/cppcheck.md b/docs/tools/cppcheck.md
@@ -6,6 +6,10 @@ description: CodeRabbit's guide to Cppcheck.
 
 [Cppcheck](https://cppcheck.sourceforge.io/) is a static code analysis tool for the C and C++ programming languages.
 
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
 ## Files
 
 Cppcheck will run on files with the following extensions:

diff --git a/docs/tools/detekt.md b/docs/tools/detekt.md
@@ -6,6 +6,10 @@ description: CodeRabbit's guide to Detekt.
 
 [Detekt](https://detekt.dev/) is a static code analysis tool specifically designed for Kotlin projects
 
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
 ## Files
 
 Detekt will run on files with the following extensions:

diff --git a/docs/tools/eslint.md b/docs/tools/eslint.md
@@ -6,6 +6,10 @@ description: CodeRabbit's guide to ESLint.
 
 [ESLint](https://eslint.org/) is a linter for JavaScript, TypeScript, JSX, TSX, CSS, etc.
 
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
 ## Files
 
 ESLint will run on files with the following extensions:

diff --git a/docs/tools/gitleaks.md b/docs/tools/gitleaks.md
@@ -6,6 +6,10 @@ description: CodeRabbit's guide to Gitleaks.
 
 [Gitleaks](https://gitleaks.io/) is a secret-scanner.
 
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
 ## Files
 
 Gitleaks will run on all files.

diff --git a/docs/tools/golangci-lint.md b/docs/tools/golangci-lint.md
@@ -6,6 +6,10 @@ description: CodeRabbit's guide to golangci-lint.
 
 [golangci-lint](https://golangci-lint.run/) is a fast Go linters runner.
 
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
 ## Files
 
 golangci-lint will run on files with the following extensions:

diff --git a/docs/tools/hadolint.md b/docs/tools/hadolint.md
@@ -6,6 +6,10 @@ description: CodeRabbit's guide to Hadolint.
 
 [Hadolint](https://github.com/hadolint/hadolint) is a Dockerfile linter.
 
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
 ## Files
 
 Hadolint will run on files with the following file names:

diff --git a/docs/tools/languagetool.md b/docs/tools/languagetool.md
@@ -6,6 +6,10 @@ description: CodeRabbit's guide to LanguageTool.
 
 [LanguageTool](https://github.com/languagetool-org/languagetool) is a style and grammar checker.
 
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
 ## Files
 
 LanguageTool will run on files with the following extensions:

diff --git a/docs/tools/markdownlint.md b/docs/tools/markdownlint.md
@@ -6,6 +6,10 @@ description: CodeRabbit's guide to Markdownlint.
 
 [Markdownlint](https://github.com/DavidAnson/markdownlint) is a linter for Markdown.
 
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
 ## Files
 
 Markdownlint will run on files with the following extensions:

diff --git a/docs/tools/phpstan.md b/docs/tools/phpstan.md
@@ -6,6 +6,10 @@ description: CodeRabbit's guide to PHPStan.
 
 [PHPStan](https://phpstan.org/) is a static analysis tool for PHP.
 
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
 ## Files
 
 PHPStan will run on files with the following extensions:

diff --git a/docs/tools/pmd.md b/docs/tools/pmd.md
@@ -6,6 +6,10 @@ description: CodeRabbit's guide to PMD.
 
 [PMD](https://pmd.github.io/) is an extensible multilanguage static code analyzer. It’s mainly concerned with Java.
 
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
 ## Files
 
 PMD will run on files with the following extensions:

diff --git a/docs/tools/regal.md b/docs/tools/regal.md
@@ -6,6 +6,10 @@ description: CodeRabbit's guide to Regal.
 
 [Regal](https://docs.styra.com/regal/) is a linter and language server for Rego.
 
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
 ## Files
 
 Regal will run on files with the following extensions:

diff --git a/docs/tools/rubocop.md b/docs/tools/rubocop.md
@@ -6,6 +6,10 @@ description: CodeRabbit's guide to Rubocop.
 
 [Rubocop](https://rubocop.org/) A Ruby static code analyzer and formatter, based on the community Ruby style guide.
 
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
 ## Files
 
 Rubocop will run on the following files and extensions:

diff --git a/docs/tools/ruff.md b/docs/tools/ruff.md
@@ -6,6 +6,10 @@ description: CodeRabbit's guide to Ruff.
 
 [Ruff](https://docs.astral.sh/ruff/) is a linter for Python.
 
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
 ## Files
 
 Ruff will run on files with the following extensions:

diff --git a/docs/tools/semgrep.md b/docs/tools/semgrep.md
@@ -7,6 +7,10 @@ description: CodeRabbit's guide to Semgrep.
 [Semgrep](https://semgrep.dev/) is a static analysis tool designed to scan code
 for security vulnerabilities and code quality issues.
 
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
 ## Configuration
 
 Semgrep uses a YAML style configuration file. By default we will automatically

diff --git a/docs/tools/shellcheck.md b/docs/tools/shellcheck.md
@@ -6,6 +6,10 @@ description: CodeRabbit's guide to ShellCheck.
 
 [ShellCheck](https://www.shellcheck.net/) is a linter for shell scripts.
 
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
 ## Files
 
 ShellCheck will run on files with the following extensions:

diff --git a/docs/tools/swiftlint.md b/docs/tools/swiftlint.md
@@ -6,6 +6,10 @@ description: CodeRabbit's guide to SwiftLint.
 
 [SwiftLint](https://realm.github.io/SwiftLint/) is a linter for Swift.
 
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
 ## Files
 
 SwiftLint will run on files with the following extensions:

diff --git a/docs/tools/tools.md b/docs/tools/tools.md
@@ -7,6 +7,10 @@ sidebar_position: 1
 
 CodeRabbit supports various linters and security analysis tools to improve the code review process. The output of these tools is used to enhance the feedback provided by CodeRabbit, making it possible to provide 1-click fixes for common issues.
 
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
 ## Enabling/Disabling Tools
 
 You can enable or disable tools by setting `reviews.tools.<tool>.enabled` in your project's `.coderabbit.yaml` file or setting the "Review → Tools → Tool → Enabled" field in CodeRabbit's settings page.

diff --git a/docs/tools/yamllint.md b/docs/tools/yamllint.md
@@ -6,6 +6,10 @@ description: CodeRabbit's guide to Yamllint.
 
 [Yamllint](https://yamllint.readthedocs.io/en/stable/) is a linter for YAML.
 
+:::note
+Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
+:::
+
 ## Files
 
 Yamllint will run on files with the following extensions: