tact-lang / tact

Tact compiler main repository
https://tact-lang.org
MIT License
267 stars 53 forks source link

Consider renaming folders in `stdlib/` and describing their internals #382

Open novusnota opened 1 week ago

novusnota commented 1 week ago

Motivation is simple: it's tough to distinguish between what goes into @stdlib/... libraries and what's generally available without importing. At the moment, stdlib/std/ holds what's available right away and stdlib/libs/ holds @stdlib/... libraries.

We may change it in the following manner:

Additionally, it can be useful to describe things in stdlib/ on the top-level somewhere in a README.md or a standalone ARCHITECTURE.md or CONTRIBUTING.md guide:

stdlib, Standard library:
|-- libraries/ or standard/ —
      Libraries one can import through `@stdlib/...`, "standard libraries"
|-- core/ — Auto-imported code, "core library"
|-- stdlib.fc — Standard library of FunC
|-- stdlib_ex.fc — Extension of standard library of FunC
`-- stdlib.tact or core.tact — Batch export of core/

Perhaps, even the folder itself can be renamed from stdlib to just std, which will simplify things furthermore: