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…

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…

Afaik phoenix opted out of the convention to prevent having tons of .Controller and .View modules.

[image] boydm: I would prefer a module name of MyAppWeb.Controller.Page , which (to me) denotes that it is a single controller. My perspective on MyAppWeb.Controllers.Page: Page module in the MyAppWeb.Controllers “namespace” therefore I expect Page to be a single controller - one among many…

[image] boydm: 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. [image] boydm: When it comes to Scenic, it made sense to…

[image] joeerl: (the name changed from MyApp to my_app seems strange – file names are UTF8 so I don’t see why camel case files names are not used) I’ve noticed that myself, I’ve accidentally let slip a camel-cased filename in my folders… ^.^; [image] josevalim: In Elixir, we usually fol…

[image] OvermindDL1: I prefer the MyAppWeb.Controllers.Page style too, but that is harder to macro’ize automatic linking with Views and all as the ‘Controllers’ part could be arbitrarily higher from the current controller name if you use a hierarchy and such things, so for macro’ing reasons havi…

I believe the reason that Phoenix has PostController instead of Controllers.Post is that it’s pretty common to alias modules and it wouldn’t be possible to have in the same module the following: # contrived: alias Controllers.Post alias Views.Post alias Blog.Post A good example where not sticking …

Module naming conventions

Questions & Help Questions

boydm September 17, 2018, 4:58pm 16

Ah. That makes sense. I’m not trying to macro-ize anything, so am going to try to stick with the more readable name.