Skip to content

Commit 77e841b

Browse files
committed
changed the way post-install output is defined
1 parent 99e56fc commit 77e841b

File tree

3 files changed

+24
-54
lines changed

3 files changed

+24
-54
lines changed

README.rst

Lines changed: 14 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -258,23 +258,22 @@ Displays contents in the command console after the package has been installed.
258258
Avoid outputting meaningless information and use it only when you need to show
259259
help messages or the next step actions.
260260

261-
The contents are defined as a simple array of strings (Symfony Flex adds a
262-
``PHP_EOL`` character after each line). `Symfony Console styles and colors`_
263-
are supported too:
261+
The contents must be defined in a file named ``post-install.txt`` (Symfony Flex
262+
adds a ``PHP_EOL`` character after each line). `Symfony Console styles and
263+
colors`_ are supported too:
264264

265-
.. code-block:: json
265+
.. code-block:: text
266266
267-
{
268-
"post-install-output": [
269-
"<fg=blue> What's next? </>",
270-
"",
271-
" * <fg=blue>Run</> your application:",
272-
" 1. Execute the <comment>make serve</comment> command;",
273-
" 2. Browse to the <comment>http://localhost:8000/</comment> URL.",
274-
"",
275-
" * <fg=blue>Read</> the documentation at <comment>https://symfony.com/doc</comment>"
276-
]
277-
}
267+
<bg=blue;fg=white> </>
268+
<bg=blue;fg=white> What's next? </>
269+
<bg=blue;fg=white> </>
270+
271+
* <fg=blue>Run</> your application:
272+
1. Change to the project directory
273+
2. Execute the <comment>make serve</> command;
274+
3. Browse to the <comment>http://localhost:8000/</> URL.
275+
276+
* <fg=blue>Read</> the documentation at <comment>https://symfony.com/doc</>
278277
279278
Full Example
280279
------------
@@ -302,38 +301,11 @@ one used by ``symfony/framework-bundle``:
302301
"APP_DEBUG": "1",
303302
"APP_SECRET": "Ju$tChang3it!"
304303
},
305-
"makefile": [
306-
"cache-clear:",
307-
"\t@test -f bin/console && bin/console cache:clear --no-warmup || rm -rf var/cache/*",
308-
".PHONY: cache-clear",
309-
"",
310-
"cache-warmup: cache-clear",
311-
"\t@test -f bin/console && bin/console cache:warmup || echo \"cannot warmup the cache (needs symfony/console)\"",
312-
".PHONY: cache-warmup",
313-
"",
314-
"serve:",
315-
"\t@echo \"\\033[32;49mServer listening on http://127.0.0.1:8000\\033[39m\"",
316-
"\t@echo \"Quit the server with CTRL-C.\"",
317-
"\t@echo \"Run \\033[32mcomposer require symfony/web-server-bundle\\033[39m for a better web server\"",
318-
"\tphp -S 127.0.0.1:8000 -t web",
319-
".PHONY: serve"
320-
],
321304
"gitignore": [
322305
".env",
323306
"/var/",
324307
"/vendor/",
325308
"/web/bundles/"
326-
],
327-
"post-install-output": [
328-
"<bg=blue;fg=white> </>",
329-
"<bg=blue;fg=white> What's next? </>",
330-
"<bg=blue;fg=white> </>",
331-
"",
332-
" * <fg=blue>Run</> your application:",
333-
" 1. Execute the <comment>make serve</comment> command;",
334-
" 2. Browse to the <comment>http://localhost:8000/</comment> URL.",
335-
"",
336-
" * <fg=blue>Read</> the documentation at <comment>https://symfony.com/doc</comment>"
337309
]
338310
}
339311

symfony/framework-bundle/3.3/manifest.json

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -21,17 +21,5 @@
2121
"/var/",
2222
"/vendor/",
2323
"/web/bundles/"
24-
],
25-
"post-install-output": [
26-
"<bg=blue;fg=white> </>",
27-
"<bg=blue;fg=white> What's next? </>",
28-
"<bg=blue;fg=white> </>",
29-
"",
30-
" * <fg=blue>Run</> your application:",
31-
" 1. Change to the project directory",
32-
" 2. Execute the <comment>make serve</comment> command;",
33-
" 3. Browse to the <comment>http://localhost:8000/</comment> URL.",
34-
"",
35-
" * <fg=blue>Read</> the documentation at <comment>https://symfony.com/doc</comment>"
3624
]
3725
}
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<bg=blue;fg=white> </>
2+
<bg=blue;fg=white> What's next? </>
3+
<bg=blue;fg=white> </>
4+
5+
* <fg=blue>Run</> your application:
6+
1. Change to the project directory
7+
2. Execute the <comment>make serve</> command;
8+
3. Browse to the <comment>http://localhost:8000/</> URL.
9+
10+
* <fg=blue>Read</> the documentation at <comment>https://symfony.com/doc</>

0 commit comments

Comments
 (0)