Add more tools

hasit · hasit · commit 1d0417278e33 · 2024-07-15T08:02:41.000-07:00
diff --git a/docs/guides/tools/markdownlint.md b/docs/guides/tools/markdownlint.md
@@ -0,0 +1,75 @@
+---
+title: Markdownlint
+sidebar_label: Markdownlint
+description: CodeRabbit's guide to Markdownlint.
+sidebar_position: 3
+---
+
+[Markdownlint](https://github.com/DavidAnson/markdownlint) is a linter for Markdown files.
+
+## Files
+
+Markdownlint will run on files with the following extensions:
+
+- `.md`
+- `.markdown`
+
+## Settings
+
+Markdownlint supports the following config files:
+
+- `.markdownlint.jsonc`
+- `.markdownlint.json`
+- `.markdownlint.yaml`
+- `.markdownlint.yml`
+
+CodeRabbit will use the following settings based on the profile selected if no config file is found:
+
+### Chill
+
+```json
+{
+  "default": true,
+  "line-length": false,
+  "no-duplicate-heading": { 
+   "siblings_only": true 
+  },
+  "no-trailing-punctuation": { 
+   "punctuation": ".,;:" 
+  },
+  "ol-prefix": false,
+  "list-marker-space": false,
+  "no-inline-html": false,
+  "first-line-h1": false,
+  "no-trailing-spaces": false,
+  "single-h1": false,
+  "blank_lines": false,
+}
+```
+
+### Assertive
+
+```json
+{
+  "default": true,
+  "line-length": false,
+  "no-duplicate-heading": { 
+   "siblings_only": true 
+  },
+  "no-trailing-punctuation": { 
+   "punctuation": ".,;:" 
+  },
+  "ol-prefix": true,
+  "list-marker-space": false,
+  "no-inline-html": true,
+  "first-line-h1": true,
+  "no-trailing-spaces": true,
+  "single-h1": true,
+  "blank_lines": true,
+}
+
+```
+
+## Links
+
+- [Markdownlint Configuration](https://github.com/DavidAnson/markdownlint?tab=readme-ov-file#configuration)
diff --git a/docs/guides/tools/ruff.md b/docs/guides/tools/ruff.md
@@ -2,10 +2,16 @@
 title: Ruff
 sidebar_label: Ruff
 description: CodeRabbit's guide to Ruff.
-sidebar_position: 1
+sidebar_position: 2
 ---
 
-Ruff is a linter and code formatter for Python.
+[Ruff](https://docs.astral.sh/ruff/) is a linter and code formatter for Python.
+
+## Files
+
+Ruff will run on files with the following extensions:
+
+- `.py`
 
 ## Settings
 
@@ -15,7 +21,7 @@ Ruff supports the following config files:
 - `ruff.toml`
 - `.ruff.toml`
 
-CodeRabbit will use the following settings if no config file is found:
+CodeRabbit will use the following settings based on the profile selected if no config file is found:
 
 ### Chill
 
@@ -117,6 +123,6 @@ select = [
 "**/{test,tests}/**/*.py" = ["S101"]
 ```
 
-Links:
+## Links
 
-- [Ruff](https://docs.astral.sh/ruff/configuration/)
+- [Ruff Configuration](https://docs.astral.sh/ruff/configuration/)
diff --git a/docs/guides/tools/shellcheck.md b/docs/guides/tools/shellcheck.md
@@ -0,0 +1,37 @@
+---
+title: ShellCheck
+sidebar_label: ShellCheck
+description: CodeRabbit's guide to ShellCheck.
+sidebar_position: 1
+---
+
+[ShellCheck](https://www.shellcheck.net/) is a linter for shell scripts.
+
+## Files
+
+ShellCheck will run on files with the following extensions:
+
+- `.sh`
+- `.bash`
+- `.ksh`
+- `.dash`
+
+## Settings
+
+CodeRabbit will use the following settings based on the profile selected:
+
+### Chill
+
+```shell
+--severity=warning
+```
+
+### Assertive
+
+```shell
+--severity=style
+```
+
+## Links
+
+- [ShellCheck Wiki](https://www.shellcheck.net/wiki/)
