Skip to content

Commit d307157

Browse files
weaverryanjaviereguiluz
authored andcommitted
adding docs about configurable flex paths
1 parent 984c9bb commit d307157

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
@@ -184,6 +184,36 @@ manual steps:
184184
original ``web/app_*.php`` front controllers were customized, add those changes
185185
to the new ``public/index.php`` controller.
186186

187+
Customizing Flex Paths
188+
----------------------
189+
190+
The Flex recipes make a few assumptions about your project's directory structure.
191+
Some of these assumptions can be customized by adding a key under the ``extra``
192+
section of your ``composer.json`` file. For example, to tell Flex to copy any
193+
PHP classes into ``src/App`` instead of ``src``:
194+
195+
.. code-block:: json
196+
197+
{
198+
"...": "...",
199+
200+
"extra": {
201+
"src-dir": "src/App"
202+
}
203+
}
204+
205+
The configurable paths are:
206+
207+
* ``bin-dir``: defaults to ``bin/``
208+
* ``config-dir``: defaults to ``config/``
209+
* ``src-dir`` defaults to ``src/``
210+
* ``var-dir`` defaults to ``var/``
211+
* ``public-dir`` defaults to ``public/``
212+
213+
If you customize these paths, some files copied from a recipe still may contain
214+
references to the original path. In other words: you may need to update some things
215+
manually after a recipe is installed.
216+
187217
.. _`Symfony Flex`: https://github.com/symfony/flex
188218
.. _`Symfony Installer`: https://github.com/symfony/symfony-installer
189219
.. _`Symfony Standard Edition`: https://github.com/symfony/symfony-standard

0 commit comments

Comments
 (0)