search

hrszpuk / rectx

The powerful little project manager for the ReCT programming language!
GNU General Public License v3.0
6 stars 1 forks source link

Refactored multiple rectx modules in peparation for CLI merge #3

Closed hrszpuk closed 2 years ago

hrszpuk commented 2 years ago

Refactoring multiple rectx modules

Issues

Known issues about the code this PR fixes:

  1. main.rs is hard to read (contains 3 modules)
  2. Some code is lacking comments
  3. Lack of management for what features to add next

Solutions

The solutions provided by this pull request for the issues described above:

  1. Move each module into it's own file:
    • cli module -> cli.rs
    • manager module -> manager.rs
    • config module -> config.rs
    • (Future modules will also be given their own file from this point forward...)
  2. Added wayyy more code comments (including to new module files)
  3. Added TODOs, milestones, and roadmap:
    • Roadmap: the roadmap has been around for a while now (#1)
    • GitHub milestones for each major version of the roadmap (v1.0.0, v2.0.0, and v3.0.0)
    • The code has been invaded by TODO comments which will keep track of what need to be completed next -- I hope to use this feature more in the future as well