[Feature Request][Help Offer] Get All References

[baweaver]

Hey all,

Gusto just recently open sources QueryPackwerk, which allows you to query packwerk violations in much the same way as you might query an ActiveRecord object. One of the key weaknesses of this gem is that it relies on Violations to run, and the ParsePackwerk gem to fuel them, meaning that if anything is added to a TODO it gets skipped.

Is there a way to potentially get all Packwerk references into a single list?

My hunch is yes, but I'm having a bit of trouble piecing together how to go about that. I think that using a Checker might be a path, and then trying to emulate a bit of how violations work today except trying to get rid of any exclusion clauses. Is that the right direction, or am I missing something? Currently trying to reconstitute this from the source code to see if I can cobble something together, but also wanted to check if something already exists or there's an easier way that I'm not seeing here.

TL;DR: I want to help create a way to get a list of all references in Packwerk, but could use a few pointers or some direction as this is not a documented path for the library.

If it does not exist I'd be up for helping to get it going, and adding it to tools like QueryPackwerk. I seem to remember a while ago I was chatting with Rafael about potentially even putting references into a SQLite3 DB of some sort to try and make tooling here even easier, but it's been a bit.

---

EDIT: I do see this PR looks to achieve what I'm looking for, could we consider merging it?

[exterm]

I think this is a common requirement and would love to see something like #397 merged. I am the author of that PR but am not currently working on a large Rails app and have limited time available; I'm happy to help in any way I can but if you @baweaver or anyone else want to take over that PR or open a new one I have no problem with that either.