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

Ignore specific files and/or lines in circomspect checks #12

Open
sripwoud opened this issue Jul 18, 2024 · 0 comments
Open

Ignore specific files and/or lines in circomspect checks #12

sripwoud opened this issue Jul 18, 2024 · 0 comments
Assignees
Labels
devops 🔧 Operations management and dev tools dx 🔧 Developer experience feature 🚀 This is enhancing something existing or creating something new

Comments

@sripwoud
Copy link
Member

Circomspect does not provide a way to configure override rules per warning and files.
However the way we integrated it in the CI relies on a SARIF (Static Analysis Results Interchange Format) file, which is JSON based.
So we should be able to edit this file on the fly to remove entries related to the warnings and files we want to ignore.
Consider using e.g a .circomspectignore.yaml to define override rules:

[ruleIdsGlob]:
  - circom/file/path
  - /circom/file/path
[ruleIdsGlob]:
  - /circomfile/path
  - /circom/file/path
@sripwoud sripwoud added devops 🔧 Operations management and dev tools dx 🔧 Developer experience feature 🚀 This is enhancing something existing or creating something new labels Jul 18, 2024
@sripwoud sripwoud self-assigned this Jul 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
devops 🔧 Operations management and dev tools dx 🔧 Developer experience feature 🚀 This is enhancing something existing or creating something new
Projects
None yet
Development

No branches or pull requests

1 participant