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

Reconsider the necessity of ReportPass #544

Open
aviatesk opened this issue Jun 25, 2023 · 3 comments
Open

Reconsider the necessity of ReportPass #544

aviatesk opened this issue Jun 25, 2023 · 3 comments
Labels
internals Refactoring ideas

Comments

@aviatesk
Copy link
Owner

While working on #543 I realized that the current design of ReportPass might not be functioning as effectively as hoped. Originally, ReportPass was meant to allow users well-versed in JET internals to completely ignore specific reports, thereby deleting associated calculations (which can not be achieved by filtering out reports after the analysis has been completed). However, there seems to be a lack of such advanced users at present, and this is inadvertently increasing the complexity of the code base, potentially discouraging potential contributors. It might be beneficial to shift towards a simpler configuration style that can control specific behaviors of the analysis with in the short term.

@nantiamak
Copy link

We're thinking of using ReportPass to create a custom report mode that combines mode:=typo with MethodErrors. Our codebase is quite large and when running JET on mode:=basic, we've noticed that we can get a non-negligible number of false positives. Thus, we were hoping to create this custom report to restrict the analysis to the errors that are most important to us.
So, I was wondering whether the plan is still to deprecate ReportPass in the future.
If that's the case, then would you consider adding an intermediate mode between typo and basic that generates MethodError as well?

@aviatesk
Copy link
Owner Author

Hello. Sorry for the delayed response.
Currently, I plan to deprecate ReportPass and reimplement it as ReportConfig, which will have a simpler interface. Even with ReportConfig, it should still be possible to implement a new configuration that reports MethodError in addition to those reported with :typo-mode.

@nantiamak
Copy link

Thanks for the reply @aviatesk!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
internals Refactoring ideas
Projects
None yet
Development

No branches or pull requests

2 participants