From 77e841b4c0e057e29e8ab02013e8932b87f73f4b Mon Sep 17 00:00:00 2001 From: Fabien Potencier Date: Fri, 14 Apr 2017 00:06:09 -0700 Subject: [PATCH] changed the way post-install output is defined --- README.rst | 56 +++++-------------- symfony/framework-bundle/3.3/manifest.json | 12 ---- symfony/framework-bundle/3.3/post-install.txt | 10 ++++ 3 files changed, 24 insertions(+), 54 deletions(-) create mode 100644 symfony/framework-bundle/3.3/post-install.txt diff --git a/README.rst b/README.rst index beb4d6b6..e419c3c3 100644 --- a/README.rst +++ b/README.rst @@ -258,23 +258,22 @@ Displays contents in the command console after the package has been installed. Avoid outputting meaningless information and use it only when you need to show help messages or the next step actions. -The contents are defined as a simple array of strings (Symfony Flex adds a -``PHP_EOL`` character after each line). `Symfony Console styles and colors`_ -are supported too: +The contents must be defined in a file named ``post-install.txt`` (Symfony Flex +adds a ``PHP_EOL`` character after each line). `Symfony Console styles and +colors`_ are supported too: -.. code-block:: json +.. code-block:: text - { - "post-install-output": [ - " What's next? ", - "", - " * Run your application:", - " 1. Execute the make serve command;", - " 2. Browse to the http://localhost:8000/ URL.", - "", - " * Read the documentation at https://symfony.com/doc" - ] - } + + What's next? + + + * Run your application: + 1. Change to the project directory + 2. Execute the make serve command; + 3. Browse to the http://localhost:8000/ URL. + + * Read the documentation at https://symfony.com/doc Full Example ------------ @@ -302,38 +301,11 @@ one used by ``symfony/framework-bundle``: "APP_DEBUG": "1", "APP_SECRET": "Ju$tChang3it!" }, - "makefile": [ - "cache-clear:", - "\t@test -f bin/console && bin/console cache:clear --no-warmup || rm -rf var/cache/*", - ".PHONY: cache-clear", - "", - "cache-warmup: cache-clear", - "\t@test -f bin/console && bin/console cache:warmup || echo \"cannot warmup the cache (needs symfony/console)\"", - ".PHONY: cache-warmup", - "", - "serve:", - "\t@echo \"\\033[32;49mServer listening on http://127.0.0.1:8000\\033[39m\"", - "\t@echo \"Quit the server with CTRL-C.\"", - "\t@echo \"Run \\033[32mcomposer require symfony/web-server-bundle\\033[39m for a better web server\"", - "\tphp -S 127.0.0.1:8000 -t web", - ".PHONY: serve" - ], "gitignore": [ ".env", "/var/", "/vendor/", "/web/bundles/" - ], - "post-install-output": [ - " ", - " What's next? ", - " ", - "", - " * Run your application:", - " 1. Execute the make serve command;", - " 2. Browse to the http://localhost:8000/ URL.", - "", - " * Read the documentation at https://symfony.com/doc" ] } diff --git a/symfony/framework-bundle/3.3/manifest.json b/symfony/framework-bundle/3.3/manifest.json index 77983ed3..98e6ad18 100644 --- a/symfony/framework-bundle/3.3/manifest.json +++ b/symfony/framework-bundle/3.3/manifest.json @@ -21,17 +21,5 @@ "/var/", "/vendor/", "/web/bundles/" - ], - "post-install-output": [ - " ", - " What's next? ", - " ", - "", - " * Run your application:", - " 1. Change to the project directory", - " 2. Execute the make serve command;", - " 3. Browse to the http://localhost:8000/ URL.", - "", - " * Read the documentation at https://symfony.com/doc" ] } diff --git a/symfony/framework-bundle/3.3/post-install.txt b/symfony/framework-bundle/3.3/post-install.txt new file mode 100644 index 00000000..f46cdb29 --- /dev/null +++ b/symfony/framework-bundle/3.3/post-install.txt @@ -0,0 +1,10 @@ + + What's next? + + + * Run your application: + 1. Change to the project directory + 2. Execute the make serve command; + 3. Browse to the http://localhost:8000/ URL. + + * Read the documentation at https://symfony.com/doc