From 961735fcd75acd6e49d7ee022377a3cd248fa435 Mon Sep 17 00:00:00 2001 From: alex Date: Wed, 11 Jun 2025 12:10:47 -0400 Subject: [PATCH 1/2] adding checkmake and htmlhint --- docs/changelog.md | 10 ++++++++++ docs/tools/checkmake.md | 30 ++++++++++++++++++++++++++++++ docs/tools/htmlhint.md | 31 +++++++++++++++++++++++++++++++ docs/tools/list.md | 4 ++++ 4 files changed, 75 insertions(+) create mode 100644 docs/tools/checkmake.md create mode 100644 docs/tools/htmlhint.md diff --git a/docs/changelog.md b/docs/changelog.md index 6ad52b08..9d40ab2b 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -5,6 +5,16 @@ description: The latest updates and changes to CodeRabbit. sidebar_position: 13 --- +## June 11, 2025 + +### Enhanced Static Analysis: HTMLHint and Checkmake Support + +We're excited to announce that two new static analysis tools are now supported on CodeRabbit! + +- [HTMLHint](https://htmlhint.com/) is a static code analysis tool for HTML that helps maintain code quality by detecting common mistakes and enforcing best practices. + +- [Checkmake](https://github.com/mrtazz/checkmake) is a linter for Makefiles that helps ensure your build scripts follow best practices and maintain consistency. + ## June 5, 2025 ### Enhanced Static Analysis: Dotenv Linter and Pylint Support diff --git a/docs/tools/checkmake.md b/docs/tools/checkmake.md new file mode 100644 index 00000000..8d623ca1 --- /dev/null +++ b/docs/tools/checkmake.md @@ -0,0 +1,30 @@ +--- +title: Checkmake +sidebar_label: Checkmake +description: CodeRabbit's guide to Checkmake. +--- + +```mdx-code-block +import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'; + + +``` + +[Checkmake](https://github.com/mrtazz/checkmake) is a linter for Makefiles. + +## Files + +Checkmake will run checks against any `Makefile`. + +## Configuration + +Checkmake supports the following config files: + +- `checkmake.yml` +- `checkmake.yaml` + +CodeRabbit will use the default settings based on the profile selected if no config file is found. + +## Links + +- [Checkmake Configuration](https://github.com/mrtazz/checkmake#configuration) diff --git a/docs/tools/htmlhint.md b/docs/tools/htmlhint.md new file mode 100644 index 00000000..c8fd61ea --- /dev/null +++ b/docs/tools/htmlhint.md @@ -0,0 +1,31 @@ +--- +title: HTMLHint +sidebar_label: HTMLHint +description: CodeRabbit's guide to HTMLHint. +--- + +```mdx-code-block +import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'; + + +``` + +[HTMLHint](https://htmlhint.com/) is a static code analysis tool for HTML. + +## Files + +HTMLHint will run checks against `*.html` files. + +## Configuration + +HTMLHint supports the following config files: + +- `.htmlhintrc` +- `.htmlhintrc.json` +- `htmlhintrc.json` + +CodeRabbit will use the default settings based on the profile selected if no config file is found. + +## Links + +- [HTMLHint Configuration](https://htmlhint.com/docs/user-guide/getting-started) diff --git a/docs/tools/list.md b/docs/tools/list.md index 7a106a78..7d19fdc4 100644 --- a/docs/tools/list.md +++ b/docs/tools/list.md @@ -23,12 +23,14 @@ For an overview of how CodeRabbit uses these tools when generating code reviews, | GitLab Pipelines | [Pipeline Remediation][Pipeline] | CI/CD Failure Remediation | | Go | [golangci-lint][golangci-lint] | Code Quality | | Helm | [Checkov][Checkov] | Code Security | +| HTML | [HTMLHint][HTMLHint] | Code Quality | | Javascript | [Biome][Biome], [oxlint][oxlint] | Code Quality | | JSON, JSONC | [Biome][Biome] | Code Quality | | JSX | [Biome][Biome], [oxlint][oxlint] | Code Quality | | Kotlin | [detekt][detekt] | Code Quality | | Kubernetes | [Checkov][Checkov] | Code Security | | Lua | [Luacheck][Luacheck] | Code Quality | +| Make | [Checkmake][Checkmake] | Code Quality | | Markdown | [markdownlint][markdownlint], [LanguageTool][LanguageTool] | Code Quality, Grammar Checking | | PHP | [PHPStan][PHPStan] | Code Quality | | Plaintext | [LanguageTool][LanguageTool] | Grammar and Spell Checking | @@ -80,3 +82,5 @@ For an overview of how CodeRabbit uses these tools when generating code reviews, [Clippy]: /tools/clippy.md [Pylint]: /tools/pylint.md [DotenvLinter]: /tools/dotenv.md +[HTMLHint]: /tools/htmlhint.md +[Checkmake]: /tools/checkmake.md From cc7cc612cc3c3d731bff0bff1f355dffaff9ac17 Mon Sep 17 00:00:00 2001 From: alex Date: Wed, 11 Jun 2025 12:12:28 -0400 Subject: [PATCH 2/2] minor fix --- docs/tools/list.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tools/list.md b/docs/tools/list.md index 7d19fdc4..6092e082 100644 --- a/docs/tools/list.md +++ b/docs/tools/list.md @@ -30,7 +30,7 @@ For an overview of how CodeRabbit uses these tools when generating code reviews, | Kotlin | [detekt][detekt] | Code Quality | | Kubernetes | [Checkov][Checkov] | Code Security | | Lua | [Luacheck][Luacheck] | Code Quality | -| Make | [Checkmake][Checkmake] | Code Quality | +| Makefile | [Checkmake][Checkmake] | Code Quality | | Markdown | [markdownlint][markdownlint], [LanguageTool][LanguageTool] | Code Quality, Grammar Checking | | PHP | [PHPStan][PHPStan] | Code Quality | | Plaintext | [LanguageTool][LanguageTool] | Grammar and Spell Checking |