Proposed a new article about using pure PHP libraries with Assetic #5166

javiereguiluz · 2015-04-10T15:40:19Z

Q	A
Doc fix?	no
New docs?	yes
Applies to	all
Fixed tickets	-

In #5159 @wouterj proposes to create a new Cookbook section dedicated to frontend articles. I think it's a great idea and in this pull request I propose an article showing how to use pure PHP libraries to combine, compile and minimize CSS, SCSS and JS files.

rvanlaak · 2015-04-13T10:08:16Z

cookbook/frontend/assetic_php.rst

+
+            {% stylesheets filter="scssphp" output="css/app.css"
+                "assets/scss/bootstrap.scss"
+                "assets/scss/font-awesome.scss"


Maybe add a reference about managing FontAwesome using Bower here?

I don't think that's a good idea, because this article is about using PHP only libraries. But once the Bower article written by @wouterj is published, we can indeed add a link to it in the introduction of this article (where we say "JS is the best for this"). I think taht would make a lot of sense. Thanks!

👍 for adding a note. My point is that it should be clear that managing (minimize, compile) web assets with PHP is possible, but checking in "assets/scss/font-awesome.scss" in the VCS is not needed if a package manager like Bower is used.

👍 interesting point, yeah maybe a # this is required when done PHP exclusive compilation of assets

rvanlaak · 2015-04-13T14:51:26Z

As mentioned in #5166 (comment) What about compiling a file that is managed by a package manager?

The example I'd like to be clear is: the scss files from FontAwesome can be managed using Bower, and can be compiled using scssphp. They even can be imported in the project's scss files right?

javiereguiluz · 2015-04-13T14:54:58Z

@rvanlaak let me explain the purpose of this article: the idea is to explain how to do the usual web asset stuff WITHOUT using any JavaScript tool or technology (Bower, Gulp, Grunt, ...).

This article shows how can you achieve everything with Assetic and two PHP libraries while setting up everything in just a few minutes. So the FontAwesome files, as long as Bootstrap and jQuery files, should be committed to the repository and stored in the web/assets/ directory, as explained in the article.

cordoval · 2015-04-13T14:56:30Z

i think this article should include packages such as robloach component or other bundles that bring in third party stuff. The path should be adaptable to point to those things without needing to persist the assets into the repository which is a very bad practice.

javiereguiluz · 2015-04-13T15:01:11Z

@cordoval I'm afraid that adding JavaScript stuff or third-party bundles into this article can't be possible.

The intro of the article says: "using JavaScript for doing this stuff is the best way to do it" and provides a link to that solution. But if you can't or don't want to use JavaScript, then you have this article which explains the simple and pragmatic way to do it using only PHP.

cordoval · 2015-04-13T15:06:20Z

I think you are not understanding what i am saying. Let me rephrase it and reiterate it to make it plain.

I mentioned @RobLoach's component only in the sense to bring css in, it has php packages that bring assets and js as well. Notice there is no js involved here. Repeating for emphasis here, they are not the js method to bring assets in. These are purely php. That said I hope is clear up to this point. I was never talking about js way of bringing assets here, which I am afraid you misunderstood.

That said, there is no need then to persist these things into the repository, or at least there is no need to persist them all. It can be done right with php as well, or the most right way with only php.

javiereguiluz · 2015-04-13T15:11:15Z

@cordoval I understand you know. Thanks for explaining it in detail.

However, I still think it's not necessary. In this case, I don't consider a bad practice to persist assets in the repository. If your application is complex, use Bower and JS-stuff to continuosly update those assets. But if you application is simple enough, it's better to not update them continuously: things can break and you don't have time/money to solve those problems. So it's better to add those assets to the repo and treat them like regular assets, without updating them continuously.

Anyway, we could add a very short note about the existence of pure PHP tools to manage assets similarly to JS-stuff.

cordoval · 2015-04-13T15:12:45Z

I meant to put just a note, not even a full paragraph, to avoid saying this is the only way as there are the ways i just explained.

javiereguiluz · 2015-04-13T15:13:27Z

@cordoval I agree. We'll do that.

rvanlaak · 2015-04-13T15:14:06Z

👍 for not using any JS tooling in the article, but following a PHP approach. Did get that, but did want to discuss the gray areas where developers could make a decision to use a slight other approach. The use of bower is only one example of that ;) I don't see any other areas atm, so adding a note/link to @wouterj 's Bower article is fine ;)

cordoval · 2015-04-13T15:16:57Z

@rvanlaak i think @javiereguiluz understood what i meant. PHP approach is not just one approach is manyfold. I think this article is saying this is the best way, but if you are going to do it plainly bare bones here are the ways people approach it.

xabbuh · 2015-04-13T18:56:12Z

cookbook/frontend/index.rst

@@ -0,0 +1,7 @@
+Form


should be Front-End

this will be done by my PR and can be removed from this PR, to avoid merge conflicts

xabbuh · 2015-04-13T18:58:41Z

cookbook/frontend/assetic_php.rst

+
+The official Symfony Best Practices recommend to use Assetic to
+:doc:`manage web assets </best_practices/web-assets>`, unless you are
+comfortable with JavaScript-based frontend tools.


xabbuh · 2015-04-13T19:05:37Z

cookbook/frontend/assetic_php.rst

+
+.. code-block:: html+jinja
+
+    <!DOCTYPE html>


It's probably a good idea to add a filename comment to the top of the template.

I've updated it to display {# app/Resources/views/base.html.twig #} Is that the common practice in the Symfony docs when referring to the base/layout template?

xabbuh · 2015-04-13T19:09:26Z

This article overlaps in a way with the articles from the Assetic cookbook section. We should find a way not to document thing more than once.

wouterj · 2015-04-13T20:33:03Z

cookbook/frontend/assetic_php.rst

+Assetic includes a lot of ready-to-use filters but it doesn't include their
+associated libraries. Therefore, before enabling the filters used in this article
+you must install two libraries. Open a command console, browse to your project
+directory and execute the following commands:


I think it's very important to not make this article just a step-by-step solution for one problem (Sass and minifying), but make it ready to use for other libraries as well.

This mostly means that we should try to not say "Do this", but instead explain what "this" is and how we've come up with "this". In this case, it means explaining how one can find these package names. How does one know it has to install exactly these packages?

wouterj · 2015-04-13T20:47:02Z

Imo, as this is about Assetic, we should move this one to cookbook/assetic. I've created cookbook/frontend exactly to have front-end docs that are not about Assetic (as we only had Assetic docs until now). The frontend section is a help for the frontend developers that are unsure how to combine their regular tools with the Symfony framework (and also to learn the backend devs about the exciting world of frontend tooling).

javiereguiluz · 2015-04-14T11:31:48Z

@wouterj I think you are right and this article should be moved back to the Assetic cookbook section instead of adding it to the new Frontend section. I've just changed it. Thanks.

javiereguiluz · 2015-06-23T15:37:14Z

This PR seems to be finished. I've addressed every comment and implemented every suggestion. Can we label it as "finished"? Thanks!

xabbuh · 2015-06-24T14:18:17Z

looks good 👍

@wouterj

…ith Assetic (javiereguiluz) This PR was merged into the 2.3 branch. Discussion ---------- Proposed a new article about using pure PHP libraries with Assetic | Q | A | ------------- | --- | Doc fix? | no | New docs? | yes | Applies to | all | Fixed tickets | - In #5159 @wouterj proposes to create a new Cookbook section dedicated to frontend articles. I think it's a great idea and in this pull request I propose an article showing how to use pure PHP libraries to combine, compile and minimize CSS, SCSS and JS files. Commits ------- f5c4d93 Fixed an indentation problem 4b8b3fb Moved the article back to the Assetic section 07087dd Avoid the ugly double back slashes 85e6a54 Added more configuration formats bc6ffbe Rewords and code improvements 3ea9c86 Fixed some typos and grammar issues 1f6e16c Minor fixes cc5b630 Reworded some wrong statements 044cd73 The file extension is not needed 14d0346 Fixed the Twig lexer name 798b5b5 Added the missin index file 86da338 Proposed a new article about using pure PHP libraries with Assetic

weaverryan · 2015-06-27T22:36:50Z

Merged! Nice job making this short and concise - that's the best part (and a good reason why someone might opt for the pure PHP solutions). I made some final minor tweaks at sha: bf18f16

Thanks!

* 2.8: (122 commits) moving options below basic usage changing a few orders of sections - mostly to move overridden after the main options Rewrite note a bit fix capitalization tweak headline to be consistent with 2.6 [Contributing] [Standards] Added entry for identical comparison Wrap the table creation inside the class extending Command, so users know where the comes. They can use it as standalone when needed [Serializer] Array Denormalization [Cookbook][Assetic] complete a sentence Fixing "Undefined method" error on Symfony 2.7 [#5293] Tweak to link to the article about parent bundles Minor tweak to remove FOSUserBundle example and replace with a link to the doc about this overriding 3rd party bundles Adjust line wrapping Add formatting for file and method names Update load_balancer_reverse_proxy.rst removing upgrading.rst - this has already been moved into several documents in its own section [#5166] Minor tweaks Revert "Changed dump() to var_dump()" Changed dump() to var_dump() ...

javiereguiluz added 5 commits April 10, 2015 17:38

Proposed a new article about using pure PHP libraries with Assetic

86da338

Added the missin index file

798b5b5

Fixed the Twig lexer name

14d0346

The file extension is not needed

044cd73

Reworded some wrong statements

cc5b630

rvanlaak reviewed Apr 13, 2015
View reviewed changes

Minor fixes

1f6e16c

xabbuh reviewed Apr 13, 2015
View reviewed changes

xabbuh added the Status: Needs Work label Apr 13, 2015

xabbuh reviewed Apr 13, 2015
View reviewed changes

wouterj reviewed Apr 13, 2015
View reviewed changes

javiereguiluz mentioned this pull request Apr 13, 2015

Added an article explaining how to use Bower in Symfony #5159

Merged

javiereguiluz added 5 commits April 14, 2015 13:14

Fixed some typos and grammar issues

3ea9c86

Rewords and code improvements

bc6ffbe

Added more configuration formats

85e6a54

Avoid the ugly double back slashes

07087dd

Moved the article back to the Assetic section

4b8b3fb

Fixed an indentation problem

f5c4d93

xabbuh added Status: Reviewed and removed Status: Needs Work labels Jun 24, 2015

weaverryan merged commit f5c4d93 into symfony:2.3 Jun 27, 2015

weaverryan added a commit that referenced this pull request Jun 27, 2015

[#5166] Minor tweaks

bf18f16

wouterj removed the Status: Reviewed label Jul 22, 2015

javiereguiluz deleted the assetic_php branch January 3, 2018 16:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Proposed a new article about using pure PHP libraries with Assetic #5166

Proposed a new article about using pure PHP libraries with Assetic #5166

javiereguiluz commented Apr 10, 2015

rvanlaak Apr 13, 2015

javiereguiluz Apr 13, 2015

rvanlaak Apr 13, 2015

cordoval Apr 13, 2015

rvanlaak commented Apr 13, 2015

javiereguiluz commented Apr 13, 2015

cordoval commented Apr 13, 2015

javiereguiluz commented Apr 13, 2015

cordoval commented Apr 13, 2015

javiereguiluz commented Apr 13, 2015

cordoval commented Apr 13, 2015

javiereguiluz commented Apr 13, 2015

rvanlaak commented Apr 13, 2015

cordoval commented Apr 13, 2015

xabbuh Apr 13, 2015

wouterj Apr 13, 2015

xabbuh Apr 13, 2015

xabbuh Apr 13, 2015

javiereguiluz Apr 14, 2015

xabbuh commented Apr 13, 2015

wouterj Apr 13, 2015

wouterj commented Apr 13, 2015

javiereguiluz commented Apr 14, 2015

javiereguiluz commented Jun 23, 2015

xabbuh commented Jun 24, 2015

weaverryan commented Jun 27, 2015

Proposed a new article about using pure PHP libraries with Assetic #5166

Proposed a new article about using pure PHP libraries with Assetic #5166

Conversation

javiereguiluz commented Apr 10, 2015

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

rvanlaak commented Apr 13, 2015

javiereguiluz commented Apr 13, 2015

cordoval commented Apr 13, 2015

javiereguiluz commented Apr 13, 2015

cordoval commented Apr 13, 2015

javiereguiluz commented Apr 13, 2015

cordoval commented Apr 13, 2015

javiereguiluz commented Apr 13, 2015

rvanlaak commented Apr 13, 2015

cordoval commented Apr 13, 2015

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

xabbuh commented Apr 13, 2015

Choose a reason for hiding this comment

wouterj commented Apr 13, 2015

javiereguiluz commented Apr 14, 2015

javiereguiluz commented Jun 23, 2015

xabbuh commented Jun 24, 2015

weaverryan commented Jun 27, 2015