Twig template naming convention

[pulzarraider]

Correct me if I am wrong, but Symfony2 documentation does not specify if filename of Twig template should be written in camelCase (articleDetails.html.twig) or with underscores (article_details.html.twig).

In Symfony naming conventions is note:

Use alphanumeric characters and underscores for file names;

But in Including other templates doc section is mentioned template filename in camel case: articleDetails.html.twig

In the majority of open source bundles there are underscores used in template filenames (for example Sonata, KnpPaginatorBundle,MopaBootstrapBundle, GenemuFormBundle, AdmingeneratorGeneratorBundle), but some use camelCase filenames (FOSFacebookBundle) or they mix it together (for example FOSUserBundle, FOSMessageBundle).

So what`s the recommended way? This should be clearly explained in documentation.

Also Twig coding standars should be linked somewhere in documentation: http://twig.sensiolabs.org/doc/coding_standards.html

[Sydney-o9]

+1 This is a really good point! I would be very happy to know the answer to that question too.

Same here, please explain it. I found another example in symfony documentation where camel case is used - http://symfony.com/doc/2.2/book/templating.html#embedding-controllers

[wouterj]

I find the 'use underscore for file names' pretty strange. Most of the filenames are the same as the class in the file (because of autoloading) and thus are camelCase...

I always use underscores for template file names, but I don't know if that is the standard. I'd like to know the opinion of more people and some core devs. before putting it in the docs.

As for the twig coding standards, I'm pretty sure it's mentioned somewhere. If it's not, create a PR which adds a .. tip:: directive somewhere at the start of book/templating.

[wouterj]

I created a poll to see which method people use: http://goo.gl/QSKwd

👍 exactly what i'm looking for.

[fazy]

When does the poll close? I really don't mind either outcome, but I would like to standardise internal projects to match.

@wouterj I am also curious about the results

[wouterj]

will post the results tomorrow, together with a bundle survey.

[juliensnz]

+1 for me !

[wouterj]

As I promised. The poll result was 56% for underscores and 44% for pascalCase/camelCase.

Because it's so close, I took a look at the top bundles on knpbundles. I checked only the bundles which contain templates and in which you can see the use of underscores or pascalCase. It results in: 78% underscore, 7% pascalCase and 15% mix (e.g. userDefault_foo.html.twig)

I think it's save to say that using underscores is the way to standardize.

[stof]

I guess I can give one reason for the difference: shared bundles don't depend on SensioFrameworkExtraBundle, so they can name the template the way they want.
People relying on the @Template annotation have to use pascalCase to match the action name.

[fazy]

@stof that's very interesting because it suggests it's not just a matter of preference but, if I understand correctly, there's an actual benefit to using pascalCase, i.e. you can just do @Template() instead of @Template("MyBundle:Controller:action_name.html.twig").

So, should the balance actually tip in favour of pascalCase? Or do we go with underscores but maybe do a PR for SensioFrameworkExtraBundle so it can guess based on _ names as well?

The point is, if pascalCase is used by @Template annotation, this should be a convention to naming the views. I'm wrong ?

[wouterj]

First of all, it's a convention and not a standard. That means that nobody have to follow it, it's just the recommend way.

@stof's reason seems to be a good one. We can do 2 things: (1) edit the filename conventions, it doesn't make sense nowadays as all file names of classes have uppercase letters in it or (2) request a change to the frameworkextrabundle to let it guess the pascalCase or the underscore version.
I'm +1 for the first option.

[ArlingtonHouse]

In Mac OSX, all lowercase file names work locally for @template, but fails when moving the project to an ubuntu server.