Use default_path instead of paths for Twig and Translator config #434

yceruto · 2018-07-11T16:26:57Z

Q	A
License	MIT

Fix #416 (comment)

ghost

Pull request passes validation.

xabbuh · 2018-07-12T07:58:44Z

Is this really a good idea? Showing the paths option has the advantage that developers can easily discover where to add new paths. Now they may change the setting here thus overriding the default value coming from Symfony core which would then in turn change the behaviour of the app.

javiereguiluz · 2018-07-12T08:01:46Z

I agree with Christian. I've changed the paths option of Twig in lots and lots of projects. Not sure if for others is common too ... but if it is, this change makes it harder to do that.

Pierstoval · 2018-07-12T08:03:05Z

For new projects it might not be that common, as templates should still be stored under templates/

fabpot · 2018-07-12T08:47:24Z

I would really be surprised if many people were overriding the paths. I cannot even think of one good reason to do that. But I understand the point. But:

if one changes the default_path, they will realized really fast that it breaks everything.
we try to not have all possible options in config files, meaning that we don't want to replace documentation here.

yceruto · 2018-07-12T14:05:29Z

Redefining the default path again in twig.paths is not a good idea either, people might think that changing it they're moving the default template dir to another place, and that's not true, they might be surprised why templates/ dir is still working (if it exists)... Edit: and why for example debug:translation and translation:update commands don't work (which aren't compatible with all Twig paths, only the default ones)

stof · 2018-07-12T15:14:31Z

Registering the existing default path in paths has another drawbacl: it means the path gets registered twice (as the default path is still registered), which was leading to bug reports about paths appearing twice in error messages

yceruto · 2018-08-07T13:28:23Z

@stof That means you agree with this change, right? Could I get the last approval then?

javiereguiluz · 2018-08-09T06:56:46Z

Related to this, someone asked about this yesterday on Slack:

What are the Twig class that are in charge to look for templates in directories?
I'd like to customize them to add some logic (go look inside this folder, then
another one, then take default behaviour)

They replied him:

twig:
    paths: ['%kernel.project_dir%/templates/plymouth', '%kernel.project_dir%/templates']

And he said:

thanks I thought i was going to write a TemplateGuesser

Apart from this, I understand what you say about default_path being defined twice. But don't you think the real problem is defining default_path itself? Not sure if possible but:

We could add a super simple condition that checks if default_path is already in paths and remove it to avoid duplications.
We could remove default_path and just use paths. If you absolutely need a default path, make it the first (or the last) element of paths?

ghost

Pull request passes validation.

yceruto · 2018-08-09T14:57:41Z

if changing this configuration is really frequent and useful then it has won the place to appear by default. How does this look now?

xabbuh · 2018-08-09T16:21:28Z

symfony/twig-bundle/3.3/config/packages/twig.yaml

@@ -1,4 +1,6 @@
 twig:
+    # additional templates paths


additional template paths

xabbuh · 2018-08-09T16:21:36Z

symfony/translation/3.3/config/packages/translation.yaml

@@ -1,6 +1,8 @@
 framework:
    default_locale: '%locale%'
    translator:
+        # additional translations paths


additional translation paths

ghost

Pull request passes validation.

yceruto · 2018-09-04T17:49:34Z

symfony/symfony#27764 (comment) it's another reason to make this change. Setting the default path in Twig paths doesn't excludes the bundles/ directory on cache warmup and the overridden templates are cached using the wrong template name.

stof · 2018-09-05T08:42:08Z

symfony/translation/3.3/config/packages/translation.yaml

-            - '%kernel.project_dir%/translations'
+        # additional translation paths
+        #paths: []
+        default_path: '%kernel.project_dir%/translations'


Are you sure default_path works here ? IIRC, it is a Symfony 3.4+ feature, while this recipe applies to 3.3+

Yes, but I'm following the same approach that @nicolas-grekas in the previous PR:

#416 (comment) (3.3 is EOLed so we don't really care for it)

a recipe is for new projects 99%, and no new project will use this recipe ever (or at least we don't care IMHO)

but then, it would be better to migrate this recipe to be 3.4+ and have no recipe at all for 3.3, than to have a 3.3+ recipe triggering an error on 3.3

nicolas-grekas · 2018-09-05T13:52:54Z

symfony/translation/3.3/config/packages/translation.yaml

@@ -1,7 +1,8 @@
 framework:
    default_locale: '%locale%'
    translator:
-        paths:
-            - '%kernel.project_dir%/translations'
+        # additional translation paths


maybe we should remove this one? I'm not sure it's that common to add more paths, so better keep the config simpler? (same below of course)

I think so too, but there is no consensus about that (others member think otherwise) at least for Twig paths. See previous comments.

javiereguiluz · 2018-09-05T14:18:03Z

I still think that we should display paths (for Twig, not translations) ... but this is based on my own experience. If most people think it's better to not display it, let's do that so we can merge this fast. If we receive complaints from users, we can easily change this later.

ghost

Pull request passes validation.

yceruto · 2018-09-05T15:05:29Z

Removed translations paths only.

nicolas-grekas · 2018-09-05T15:08:42Z

symfony/twig-bundle/3.3/config/packages/twig.yaml

-    paths: ['%kernel.project_dir%/templates']
+    default_path: '%kernel.project_dir%/templates'
+    # additional template paths
+    #paths: []


@javiereguiluz can you hint when this is needed? Still feels like something we could clean :)
Any other opinion from anyone else?

