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

Document how to add autocompletion #32

Merged
merged 4 commits into from
Jun 16, 2020

Conversation

weierophinney
Copy link
Member

Details how to add autocompletion for laminas-cli, via bamarni/symfony-console-autocomplete.

Fixes #9

Details how to add autocompletion for laminas-cli.

Fixes laminas#9

Signed-off-by: Matthew Weier O'Phinney <matthew@weierophinney.net>
@michalbundyra michalbundyra added Documentation Improvements or additions to documentation Enhancement labels Jun 16, 2020
Copy link
Member

@michalbundyra michalbundyra left a comment

Choose a reason for hiding this comment

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

@weierophinney

Just tried with my demo mvc skeleton application and it works fine.
One point, which is missing (it might be obvious for many, but I guess not for all), after changing the configuration you need to reload/reopen shell to get the configuration applied.

- For ZSH users, `source $HOME/.zshrc`
- For FISH users, `source $HOME/.config/fish/config.fish`

At this point, when you are in a project that uses laminas-cli, you can type:
Copy link
Member

Choose a reason for hiding this comment

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

... after restarting shell :)

Copy link
Member

Choose a reason for hiding this comment

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

I suggest to also add a headline like "Usage".

Copy link
Member Author

Choose a reason for hiding this comment

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

Done, @froschdesign :)

@weierophinney
Copy link
Member Author

@michalbundyra That's why I mention the usage of source at the end of the document - that applies it to the current shell.

weierophinney and others added 3 commits June 16, 2020 13:11
Signed-off-by: Matthew Weier O'Phinney <matthew@weierophinney.net>

Co-authored-by: Frank Brückner <info@froschdesignstudio.de>
Signed-off-by: Matthew Weier O'Phinney <matthew@weierophinney.net>

Co-authored-by: Frank Brückner <info@froschdesignstudio.de>
Signed-off-by: Matthew Weier O'Phinney <matthew@weierophinney.net>
Copy link
Member

@michalbundyra michalbundyra left a comment

Choose a reason for hiding this comment

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

🚢

@weierophinney weierophinney merged commit c0bf035 into laminas:master Jun 16, 2020
@weierophinney weierophinney deleted the docs/autocompletion branch June 16, 2020 18:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation Enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Command autocomplete
3 participants