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

[Proposal] - Refactor the program into more easily managed files #75

Open
simon-wg opened this issue Jul 11, 2024 · 8 comments
Open

[Proposal] - Refactor the program into more easily managed files #75

simon-wg opened this issue Jul 11, 2024 · 8 comments
Assignees
Labels
Status: Complete This pull request is ready to merge Type: Enhancement New feature or request

Comments

@simon-wg
Copy link
Contributor

I'm planning to do a major refactor once #73 is merged in order to make the program more easily maintainable.

The current structure of ~1500 lines is a bit rough to navigate when adding features. So dividing up the parts into their own files would provide an easier overview of the program, as well as make it easier to implement new features, and modify existing ones.

Thoughts on this? @AnthonyMichaelTDM

@simon-wg simon-wg added the Type: Enhancement New feature or request label Jul 11, 2024
@AnthonyMichaelTDM
Copy link
Owner

I absolutely agree, I've been meaning to start on that myself for a while now but keep putting it off, I'm looking forward to seeing what you do here and am absolutely willing to collaborate as necessary

@AnthonyMichaelTDM
Copy link
Owner

I think the first step would be to migrate things away from using global state, or to consolidate all that "state management" to a separate module, the idea being to have more of the functions be "pure".

@AnthonyMichaelTDM
Copy link
Owner

you can see what I started in the code-refactoring branch, probably better to start fresh though.

@simon-wg
Copy link
Contributor Author

I think I will start from scratch tbh. I'll probably start working on it tomorrow, and you can expect a PR around monday.

@wahlp
Copy link
Contributor

wahlp commented Jul 12, 2024

thank goodness. i was getting tired of all the global keyword appearances

@AnthonyMichaelTDM AnthonyMichaelTDM added the Status: In Progress This issue or pull request is currently being worked on label Jul 14, 2024
@AnthonyMichaelTDM
Copy link
Owner

AnthonyMichaelTDM commented Jul 14, 2024

Should I wait on releasing 1.9.1 (which will include some bug fixes (#83 and #84) and ergonomics improvements (#88)) for this to be done, or should we tackle this and #78 in 1.9.2?

I'm leaning toward the latter, but I'd like your input @simon-wg and @wahlp

@wahlp
Copy link
Contributor

wahlp commented Jul 15, 2024

I agree with tackling the enhancements later. Getting the bug fixes out sooner would be best.

@simon-wg
Copy link
Contributor Author

I agree that it's probably better to just release the fixes in 1.9.1.

As the progress is looking right now it will probably take a few more days to be "done" with the refactor. Adding proper testing afterwards will probably also take a couple of days.

@AnthonyMichaelTDM AnthonyMichaelTDM added Status: Complete This pull request is ready to merge and removed Status: In Progress This issue or pull request is currently being worked on labels Oct 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Complete This pull request is ready to merge Type: Enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants