diogo/symfony
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
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.
773eca7794
symfony/src/Symfony/Component/Console
History
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
..
Command Merge branch '3.1' into 3.2 2017-01-02 15:57:35 +01:00
DependencyInjection [DI][Config] Add & use ReflectionClassResource 2017-02-02 14:15:15 +01:00
Descriptor Do not output formatting tags 2017-01-21 11:06:20 +01:00
Event fixes CS 2015-08-24 09:13:45 +02:00
EventListener Add Console ExceptionListener 2017-01-23 23:15:00 +01:00
Exception [Console] Fix infinite loop on missing input 2016-11-03 09:51:57 +01:00
Formatter Merge branch '3.1' into 3.2 2016-12-27 11:44:30 +01:00
Helper Merge branch '3.2' 2017-02-16 06:15:30 -08:00
Input Merge branch '3.1' 2016-10-06 10:59:27 +02:00
Logger Merge branch '3.1' 2016-11-16 17:18:16 -05:00
Output Merge branch '2.8' into 3.1 2016-08-19 08:48:39 +02:00
Question Merge branch '2.8' into 3.1 2016-12-27 11:43:25 +01:00
Resources/bin Move hiddeninput.exe to Resources/bin 2012-10-16 11:08:11 +02:00
Style [Console] Ease writing to stderr using styles 2017-01-06 19:34:44 +01:00
Tester fixed CS 2017-01-21 09:18:54 -08:00
Tests minor #20896 [Console] Enhance MarkdownDescriptor (ogizanagi) 2017-02-16 06:18:56 -08:00
.gitignore Added missing files .gitignore 2013-07-21 14:12:18 +02:00
Application.php Merge branch '3.2' 2016-12-27 11:45:09 +01:00
CHANGELOG.md Add Console ExceptionListener 2017-01-23 23:15:00 +01:00
composer.json [DI][Config] Add & use ReflectionClassResource 2017-02-02 14:15:15 +01:00
ConsoleEvents.php move event listener method type hint docs to @Event annotations default value. makes it easily parsable by PhpStorm plugin 2016-05-03 20:48:46 +02:00
LICENSE updated LICENSE year 2017-01-02 12:30:00 -08:00
phpunit.xml.dist use the clock mock for progress indicator tests 2016-03-17 10:19:04 +01:00
README.md Updated all the README files 2016-03-04 08:12:06 +01:00
Terminal.php [Console] Fix return type in Terminal docblocks 2017-01-04 17:48:15 +00:00

README.md

Console Component

The Console component eases the creation of beautiful and testable command line interfaces.

Resources

Credits

Resources/bin/hiddeninput.exe is a third party binary provided within this component. Find sources and license at https://github.com/Seldaek/hidden-input.