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

Add compile time completion generation #328

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

willwill2will54
Copy link

  • Add code generation
  • Integrate with CD
  • Document instructions for users

Adds completions that are generated at compile time and stored under the perseus-cli package in version control.
Fulfulls feature request #325.
TBD is deciding the story on distribution and writing up documentation.
@arctic-hen7 I would suggest we add the files to the automated GitHub release. Instructions would instruct users to download the file, copy to a sensible location, and update the shell environment files appropriately, with a subsection for each supported shell.
If you I agree I can handle adding that to the CD workflow and write up the completion installation as a addendum to the existing "Installing Perseus" page.

@arctic-hen7 arctic-hen7 linked an issue Jul 7, 2024 that may be closed by this pull request
@arctic-hen7
Copy link
Member

This is looking wonderful, thank you so much! I'm not that familiar with clap's completion system, so should the completion files be checked into Git as they currently are?

Apart from that, everything you've said about distribution and documentation sounds really good! Is the elegance of a perseus completions <shell-name> command possible with what you've done so far, or would that be a runtime system? Happy to help with getting the files into the GitHub release if you need.

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.

Request: Add CLI Completion
2 participants