This repository has been archived on 2023-08-20. You can view files and clone it, but cannot push or open issues or pull requests.
symfony/src/Symfony/Component/Console/Tests/Fixtures
Fabien Potencier c3230f0a97 minor #20896 [Console] Enhance MarkdownDescriptor (ogizanagi)
This PR was squashed before being merged into the 3.3-dev branch (closes #20896).

Discussion
----------

[Console] Enhance MarkdownDescriptor

| Q             | A
| ------------- | ---
| Branch?       | master
| Bug fix?      | yes
| New feature?  | yes
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | N/A
| License       | MIT
| Doc PR        | N/A

In order to add usefulness to this descriptor, this PR allows to jump to a command description by clicking on the command name on the application summary.

It's not a generic approach but IMHO a quick win that should work at least for Github flavoured markdown.

The markdown format should also avoid using `Application::getLongVersion` as the markdown document title, as it may contain tags (and unnecessary information using the framework).

Lastly, the markdown format is now cleaned from tags initially used for console output formatting and only keeps properly escaped ones.

Commits
-------

ef5b087b4f Do not output formatting tags
6896865bcc [Console] MarkdownDescriptor: Don't use getLongVersion
fc2395e237 [Console] MarkdownDescriptor: Link to commands anchors
2017-02-16 06:18:56 -08:00
..
Style/SymfonyStyle Merge branch '2.8' into 3.2 2017-02-14 17:27:43 +01:00
application_1.json [Console] Show hidden commands in json & xml descriptors 2016-12-28 13:23:03 +01:00
application_1.md Do not output formatting tags 2017-01-21 11:06:20 +01:00
application_1.txt [Console][FrameworkBundle] Revised console header formatting 2016-07-29 05:54:38 -04:00
application_1.xml [Console] Show hidden commands in json & xml descriptors 2016-12-28 13:23:03 +01:00
application_2.json [Console] Show hidden commands in json & xml descriptors 2016-12-28 13:23:03 +01:00
application_2.md Do not output formatting tags 2017-01-21 11:06:20 +01:00
application_2.txt [Console][FrameworkBundle] Revised console header formatting 2016-07-29 05:54:38 -04:00
application_2.xml [Console] Show hidden commands in json & xml descriptors 2016-12-28 13:23:03 +01:00
application_gethelp.txt [Console][FrameworkBundle] Revised console header formatting 2016-07-29 05:54:38 -04:00
application_mbstring.md Do not output formatting tags 2017-01-21 11:06:20 +01:00
application_mbstring.txt Fix merge 2017-01-02 16:13:20 +01:00
application_renderexception1.txt Merge branch '2.7' into 2.8 2015-12-22 11:25:57 +01:00
application_renderexception2.txt Merge branch '2.8' into 3.0 2015-12-22 11:39:06 +01:00
application_renderexception3.txt [Console] Avoid extra blank lines when rendering exceptions 2015-12-17 00:47:15 +01:00
application_renderexception3decorated.txt Merge branch '2.3' into 2.7 2015-12-18 17:59:46 +01:00
application_renderexception4.txt Merge branch '2.7' into 2.8 2015-12-22 11:25:57 +01:00
application_renderexception_doublewidth1.txt [Console] Avoid extra blank lines when rendering exceptions 2015-12-17 00:47:15 +01:00
application_renderexception_doublewidth1decorated.txt Merge branch '2.3' into 2.7 2015-12-18 17:59:46 +01:00
application_renderexception_doublewidth2.txt [Console] Avoid extra blank lines when rendering exceptions 2015-12-17 00:47:15 +01:00
application_run1.txt [Console] Made output docopt compatible 2015-04-08 07:37:46 +02:00
application_run2.txt Merge branch '3.1' 2016-08-10 09:06:11 +02:00
application_run3.txt Merge branch '2.8' into 3.1 2016-08-10 08:57:07 +02:00
application_run4.txt moved component and bridge unit tests to the src/ directory 2012-03-29 08:37:22 +02:00
BarBucCommand.php Fix undefined offset when formatting namespace suggestions 2013-11-27 10:10:40 +01:00
command_1.json [Console] Show hidden commands in json & xml descriptors 2016-12-28 13:23:03 +01:00
command_1.md [Console] Improve markdown format 2016-12-11 11:55:57 +00:00
command_1.txt Console: Fix indentation of Help: section of txt usage help 2016-08-09 06:38:20 -07:00
command_1.xml [Console] Show hidden commands in json & xml descriptors 2016-12-28 13:23:03 +01:00
command_2.json [Console] Show hidden commands in json & xml descriptors 2016-12-28 13:23:03 +01:00
command_2.md [Console] Improve markdown format 2016-12-11 11:55:57 +00:00
command_2.txt Console: Fix indentation of Help: section of txt usage help 2016-08-09 06:38:20 -07:00
command_2.xml [Console] Show hidden commands in json & xml descriptors 2016-12-28 13:23:03 +01:00
command_mbstring.md Fix merge 2017-01-02 16:35:15 +01:00
command_mbstring.txt [Console] Descriptors should use Helper::strlen 2016-12-28 09:27:57 +01:00
DescriptorApplication1.php [Console] application/command as text/xml/whatever decoupling 2013-04-23 18:54:00 +02:00
DescriptorApplication2.php update docblocks and added test 2016-09-29 15:12:19 -04:00
DescriptorApplicationMbString.php [Console] Descriptors should use Helper::strlen 2016-12-28 09:27:57 +01:00
DescriptorCommand1.php [Console] application/command as text/xml/whatever decoupling 2013-04-23 18:54:00 +02:00
DescriptorCommand2.php [Console] Made output docopt compatible 2015-04-08 07:37:46 +02:00
DescriptorCommand3.php rename Command::private to Command::hidden 2016-10-21 21:25:53 +02:00
DescriptorCommandMbString.php [Console] Descriptors should use Helper::strlen 2016-12-28 09:27:57 +01:00
DummyOutput.php fixes CS 2015-08-24 09:13:45 +02:00
Foo1Command.php moved component and bridge unit tests to the src/ directory 2012-03-29 08:37:22 +02:00
Foo2Command.php moved component and bridge unit tests to the src/ directory 2012-03-29 08:37:22 +02:00
Foo3Command.php [Console] Show code when an exception is thrown 2016-01-27 05:55:18 +01:00
Foo4Command.php fixed CS 2013-01-16 10:27:54 +01:00
Foo5Command.php [Console] Throw an exception if the command does not contain aliases 2013-10-01 12:29:09 +02:00
Foo6Command.php fixed previous commit 2015-10-05 17:47:05 +02:00
FoobarCommand.php [Console] Improved searching commands 2013-08-20 12:04:08 +02:00
FooCommand.php moved component and bridge unit tests to the src/ directory 2012-03-29 08:37:22 +02:00
FooLock2Command.php [Console] Add Lockable trait 2016-06-23 13:42:36 +02:00
FooLockCommand.php [Console] Add Lockable trait 2016-06-23 13:42:36 +02:00
FooSubnamespaced1Command.php [Console] fixed #10531 2015-01-09 17:38:19 +01:00
FooSubnamespaced2Command.php [Console] fixed #10531 2015-01-09 17:38:19 +01:00
input_argument_1.json format json fixtures 2016-09-27 17:33:51 +00:00
input_argument_1.md [Console] Improve markdown format 2016-12-11 11:55:57 +00:00
input_argument_1.txt [Console] Made output docopt compatible 2015-04-08 07:37:46 +02:00
input_argument_1.xml [Console] application/command as text/xml/whatever decoupling 2013-04-23 18:54:00 +02:00
input_argument_2.json format json fixtures 2016-09-27 17:33:51 +00:00
input_argument_2.md [Console] Improve markdown format 2016-12-11 11:55:57 +00:00
input_argument_2.txt [Console] Made output docopt compatible 2015-04-08 07:37:46 +02:00
input_argument_2.xml [Console] application/command as text/xml/whatever decoupling 2013-04-23 18:54:00 +02:00
input_argument_3.json format json fixtures 2016-09-27 17:33:51 +00:00
input_argument_3.md [Console] Improve markdown format 2016-12-11 11:55:57 +00:00
input_argument_3.txt [Console] Made output docopt compatible 2015-04-08 07:37:46 +02:00
input_argument_3.xml [Console] application/command as text/xml/whatever decoupling 2013-04-23 18:54:00 +02:00
input_argument_4.json format json fixtures 2016-09-27 17:33:51 +00:00
input_argument_4.md [Console] Improve markdown format 2016-12-11 11:55:57 +00:00
input_argument_4.txt [Console] Fix wrong handling of multiline arg/opt descriptions 2016-11-30 19:39:48 +01:00
input_argument_4.xml [Console] Made output docopt compatible 2015-04-08 07:37:46 +02:00
input_argument_with_style.json [Console] Escape default value when dumping help 2016-12-30 11:17:25 +01:00
input_argument_with_style.md Do not output formatting tags 2017-01-21 11:06:20 +01:00
input_argument_with_style.txt [Console] Escape default value when dumping help 2016-12-30 11:17:25 +01:00
input_argument_with_style.xml [Console] Escape default value when dumping help 2016-12-30 11:17:25 +01:00
input_definition_1.json format json fixtures 2016-09-27 17:33:51 +00:00
input_definition_1.md [Console] application/command as text/xml/whatever decoupling 2013-04-23 18:54:00 +02:00
input_definition_1.txt [Console] application/command as text/xml/whatever decoupling 2013-04-23 18:54:00 +02:00
input_definition_1.xml [Console] application/command as text/xml/whatever decoupling 2013-04-23 18:54:00 +02:00
input_definition_2.json format json fixtures 2016-09-27 17:33:51 +00:00
input_definition_2.md [Console] Improve markdown format 2016-12-11 11:55:57 +00:00
input_definition_2.txt [Console] Made output docopt compatible 2015-04-08 07:37:46 +02:00
input_definition_2.xml [Console] application/command as text/xml/whatever decoupling 2013-04-23 18:54:00 +02:00
input_definition_3.json format json fixtures 2016-09-27 17:33:51 +00:00
input_definition_3.md [Console] Improve markdown format 2016-12-11 11:55:57 +00:00
input_definition_3.txt [Console] Made output docopt compatible 2015-04-08 07:37:46 +02:00
input_definition_3.xml [Console] application/command as text/xml/whatever decoupling 2013-04-23 18:54:00 +02:00
input_definition_4.json format json fixtures 2016-09-27 17:33:51 +00:00
input_definition_4.md [Console] Improve markdown format 2016-12-11 11:55:57 +00:00
input_definition_4.txt [Console] Made output docopt compatible 2015-04-08 07:37:46 +02:00
input_definition_4.xml [Console] application/command as text/xml/whatever decoupling 2013-04-23 18:54:00 +02:00
input_option_1.json format json fixtures 2016-09-27 17:33:51 +00:00
input_option_1.md [Console] Improve markdown format 2016-12-11 11:55:57 +00:00
input_option_1.txt [Console] Made output docopt compatible 2015-04-08 07:37:46 +02:00
input_option_1.xml [Console] application/command as text/xml/whatever decoupling 2013-04-23 18:54:00 +02:00
input_option_2.json format json fixtures 2016-09-27 17:33:51 +00:00
input_option_2.md [Console] Improve markdown format 2016-12-11 11:55:57 +00:00
input_option_2.txt [Console] Made output docopt compatible 2015-04-08 07:37:46 +02:00
input_option_2.xml [Console] application/command as text/xml/whatever decoupling 2013-04-23 18:54:00 +02:00
input_option_3.json format json fixtures 2016-09-27 17:33:51 +00:00
input_option_3.md [Console] Improve markdown format 2016-12-11 11:55:57 +00:00
input_option_3.txt [Console] Made output docopt compatible 2015-04-08 07:37:46 +02:00
input_option_3.xml [Console] application/command as text/xml/whatever decoupling 2013-04-23 18:54:00 +02:00
input_option_4.json format json fixtures 2016-09-27 17:33:51 +00:00
input_option_4.md [Console] Improve markdown format 2016-12-11 11:55:57 +00:00
input_option_4.txt [Console] Made output docopt compatible 2015-04-08 07:37:46 +02:00
input_option_4.xml [Console] application/command as text/xml/whatever decoupling 2013-04-23 18:54:00 +02:00
input_option_5.json format json fixtures 2016-09-27 17:33:51 +00:00
input_option_5.md [Console] Improve markdown format 2016-12-11 11:55:57 +00:00
input_option_5.txt [Console] Fix wrong handling of multiline arg/opt descriptions 2016-11-30 19:39:48 +01:00
input_option_5.xml [Console] Made output docopt compatible 2015-04-08 07:37:46 +02:00
input_option_6.json format json fixtures 2016-09-27 17:33:51 +00:00
input_option_6.md [Console] Improve markdown format 2016-12-11 11:55:57 +00:00
input_option_6.txt [Console] respect multi-character shortcuts 2015-06-26 23:20:39 +02:00
input_option_6.xml [Console] respect multi-character shortcuts 2015-06-26 23:20:39 +02:00
input_option_with_style_array.json [Console] Escape default value when dumping help 2016-12-30 11:17:25 +01:00
input_option_with_style_array.md Do not output formatting tags 2017-01-21 11:06:20 +01:00
input_option_with_style_array.txt [Console] Escape default value when dumping help 2016-12-30 11:17:25 +01:00
input_option_with_style_array.xml [Console] Escape default value when dumping help 2016-12-30 11:17:25 +01:00
input_option_with_style.json [Console] Escape default value when dumping help 2016-12-30 11:17:25 +01:00
input_option_with_style.md Do not output formatting tags 2017-01-21 11:06:20 +01:00
input_option_with_style.txt [Console] Escape default value when dumping help 2016-12-30 11:17:25 +01:00
input_option_with_style.xml [Console] Escape default value when dumping help 2016-12-30 11:17:25 +01:00
TestCommand.php moved component and bridge unit tests to the src/ directory 2012-03-29 08:37:22 +02:00