typetools / typetools/checker-framework
Integrating the Checker Framework in other static analysis tools?
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 1.1k
- Forks
- 440
- Avg merge
- 1d 12h
- Merged PRs (30d)
- 134
Description
I would like to ask whether it is feasible to use the functionality of the Checker Framework within another static analysis tool.
For example, suppose a static analysis tool performs a number of passes over a program, and a pass may produce some artifacts that might be consumed by future passes/analyses (much like a compiler).
I would like to develop a checker that can execute over the program, just like another analysis/compiler pass, which also has access to the system's own data structures (not just that of the Checker Framework).
I am aware of prior work that does similar things (or perhaps exactly demonstrates what I am asking for), such as NullAway or Error Prone. However, I don't think the process by which tool developers might integrate the Checker Framework with their own tools is documented in the manual – I am happy to update the manual if such a process can be described/standardized!
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the Checker Framework manual and compare the integration approaches used by NullAway and Error Prone. Determine whether a general process for running a checker within another tool can be described; done means the supported integration guidance and relevant limitations are documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100