Architecture/Exposing a library crate #255
Draft
+996
−0
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We've had some conversation of how it would be nice to reuse parts of scope as a library.
Particularly, the analyze/fix functionality would be a high value item to extract into a crate that could be published and imported into other rust programs.
In it's current state, there really is no intentional public API and a fair amount of the cli is mixed into various modules (both as
feature/cli.rsmodules and peppered throughout the code).This document attempts to capture the current state, identify things that may cause problems for us when attempting to solidify & publish a public API, and establish a potential path forward/goal state.
I'm not sure if we want to merge it or not, but a PR does provide a convenient way to leave comments/thoughts.
I obviously used an LLM to assist me in creating the document, but I reviewed and edited it myself. It's pretty accurate and the approach it lays out for refactoring is pretty solid IMO.