Module structure - to mod.rs or to not mod.rs? that is the question.

[Ben-PH]

This question emerged from #3441. Do we go for a structure that looks like this:

├── foo
│   ├── mod.rs
│   └── foo_sub_module.rs
├── ledger_db.rs
├── ledger.rs
├── lib.rs
...

or more like this?

.
├── foo.rs
├── foo
│   └── foo_sub_module.rs
├── ledger_db.rs
├── ledger.rs
├── lib.rs
...

or is it one of those things that spending any time on it is just time lost to bike-shedding?

For me, I prefer not to have mod.rs in my directory structure for various reasons. Without going into detail, I just find things are easier to work with in that case.

[AurelienFT]

We often use the mod.rs in test to specify to export or not some of the public functions/methods depending on the features we are compiling with (often testing or not)

[AurelienFT]

Do you have current example when we have mod.rs in sub-modules ?

[Ben-PH]

https://github.com/massalabs/massa/tree/main/massa-models/src/config

[AurelienFT]

In your mind we should have multiple files directly at the root of module or one big file ?

[Ben-PH]

In my mind, mv mod.rs ../config.rs would be in line with what I'm proposing.

[AurelienFT]

Does that work to have import of submodule in a file of the parent directory ?