Skip to content

Commit c112ecc

Browse files
docs: regal (#82)
1 parent 35d2a45 commit c112ecc

File tree

2 files changed

+28
-1
lines changed

2 files changed

+28
-1
lines changed

docs/tools/regal.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: Regal
3+
sidebar_label: Regal
4+
description: CodeRabbit's guide to Regal.
5+
---
6+
7+
[Regal](https://docs.styra.com/regal/) is a linter and language server for Rego.
8+
9+
## Files
10+
11+
Regal will run on files with the following extensions:
12+
13+
- `.rego`
14+
15+
## Configuration
16+
17+
Regal uses a YAML style configuration file. We look for the following config file:
18+
19+
- `.regal/config.yaml`
20+
21+
CodeRabbit will use the default settings based on the profile selected if no config file is found.
22+
23+
## Links
24+
25+
- [Regal Configuration](https://docs.styra.com/regal#configuration/)

docs/tools/tools.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ Remove extraneous f prefix
5555
| Plaintext | [LanguageTool][LanguageTool] |
5656
| Protobuf | [Buf][Buf] |
5757
| Python | [Ruff][Ruff] |
58+
| Regal | [Regal][Regal] |
5859
| Ruby | [Rubocop][Rubocop] |
5960
| Shell (sh, bash, ksh, dash) | [ShellCheck][ShellCheck] |
6061
| Swift | [SwiftLint][SwiftLint] |
@@ -79,4 +80,5 @@ Remove extraneous f prefix
7980
[Detekt]: ./detekt.md
8081
[Rubocop]: ./rubocop.md
8182
[Buf]: ./buf.md
82-
[Actionlint]: ./actionlint.md
83+
[Actionlint]: ./actionlint.md
84+
[Regal]: ./regal.md

0 commit comments

Comments
 (0)