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

Bash Completion #50

Open
9 tasks
andyl opened this issue Mar 1, 2018 · 11 comments
Open
9 tasks

Bash Completion #50

andyl opened this issue Mar 1, 2018 · 11 comments
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@andyl
Copy link
Contributor

andyl commented Mar 1, 2018

Enhancement Request: add Bash Completion for the BMX CLI.

Phase 1)

  • write a dummy Ruby script and build a bash completion for it
  • send PR containing markdown file with a BMX Bash Completion design overview
  • participate in review and feedback on GitHub and slack
  • send PR with the bash completion script
  • send PR with documentation on how to install/use the completion

Phase 2)

  • embed the bash completion script in the BMX CLI
  • eg bmx config completion > /etc/bash_completion.d/bmx
  • update documentation

Phase 3)

  • autogenerate the bash completion by introspection - see example
@andyl andyl added enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels Mar 1, 2018
@andyl andyl mentioned this issue Mar 5, 2018
3 tasks
@hritvi
Copy link
Collaborator

hritvi commented Mar 5, 2018

Hey @andyl I would like to contribute in this but i can't figure it out how one can help. Can you please give some information about this :)

@andyl
Copy link
Contributor Author

andyl commented Mar 5, 2018

@hritvi Read this tutorial on bash completion.

The task deliverable would be a bash completion script for the bmx executable.

@andyl andyl assigned andyl and hritvi and unassigned andyl Mar 8, 2018
@Shruti9520
Copy link

Shruti9520 commented Mar 8, 2018

@andyl I've written a script for releasing my project during my college internship. That was a simple one. I am not sure how complex this task would be but I want to try. Can I take this up?

Thanks!

@hritvi Let me know if you are still working on this. :)

@andyl
Copy link
Contributor Author

andyl commented Mar 8, 2018

@Shruti9520 I will assign you to this issue. If @hritvi wants to continue, you can both develop independent solutions, then we can compare/contrast and share learnings. I updated my original comment with Phase 1/2/3 outcomes - please let me know if these look ok.

@Shruti9520
Copy link

@andyl Alright! Heading towards phase-1.

Thanks :-)

@hritvi
Copy link
Collaborator

hritvi commented Mar 9, 2018

Hey @Shruti9520 I am still working on this

@Shruti9520
Copy link

Hi @andyl
Phase-1 Task-1--> write a dummy Ruby script and build a bash completion for it
I made a simple script. Basically, there are two files shell.sh and shell-completion.sh.
main script file-
if [ -z "$1" ]; then echo "No commands passed" exit fi echo "Directory"
Completion script file-
complete -A directory shell.sh
Result-
completion

That's a very simple bash completion script but I learned all important points. :)

Thanks!

@Shruti9520
Copy link

@hritvi Let's work together. :-)

@hritvi
Copy link
Collaborator

hritvi commented Mar 9, 2018

Hey @andyl ! I have created the bash completion design overview. Please review. Thanks :)

@GeorgLink
Copy link
Collaborator

GeorgLink commented Mar 9, 2018

Thanks @hritvi @Shruti9520,

@andyl is out of town for a few days and might not get to review before next week.

@hritvi
Copy link
Collaborator

hritvi commented Mar 22, 2018

Any updates on this bug @andyl! Can you please brief me what I can do next. Thanks :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

4 participants