Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Regal documentation #181

Merged
merged 2 commits into from
Jan 10, 2025
Merged

Update Regal documentation #181

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e80b02b
Update Regal documentation
charlieegan3 Dec 19, 2024
cdb9c2e
Merge branch 'main' into patch-1
guritfaq Jan 9, 2025
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
10 changes: 4 additions & 6 deletions docs/tools/regal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
<ProPlanNotice />
```

[Regal](https://docs.styra.com/regal/) is a linter and language server for Rego.
[Regal](https://docs.styra.com/regal/) is a linter and language server for Rego, the language of [Open Policy Agent](http://openpolicyagent.org) (OPA).

## Files

Expand All @@ -20,12 +20,10 @@ Regal will run on files with the following extensions:

## Configuration

Regal uses a YAML style configuration file. We look for the following config file:
Regal uses a YAML configuration file located at `.regal/config.yaml`.

- `.regal/config.yaml`

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

## Links

- [Regal Configuration](https://docs.styra.com/regal#configuration/)
- [Regal Configuration](https://docs.styra.com/regal#configuration)