In real apps I've used it 1) to add another directory where templates were defined (yes, I know, this is the obvious purpose!), 2) on symfony.com app I use it to define Twig namespaces, 3) in some personal apps I use it to add public/static/images/ as a directory for templates. Why? Because that way I can use the SVG icons as regular images in SCSS and embed them in Twig templates with {{ source('icons/-------.svg') }}

But again, if most people never change this option, let's remove it from the default config file. Thanks!

Going back to the simpleness version, anyway it's well documented.

ghost

Pull request passes validation.

Use default_path instead of paths for Twig and Translator config

85ff539

ghost deployed to staging July 11, 2018 16:27 View deployment

ghost approved these changes Jul 11, 2018

View reviewed changes

yceruto mentioned this pull request Jul 11, 2018

[symfony/twig-bundle] remove "paths", thats already the default #416

Closed

fabpot approved these changes Jul 12, 2018

View reviewed changes

Pierstoval approved these changes Jul 12, 2018

View reviewed changes

ghost deployed to staging August 9, 2018 14:53 View deployment

ghost approved these changes Aug 9, 2018

View reviewed changes

xabbuh reviewed Aug 9, 2018

View reviewed changes

yceruto force-pushed the default_path branch from 99340d4 to 46afbf6 Compare August 9, 2018 16:40

ghost deployed to staging August 9, 2018 16:40 View deployment

ghost approved these changes Aug 9, 2018

View reviewed changes

maxhelias approved these changes Aug 19, 2018

View reviewed changes

stof reviewed Sep 5, 2018

View reviewed changes

nicolas-grekas reviewed Sep 5, 2018

View reviewed changes

add config suggestion for addition paths

cc439b6

yceruto force-pushed the default_path branch from 46afbf6 to cc439b6 Compare September 5, 2018 15:03

ghost deployed to staging September 5, 2018 15:03 View deployment

ghost approved these changes Sep 5, 2018

View reviewed changes

nicolas-grekas reviewed Sep 5, 2018

View reviewed changes

removing Twig paths comment

499af21

ghost deployed to staging September 8, 2018 12:01 View deployment

ghost approved these changes Sep 8, 2018

View reviewed changes

fabpot approved these changes Sep 8, 2018

View reviewed changes

xabbuh approved these changes Sep 8, 2018

View reviewed changes

ghost merged commit 499af21 into symfony:master Sep 8, 2018

ghost pushed a commit that referenced this pull request Sep 8, 2018

Merge pull request #434

002d2a5

yceruto deleted the default_path branch September 9, 2018 01:17

Kryniol mentioned this pull request Jan 2, 2019

Add Symfony Flex support boldare/xsolve-face-validator-bundle#26

Open

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use default_path instead of paths for Twig and Translator config #434

Use default_path instead of paths for Twig and Translator config #434

yceruto commented Jul 11, 2018

ghost left a comment

xabbuh commented Jul 12, 2018

javiereguiluz commented Jul 12, 2018

Pierstoval commented Jul 12, 2018

fabpot commented Jul 12, 2018

yceruto commented Jul 12, 2018 •

edited

Loading

stof commented Jul 12, 2018

yceruto commented Aug 7, 2018

javiereguiluz commented Aug 9, 2018

ghost left a comment

yceruto commented Aug 9, 2018 •

edited

Loading

xabbuh Aug 9, 2018

xabbuh Aug 9, 2018

ghost left a comment

yceruto commented Sep 4, 2018

stof Sep 5, 2018

yceruto Sep 5, 2018

nicolas-grekas Sep 5, 2018

stof Sep 5, 2018

nicolas-grekas Sep 5, 2018

yceruto Sep 5, 2018

javiereguiluz commented Sep 5, 2018

ghost left a comment

yceruto commented Sep 5, 2018

nicolas-grekas Sep 5, 2018

javiereguiluz Sep 5, 2018

yceruto Sep 8, 2018

ghost left a comment

Use default_path instead of paths for Twig and Translator config #434

Use default_path instead of paths for Twig and Translator config #434

Conversation

yceruto commented Jul 11, 2018

ghost left a comment

Choose a reason for hiding this comment

xabbuh commented Jul 12, 2018

javiereguiluz commented Jul 12, 2018

Pierstoval commented Jul 12, 2018

fabpot commented Jul 12, 2018

yceruto commented Jul 12, 2018 • edited Loading

stof commented Jul 12, 2018

yceruto commented Aug 7, 2018

javiereguiluz commented Aug 9, 2018

ghost left a comment

Choose a reason for hiding this comment

yceruto commented Aug 9, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ghost left a comment

Choose a reason for hiding this comment

yceruto commented Sep 4, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

javiereguiluz commented Sep 5, 2018

ghost left a comment

Choose a reason for hiding this comment

yceruto commented Sep 5, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ghost left a comment

Choose a reason for hiding this comment

yceruto commented Jul 12, 2018 •

edited

Loading

yceruto commented Aug 9, 2018 •

edited

Loading