8000 [Console] Support completion for bash functions by Chi-teck · Pull Request #48179 · symfony/symfony · GitHub
[go: up one dir, main page]
Skip to content

[Console] Support completion for bash functions #48179

8000 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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Nov 19, 2022
Merged

[Console] Support completion for bash functions #48179

merged 1 commit into from
Nov 19, 2022

Conversation

Chi-teck
Copy link
Contributor
@Chi-teck Chi-teck commented Nov 9, 2022 •
edited
Loading
Q A
Branch 6.2
Bug fix? no
New feature yes
Deprecations no
License MIT

I often use bash functions as wrappers for executable files that live in vendor/bin. So that they can be executed from any location within a project. Symfony Console has recently added support for Bash completions but right now that only applies to executable files and aliases. This PR adds support for Bash functions.

@Chi-teck Chi-teck requested a review from chalasr as a code owner November 9, 2022 17:20
@carsonbot carsonbot added this to the 6.2 milestone Nov 9, 2022
@carsonbot
Copy link

Hey!

I think @remicollet has recently worked with this code. Maybe they can help review this?

Cheers!

Carsonbot

@GromNaN
Copy link
Member
GromNaN commented Nov 11, 2022

Hi @Chi-teck, can you provide an example of "bash function", so that we can test your change?

@Chi-teck
Copy link
Contributor Author

@GromNaN It could be a simple wrapper around any Symfony app that already have completions dumped.

  1. Dump completions for some existing application.
    /var/www/vendor/bin/some-app bash >> ~/.bash_completion
  2. Add the following Bash function to ~/.bashrc file.
function some-app() {
  /var/www/vendor/bin/some-app
}
  1. Log in and log out for the change to take effect.

Check if completions work for /var/www/vendor/bin/some-app and for some-app.

GromNaN
GromNaN approved these changes Nov 12, 2022
View reviewed changes
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.

Thank you for the reproducer. I think the function should transmit the arguments so that the completion works.

function some-app() {
  /var/www/vendor/bin/some-app "$@"
}

@symfony/mergers I think this is a bugfix that should be merged in 5.4.

@OskarStark OskarStark requested a review from wouterj November 12, 2022 22:04
@nicolas-grekas nicolas-grekas modified the milestones: 6.2, 5.4 Nov 14, 2022
@fabpot fabpot changed the base branch from 6.2 to 5.4 November 19, 2022 14:44
@fabpot
Copy link
Member
fabpot commented Nov 19, 2022

Thank you @Chi-teck.

@fabpot fabpot force-pushed the bash-complete-function branch from 3b60ba1 to 1321278 Compare November 19, 2022 14:44
@fabpot fabpot merged commit 5882b4f into symfony:5.4 Nov 19, 2022
This was referenced Nov 25, 2022
Merged
Merged
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fabpot fabpot fabpot approved these changes

@GromNaN GromNaN GromNaN approved these changes

@chalasr chalasr Awaiting requested review from chalasr chalasr is a code owner

@wouterj wouterj Awaiting requested review from wouterj

@lyrixx lyrixx Awaiting requested review from lyrixx

@yceruto yceruto Awaiting requested review from yceruto

@dunglas dunglas Awaiting requested review from dunglas

@OskarStark OskarStark Awaiting requested review from OskarStark

@xabbuh xabbuh Awaiting requested review from xabbuh

Assignees
No one assigned
Labels
Console Status: Needs Review
Projects
None yet
Milestone
5.4
Development

Successfully merging this pull request may close these issues.
5 participants
@Chi-teck @carsonbot @GromNaN @fabpot @nicolas-grekas
0