Replacing Peak template path with an automated file locator

[kungphung]

The Peak starter comes with antlers templates where you can add custom lines manually to show where the file is located in the 'view' folder.

In our projects we had automated this progress and we would like to have this in the Peak starter.

Peak example

Our example

In every new created antlers file the function will add the new line on top of the file with the path where the file is located therefore you don't have to add this line manually.

Also when your APP_DEBUG in your .env has the value "false" will hide/skip this function.
We have this in our production .env

With function

Without function

If there are enough upvotes for this new feature maybe @robdekort can implement this in the starter.

[robdekort]

Hey Phung. Thanks. This came up before and I'm not a fan to be honest. It's a lot of conditionals just to get a few comments out that no end user will see. I don't really see the point. And for performance reasons I prefer the manual way.

I assume tid is a custom tag? It still needs a manual parameter. When I compare it to the output it doesn't seem much time is saved.

Did you know when you run php please peak:add-block or php please peak:add-set it automatically generates the comments for you?

[kungphung]

Hi @robdekort ,
(1.) My proposal is to add the tag TID that checks if environment is in development mode or production to show the (2.)TID(template in directory)
(3.) There is actually no problem showing the comments with the file path in the DOM, but I think it is cleaner not showing it. The function checks the environment first so I don't think things slow down (I assume :-) ).

[sjclark]

@kungphung 😄 whats the reason for this though - I'm assuming you've added this because your code editor can navigate straight to the file? (but can't from within the comment tag, in which case you might want to use one of the plugins that displays related files like https://marketplace.visualstudio.com/items?itemName=rioj7.html-related-links

Statamics code output always looks like trash anyways (❤️ ) so I don't really think the comments do anything bad - I personally prefer them when trying to do the odd front-end production diagnosis.

But it doesn't really feel worth the extra complexity to add the function/tag above - although it could be a candidate for some sort of independent addon that automatically adds links to related files?

If it's important to your internal workflow you could potentially just do a find and replace to achieve the same thing? Your function/tag is just replacing the start and end of the default view string in the comments with something else? 🤷‍♂️

[robdekort]

Hey Phung.

Thanks! I'm very sorry to say but this is not something I feel Peak needs. Every time the tag gets called there's a conditional triggering and I simply don't see the benefit of shipping a cleaner source code. The rendered HTML is the only thing important for end users. Adding complexity with a tag feels a bit like over engineering to me.

If you do add a tag for your use I'd def. consider fetching the path in PHP so you don't have to manually add that all the time. You could write a script that finds and replaces this automatically for you using a regex maybe.

No hard feelings I hope. Keep them ideas coming pls.

Best!

[kungphung]

Hi @robdekort and @sjclark,
No hard feelings indeed. I was just wondering what your thought was about this feature.
I allready have this in our project and I wil continue using this with your fabulous work with Peak :)
I will close this discussion.

Thnx for considering.

[robdekort]

Good to hear. TY.