From 5b13bb52488cb21847d585b4fb8e462b38596814 Mon Sep 17 00:00:00 2001 From: Ruhan Date: Thu, 22 Aug 2024 20:08:52 +0530 Subject: [PATCH] docs: regal --- docs/tools/regal.md | 25 +++++++++++++++++++++++++ docs/tools/tools.md | 4 +++- 2 files changed, 28 insertions(+), 1 deletion(-) create mode 100644 docs/tools/regal.md diff --git a/docs/tools/regal.md b/docs/tools/regal.md new file mode 100644 index 00000000..eeca3664 --- /dev/null +++ b/docs/tools/regal.md @@ -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/) diff --git a/docs/tools/tools.md b/docs/tools/tools.md index 0ff05661..c5265955 100644 --- a/docs/tools/tools.md +++ b/docs/tools/tools.md @@ -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] | @@ -79,4 +80,5 @@ Remove extraneous f prefix [Detekt]: ./detekt.md [Rubocop]: ./rubocop.md [Buf]: ./buf.md -[Actionlint]: ./actionlint.md \ No newline at end of file +[Actionlint]: ./actionlint.md +[Regal]: ./regal.md \ No newline at end of file