Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[11.x] Support New Lines in Command Argument and Option Descriptions #54057

Closed

Conversation

shamimulalam
Copy link
Contributor

@shamimulalam shamimulalam commented Jan 2, 2025

This PR introduces support for new lines in argument and option descriptions within the {} template in the parse() method. Previously, new lines were escaped, but this change allows for easier formatting of long descriptions, which improves readability.

The main benefit of this change is improved readability, making it easier to break up long descriptions without affecting the current functionality.

A test has been added to ensure the parse() method correctly handles new lines in descriptions. The test verifies that everything works as expected without introducing any regressions.

In summary, this PR makes command signature descriptions more readable and ensures the code is safer without causing any breakage.

src/Illuminate/Console/Parser.php Outdated Show resolved Hide resolved
src/Illuminate/Console/Parser.php Outdated Show resolved Hide resolved
src/Illuminate/Console/Parser.php Outdated Show resolved Hide resolved
src/Illuminate/Console/Parser.php Outdated Show resolved Hide resolved
src/Illuminate/Console/Parser.php Outdated Show resolved Hide resolved
src/Illuminate/Console/Parser.php Outdated Show resolved Hide resolved
@taylorotwell
Copy link
Member

Thanks for your pull request to Laravel!

Unfortunately, I'm going to delay merging this code for now. To preserve our ability to adequately maintain the framework, we need to be very careful regarding the amount of code we include.

If applicable, please consider releasing your code as a package so that the community can still take advantage of your contributions!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants