[Suggestion] Adding .gitattributes to ignore unnecessary folders and files for production env

[arcanedev-maroc]

The trick is by using the export-ignore: https://git-scm.com/docs/gitattributes#__code_export_ignore_code

This is useful when we want to upload the app into the shared host with FTP.

For example: https://github.com/ARCANEDEV/LogViewer/blob/master/.gitattributes

[linaori]

And don't forget all Tests directories 👍

[mvrhov]

Please look at previous suggestions, this is a NO.

[linaori]

@mvrhov code that you use in production shouldn't have testing code or files that are not used in production. Even when developing you don't want all the files that come along with a framework but are not used by you (like test files). It greatly increases the amount of files which your IDE will index (especially with a FW as big as Symfony) and those files serve 0 purpose.

[mvrhov]

No I want the tests. And I'm installing everything with preferred-install:dist For deploy I have a script which removes everything for me.

P.S. As said in another thread with the same debate:
We don't trust "composer". We commit all dependencies. It happened before the composer that the vendor code was nowhere to be found and the JavaScript example from a few months ago shows exactly what kinds of problems you can have if you don't have everything stored.

[linaori]

If you want the tests, clone the repository

[jakzal]

re #17995 #11810 #5674

[linaori]

It seems to be a recurring subject and the only reason people want to have it, is something that can be achieved by additional means. I would like to quote Seldaek: #20032 (comment)

as you are trying to run phpunit as far as I understand, and not develop it.

We're trying to run Symfony in our own packages, not develop it. That means we don't need all the extra code neither in our development nor production servers.

When searching for classes, you always get polluted results;

• Searching for CacheItem will show me https://github.com/symfony/symfony/blob/master/src/Symfony/Component/Cache/Tests/CacheItemTest.php
• Searching for implementations of CacheItemPoolInterface will result in finding https://github.com/symfony/symfony/blob/master/src/Symfony/Component/Cache/Tests/Fixtures/ExternalAdapter.php
• It leads to confusing locations where to put classes, as this one should obviously be a Test namespace/extension point: https://github.com/symfony/symfony/blob/master/src/Symfony/Component/HttpFoundation/Session/Storage/MockArraySessionStorage.php

People might end up hinting against those classes which is extremely unhelpful for newer developers. Next to this, your IDE autocompletion is polluted with stuff you don't care about (yes, even SessionTest will come up when looking at Session). In case you DO need the tests for what reason ever, you can always simply fork/clone the repository.

[arcanedev-maroc]

Thanks @jakzal @iltar for including these references.

I know it's a big issue, because we need to split the ecosystem of our applications into separate environments (dev/testing/production) and the only way to "clean the mess" is by doing it manually for each project (and if we use a script to clean the packages, we need to maintain it).

Now Composer is a main tool for every PHP Developer, the --prefer-dist and --prefer-source doesn't make a big difference at this point in time because we end up with all the files used for development (docs, tests, examples, etc) for each installed package.

Who wants the tests/docs in their production environments ?

I love the Laravel framework approach for grouping all the tests into a single folder.

PS: @jakzal I love your talks/videos 👍.

[linaori]

@arcanedev-maroc the strategy that I follow is quite simple:

  "autoload": {
    "psr-4": {"Iltar\\HttpBundle\\": "src/"}
  },
  "autoload-dev": {
    "psr-4": {"Iltar\\HttpBundle\\": "test/"}
  }

I agree with (don't ever dare to quote me) Laravel on this matter, yet have to say that this is (nearly) impossible for Symfony due to the Subtree split.

Who wants the tests/docs in their production environments ?

I don't need them in dev either, I have a browser for this, they are just polluting my search results.

[nicolas-grekas]

Then help fix editorconfig/editorconfig#228, this is the real issue...

[linaori]

It should still work if you have only poor tooling available (Say Eclipse PDT). I shouldn't have to rely on editors ignore stuff that shouldn't be there in the first place if you ask me and feels like a work-around for something. If I'm using command-line searching, the editor config won't really be of much service to me either afaik. With ~180 packages installed locally, I don't always use an IDE to open/edit/find stuff.

[jakzal]

Another use case for making vendor dir lighter is to make docker images smaller. In the age of microservices this is becoming more and more important. Removing tests from the Symfony Demo cuts 13M. I know this could be done while building an image, but perhaps the end users should not have to think which part of Symfony is actual production code.

[arcanedev-maroc]

And there is more: #6047 #6374 #6605 #16174

[nicolas-grekas]

Closing as already confirmed several times.
Note that with Flex, we're going to not use symfony/symfony directly that often anymore - that may help.