Mixed use of the tools/ directory

[MakisH]

Our tools/ directory currently contains:

• Tools meant to be copied by users when they want to extract a tutorial (e.g., log.sh)
• Tools used by pre-commit (e.g., check-size.sh)
• System tests related tools (tools/tests/)

This is rather confusing for users. I would suggest splitting this into:

• tools/: Only for user-facing scripts
• tests/: For the system tests

What do we then do with the scripts used by pre-commit? Alternatives:

• checks/ (ugh)
• pre-commit/ (clear for us, strange for someone that does not know what this is)
• keep them in tools/, but maybe in a subdirectory tools/pre-commit?

[uekerman]

AI suggests to use scripts/pre-commit/ as location for the pre-commit scripts.
tests for system tests sounds perfect.
tools should normally be dev-facing tools (not sure if we follow this rule elsewhere), user-facing tools could also go into bin/ apparently?

[atharvnandurkar]

@MakisH @uekerman Can I work on this issue.
Thinking of proposing the following restructuring:

Move tools/tests/ → tests/

Create a new scripts/pre-commit/ directory and move the pre-commit related scripts there.

Keep tools/ only for user-facing helper scripts.

Does this approach look good, or is there any preferences I should consider before creating a PR?

[MakisH]

@atharvnandurkar thank you for showing interest, but please better leave this issue to me, as it has quite a few side implications inside and outside this repository. I also do not want to touch the directory structure at the moment due to other work (e.g., my in-progress dissertation) referring to it.

The discussion and ideas would be very useful, though, as we have not converged yet.

The scripts/ directory would be difficult to tell from tools/. pre-commit/ sounds better, but also restricts to pre-commit, while there might be more development-oriented tools as well.

[atharvnandurkar]

@atharvnandurkar thank you for showing interest, but please better leave this issue to me, as it has quite a few side implications inside and outside this repository. I also do not want to touch the directory structure at the moment due to other work (e.g., my in-progress dissertation) referring to it.

The discussion and ideas would be very useful, though, as we have not converged yet.

The scripts/ directory would be difficult to tell from tools/. pre-commit/ sounds better, but also restricts to pre-commit, while there might be more development-oriented tools as well.

@MakisH Understood.

[MakisH]

I moved the tests out of tools/ into tests/ in #900. Now that I think of it, .tests/ might be even better - I will look at it again after the related open PRs have been merged.

For the rest of the tools, I moved them into .dev-tools/ in #904. Feedback (supporting or protesting) would be very welcome.

With these suggestions, we would end up with:

- .dev-tools/
  - releasing/
  - linting/
- .tests/
  - (system tests files)
- aste-turbine/
- ... (other tutorials)
- tools/
  - clean.sh
  - log.sh
  - ...

We could then also rename runs/ to test-runs/ or .test-runs/. That would keep that directory close to the tests/ / .tests/ and make its purpose clearer.