I have been studying the scenic code and have a question about the module naming convention. Here’s my problem - I quickly discovered that the first module to be called was MyApp so I wondered where the code was. It happens to be in a file called my_app.ex- this then supplies a module name MyApp.S…

Hi @joeerl ! In Elixir, we usually follow a direct mapping from module name to file name. So a file named MyApp.Sensors.Supervisor should be put in lib/my_app/sensors/supervisor.ex. So maybe you want to report this to the scenic project and get their $.02 on the topic. Note it is just a convention t…

Hi @josevalin - I’m not sure about this convention. Breaking the convention will confuse people. Suppose you have a single module defining say JoesApp.lib.misc and put it in a file called crypto/utilities/rsa.ex this will confuse everybody and is a violation of the principle of least astonishment. …

[image] joeerl: A counter case would be when the file names is (say) the SHA1 of the content How do you edit these files? Do you update the filename on each save? This sounds unworkable

Edit with a regular text editor - you could use one file per save or make a write-append file and save diffs. It’s very workable. GIT essentially does this - but the granularity is “per commit” and not “per file save” - I wrote a wiki years ago that saved all old versions of everything forever - it…

[image] joeerl: Suppose you have a single module defining say JoesApp.lib.misc and put it in a file called crypto/utilities/rsa.ex this will confuse everybody and is a violation of the principle of least astonishment. If you have hundreds of thousands of modules then you’ll have to build an inde…

[image] joeerl: Of course, the user should never be aware of the SHAs of the file but see ‘regular’ file names. Ok, that makes sense. I thought you meant user-visible SHA-based names. I like your approach, yeah. I think version control should be more integrated in the systems we use everyday. …

I’ve found that generally in Elixir and Phoenix we don’t pluralise (pluralisation does happen in other frameworks in other languages, like Rails, however it can get messy with edge cases, such as ‘octopus’!). Naming conventions help a lot in frameworks, so for instance Phoenix will infer the name o…

@joeerl I think it’s important to understand that not everyone uses the same tools and while putting everything in one directory may work for you it doesn’t for plenty of others. I’ve experienced what you’re describing with Swift (and maybe Obj-C too?). Apple’s XCode editor organizes source files in…

In general, I’ve been trying to follow the non-plural forms. The only exception has been the Scenic.Primitives and Scenic.Components modules, which are collections of helper files to instantiate those data structures. I’ll go review the scenic_new project. Came together late in the game…

@joeerl This is a really good question. When I set up the scenic_new project I took a look at Phoenix and tried to replicate the pluralization there. When you run mix phx.new my_app, it creates a lib/controllers folder, but the modules within have controller in the singular form. Same goes for vie…

Module naming conventions

Questions & Help Questions

josevalim September 16, 2018, 7:25pm 6

Exactly. The convention would ask you to put it inside lib/joes_app/lib/misc.ex. So as long as you follow the convention, not surprises should arise.