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

[Console] Add descriptions to Fish completion output #53986

Merged
merged 1 commit into from Feb 21, 2024

Conversation

adriaanzon
Copy link
Contributor

Q A
Branch? 7.1
Bug fix? no
New feature? no
Deprecations? no
Issues N/A
License MIT

This improves the completion output for the Fish shell to include descriptions. The -a option of Fish's complete command accepts a list where each line is an argument with an optional description, separated by a tab. The fish script doesn't need to change, making this change backwards compatible.

Since the output is now identical to that of ZshCompletionOutput, code duplication could still be reduced by extracting to an abstract class (e.g. TabSeparatedCompletionOutput) that gets extended by FishCompletionOutput and ZshCompletionOutput.

@carsonbot carsonbot added this to the 7.1 milestone Feb 17, 2024
@carsonbot
Copy link

Hey!

I see that this is your first PR. That is great! Welcome!

Symfony has a contribution guide which I suggest you to read.

In short:

  • Always add tests
  • Keep backward compatibility (see https://symfony.com/bc).
  • Bug fixes must be submitted against the lowest maintained branch where they apply (see https://symfony.com/releases)
  • Features and deprecations must be submitted against the 7.1 branch.

Review the GitHub status checks of your pull request and try to solve the reported issues. If some tests are failing, try to see if they are failing because of this change.

When two Symfony core team members approve this change, it will be merged and you will become an official Symfony contributor!
If this PR is merged in a lower version branch, it will be merged up to all maintained branches within a few days.

I am going to sit back now and wait for the reviews.

Cheers!

Carsonbot

@GromNaN GromNaN self-requested a review February 17, 2024 18:07
@carsonbot carsonbot changed the title Add descriptions to Fish completion output [Console] Add descriptions to Fish completion output Feb 19, 2024
Copy link
Member

@GromNaN GromNaN left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Works very well. Thank you Adriaan for this first great contribution.

image

Since the output is now identical to that of ZshCompletionOutput, code duplication could still be reduced by extracting to an abstract class (e.g. TabSeparatedCompletionOutput) that gets extended by FishCompletionOutput and ZshCompletionOutput.

It's identical code, but not "duplicated". It's better to keep 2 simple classes that serve a distinct purpose than to add complexity through inheritance.

@fabpot
Copy link
Member

fabpot commented Feb 21, 2024

Thank you @adriaanzon.

@fabpot fabpot merged commit 73f8713 into symfony:7.1 Feb 21, 2024
2 checks passed
@fabpot fabpot mentioned this pull request May 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants