discussion: individual formula layout

[timotheecour]

• refs: first wrapper: soloud #6 (comment)

Why not soloud.nim? Every directory will have wrapper.nim this way.

goals

• a formula should be easy to import for client code, eg: import soloud
• everything related to a formula should be self-contained in either a single file or a single dir but (preferably...) not both, eg not:

soloud.nim
./soloud/

https://github.com/dlang/phobos/blob/master/std/range/package.d

• formulas should be able to evolve from single file to directory without breaking client code

proposal 1 (requires nim compiler support)

• this would require Nim compiler support which allows a special file package.d, eg:
  foo.d gets later migrated to foo/package.d
• example: https://github.com/dlang/phobos/blob/master/std/range/package.d
• docs for that feature: see https://dlang.org/spec/module.html#package-module

  A package module can be used to publicly import other modules, while enabling a simpler import syntax. It enables converting a module into a package of modules, without breaking existing code which uses that module

proposal 2 (without nim compiler support)

when upgrading from a single file foo.d to a directory foo/, we can do this:

• before:

# in foo.nim:
# wrapper code goes here

• after:

# in foo.nim:
# only 2 lines, eg:
import foo/wrapper
export wrapper

# in foo/wrapper.nim
# wrapper code goes here

# in foo/demo.nim
# demo code goes here

# etc: additional files specific to formula can be added