File tree 3 files changed +123
-5
lines changed
3 files changed +123
-5
lines changed Original file line number Diff line number Diff line change
1
+ ---
2
+ title : Markdownlint
3
+ sidebar_label : Markdownlint
4
+ description : CodeRabbit's guide to Markdownlint.
5
+ sidebar_position : 3
6
+ ---
7
+
8
+ [ Markdownlint] ( https://github.com/DavidAnson/markdownlint ) is a linter for Markdown files.
9
+
10
+ ## Files
11
+
12
+ Markdownlint will run on files with the following extensions:
13
+
14
+ - ` .md `
15
+ - ` .markdown `
16
+
17
+ ## Settings
18
+
19
+ Markdownlint supports the following config files:
20
+
21
+ - ` .markdownlint.jsonc `
22
+ - ` .markdownlint.json `
23
+ - ` .markdownlint.yaml `
24
+ - ` .markdownlint.yml `
25
+
26
+ CodeRabbit will use the following settings based on the profile selected if no config file is found:
27
+
28
+ ### Chill
29
+
30
+ ``` json
31
+ {
32
+ "default" : true ,
33
+ "line-length" : false ,
34
+ "no-duplicate-heading" : {
35
+ "siblings_only" : true
36
+ },
37
+ "no-trailing-punctuation" : {
38
+ "punctuation" : " .,;:"
39
+ },
40
+ "ol-prefix" : false ,
41
+ "list-marker-space" : false ,
42
+ "no-inline-html" : false ,
43
+ "first-line-h1" : false ,
44
+ "no-trailing-spaces" : false ,
45
+ "single-h1" : false ,
46
+ "blank_lines" : false ,
47
+ }
48
+ ```
49
+
50
+ ### Assertive
51
+
52
+ ``` json
53
+ {
54
+ "default" : true ,
55
+ "line-length" : false ,
56
+ "no-duplicate-heading" : {
57
+ "siblings_only" : true
58
+ },
59
+ "no-trailing-punctuation" : {
60
+ "punctuation" : " .,;:"
61
+ },
62
+ "ol-prefix" : true ,
63
+ "list-marker-space" : false ,
64
+ "no-inline-html" : true ,
65
+ "first-line-h1" : true ,
66
+ "no-trailing-spaces" : true ,
67
+ "single-h1" : true ,
68
+ "blank_lines" : true ,
69
+ }
70
+
71
+ ```
72
+
73
+ ## Links
74
+
75
+ - [ Markdownlint Configuration] ( https://github.com/DavidAnson/markdownlint?tab=readme-ov-file#configuration )
Original file line number Diff line number Diff line change 2
2
title : Ruff
3
3
sidebar_label : Ruff
4
4
description : CodeRabbit's guide to Ruff.
5
- sidebar_position : 1
5
+ sidebar_position : 2
6
6
---
7
7
8
- Ruff is a linter and code formatter for Python.
8
+ [ Ruff] ( https://docs.astral.sh/ruff/ ) is a linter and code formatter for Python.
9
+
10
+ ## Files
11
+
12
+ Ruff will run on files with the following extensions:
13
+
14
+ - ` .py `
9
15
10
16
## Settings
11
17
@@ -15,7 +21,7 @@ Ruff supports the following config files:
15
21
- ` ruff.toml `
16
22
- ` .ruff.toml `
17
23
18
- CodeRabbit will use the following settings if no config file is found:
24
+ CodeRabbit will use the following settings based on the profile selected if no config file is found:
19
25
20
26
### Chill
21
27
@@ -117,6 +123,6 @@ select = [
117
123
"**/{test,tests}/**/*.py" = [" S101" ]
118
124
```
119
125
120
- Links:
126
+ ## Links
121
127
122
- - [ Ruff] ( https://docs.astral.sh/ruff/configuration/ )
128
+ - [ Ruff Configuration ] ( https://docs.astral.sh/ruff/configuration/ )
Original file line number Diff line number Diff line change
1
+ ---
2
+ title : ShellCheck
3
+ sidebar_label : ShellCheck
4
+ description : CodeRabbit's guide to ShellCheck.
5
+ sidebar_position : 1
6
+ ---
7
+
8
+ [ ShellCheck] ( https://www.shellcheck.net/ ) is a linter for shell scripts.
9
+
10
+ ## Files
11
+
12
+ ShellCheck will run on files with the following extensions:
13
+
14
+ - ` .sh `
15
+ - ` .bash `
16
+ - ` .ksh `
17
+ - ` .dash `
18
+
19
+ ## Settings
20
+
21
+ CodeRabbit will use the following settings based on the profile selected:
22
+
23
+ ### Chill
24
+
25
+ ``` shell
26
+ --severity=warning
27
+ ```
28
+
29
+ ### Assertive
30
+
31
+ ``` shell
32
+ --severity=style
33
+ ```
34
+
35
+ ## Links
36
+
37
+ - [ ShellCheck Wiki] ( https://www.shellcheck.net/wiki/ )
You can’t perform that action at this time.
0 commit comments