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

Various Improvements #72

Open
7 tasks
MrHedmad opened this issue Feb 26, 2024 · 1 comment
Open
7 tasks

Various Improvements #72

MrHedmad opened this issue Feb 26, 2024 · 1 comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed low-priority This can be fixed, but not *right now*

Comments

@MrHedmad
Copy link
Owner

There are a few "technical debt"-y things that would be nice to fix:

  • Unit testing is still very limited, and more time could be used to generally add tests.
  • The code can be significantly refactored and made easier.
    • The execution module can be made better by breaking down long functions.
    • A mini-SDK over docker or podman to interact with them more safely.
    • A way (mutexes?) to hook into the CTRL-C binding without having to pass it as an argument everywhere.
    • Many functions have a ton of arguments. They could be condensed to a much safer and convenient struct, especially the functions that get called when a command is executed (so we use the same struct both in the signature and in the CLI, if we are smart enough).
    • Many functions are LONG. They should be broken up into testable bits and tested (see point above).

If more "smaller" thoughts come up, we can add them to this issue.

@MrHedmad MrHedmad added help wanted Extra attention is needed good first issue Good for newcomers low-priority This can be fixed, but not *right now* labels Feb 26, 2024
@MrHedmad
Copy link
Owner Author

MrHedmad commented Apr 5, 2024

The global CTRL-C hook maybe done with lazy_static, so that we allocate a static ref but that is initialized at runtime. It runs the hook creation logic just the one time and returns the binding as a static.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed low-priority This can be fixed, but not *right now*
Projects
None yet
Development

No branches or pull requests

1 participant