Skip to content
This repository was archived by the owner on Aug 16, 2025. It is now read-only.

docs: regal #82

Merged
merged 1 commit into from
Aug 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions docs/tools/regal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: Regal
sidebar_label: Regal
description: CodeRabbit's guide to Regal.
---

[Regal](https://docs.styra.com/regal/) is a linter and language server for Rego.

## Files

Regal will run on files with the following extensions:

- `.rego`

## Configuration

Regal uses a YAML style configuration file. We look for the following config file:

- `.regal/config.yaml`

CodeRabbit will use the default settings based on the profile selected if no config file is found.

## Links

- [Regal Configuration](https://docs.styra.com/regal#configuration/)
4 changes: 3 additions & 1 deletion docs/tools/tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ Remove extraneous f prefix
| Plaintext | [LanguageTool][LanguageTool] |
| Protobuf | [Buf][Buf] |
| Python | [Ruff][Ruff] |
| Regal | [Regal][Regal] |
| Ruby | [Rubocop][Rubocop] |
| Shell (sh, bash, ksh, dash) | [ShellCheck][ShellCheck] |
| Swift | [SwiftLint][SwiftLint] |
Expand All @@ -79,4 +80,5 @@ Remove extraneous f prefix
[Detekt]: ./detekt.md
[Rubocop]: ./rubocop.md
[Buf]: ./buf.md
[Actionlint]: ./actionlint.md
[Actionlint]: ./actionlint.md
[Regal]: ./regal.md