Skip to content

Commit 042f444

Browse files
committed
Merge branch '3.4' into 4.2
* 3.4: adding docs about configurable flex paths
2 parents abb6583 + 7f16dfa commit 042f444

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

setup/flex.rst

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -268,6 +268,36 @@ manual steps:
268268
#. Remove the ``bin/symfony_requirements`` script and if you need a replacement
269269
for it, use the new `Symfony Requirements Checker`_.
270270

271+
Customizing Flex Paths
272+
----------------------
273+
274+
The Flex recipes make a few assumptions about your project's directory structure.
275+
Some of these assumptions can be customized by adding a key under the ``extra``
276+
section of your ``composer.json`` file. For example, to tell Flex to copy any
277+
PHP classes into ``src/App`` instead of ``src``:
278+
279+
.. code-block:: json
280+
281+
{
282+
"...": "...",
283+
284+
"extra": {
285+
"src-dir": "src/App"
286+
}
287+
}
288+
289+
The configurable paths are:
290+
291+
* ``bin-dir``: defaults to ``bin/``
292+
* ``config-dir``: defaults to ``config/``
293+
* ``src-dir`` defaults to ``src/``
294+
* ``var-dir`` defaults to ``var/``
295+
* ``public-dir`` defaults to ``public/``
296+
297+
If you customize these paths, some files copied from a recipe still may contain
298+
references to the original path. In other words: you may need to update some things
299+
manually after a recipe is installed.
300+
271301
.. _`Symfony Flex`: https://github.com/symfony/flex
272302
.. _`Symfony Installer`: https://github.com/symfony/symfony-installer
273303
.. _`Symfony Standard Edition`: https://github.com/symfony/symfony-standard

0 commit comments

Comments
 (0)