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

higher level API #4

Closed
JoshMcguigan opened this issue May 18, 2019 · 2 comments
Closed

higher level API #4

JoshMcguigan opened this issue May 18, 2019 · 2 comments

Comments

@JoshMcguigan
Copy link
Owner

@JoshMcguigan JoshMcguigan commented May 18, 2019

Currently, the API exposed by shell_completion is very low level. Many goals of this crate will require the design and implementation of a higher level API.

This is a request for proposals for the shape of the public API of shell_completion. All ideas are welcome, and they don't have to be fully baked. Even something as simple as "I wish there was a method that does X" is useful feedback.

@JoshMcguigan
Copy link
Owner Author

@JoshMcguigan JoshMcguigan commented May 19, 2019

Hackernews user chubot suggested reviewing the [shellac protocol proposal] for API inspiration.

$ git --git-dir . a<TAB>

{ "SHELLAC_ARGV": ["git", "--git-dir", ".", "a"]
  "SHELLAC_ARGV_INDEX": 3,
  "SHELLAC_CHAR_INDEX": 1,
}

I'm going to move forward with a trait modeled after this protocol proposal.

@JoshMcguigan
Copy link
Owner Author

@JoshMcguigan JoshMcguigan commented May 19, 2019

Closing as #6 takes care of this in the short term. Feel free to create a new issue to suggest any changes or additions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
1 participant