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.

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

Add regal eval:use-as-input directive #1088

Merged
merged 2 commits into from
Sep 10, 2024
Merged

Add regal eval:use-as-input directive #1088

merged 2 commits into from
Sep 10, 2024

Conversation

anderseknert
Copy link
Member

Placing # regal eval:use-as-input as the top comment in any policy will now have the code lens eval feature automatically use the roAST of that file as input, allowing you to query the file as you work on it.

eval_use_as_input

@anderseknert anderseknert changed the title Add regal eval:use-as-input directive Add regal eval:use-as-input directive Sep 9, 2024
the evaluation feature automatically use the AST of the file as input. This allows building queries against the AST of
the policy you're working on, providing an extremely fast feedback loop for developing new rules!

![Use AST of file as input](./assets/lsp/eval_use_as_input.png)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we need to use the MDX version of these again right?

<img
  src={require('./assets/lsp/diagnostics.png').default}
  alt="Screenshot of diagnostics as displayed in Zed"/>

Copy link
Member

@charlieegan3 charlieegan3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, see comment about image in docs page.

This is a really nice feature!

Placing `# regal eval:use-as-input` as the top comment in any
policy will now have the code lens eval feature automatically
use the roAST of that file as input, allowing you to query the
file as you work on it.

Signed-off-by: Anders Eknert <anders@styra.com>
A "comment block" should only count comments in sequence
when they are on the same column.

Fixes #1086

Signed-off-by: Anders Eknert <anders@styra.com>
@anderseknert anderseknert merged commit 3bbfd1e into main Sep 10, 2024
4 checks passed
@anderseknert anderseknert deleted the eval-use-as-input branch September 10, 2024 08:54
charlieegan3 added a commit to charlieegan3/regal that referenced this pull request Sep 10, 2024
Related StyraInc#1088

Signed-off-by: Charlie Egan <charlie@styra.com>
anderseknert pushed a commit that referenced this pull request Sep 10, 2024
Related #1088

Signed-off-by: Charlie Egan <charlie@styra.com>
srenatus pushed a commit to srenatus/regal that referenced this pull request Oct 1, 2024
Placing `# regal eval:use-as-input` as the top comment in any
policy will now have the code lens eval feature automatically
use the roAST of that file as input, allowing you to query the
file as you work on it.

Signed-off-by: Anders Eknert <anders@styra.com>
srenatus pushed a commit to srenatus/regal that referenced this pull request Oct 1, 2024
Related StyraInc#1088

Signed-off-by: Charlie Egan <charlie@styra.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants