-
Notifications
You must be signed in to change notification settings - Fork 15
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
Ion dump #2
Conversation
pub mod dump; | ||
|
||
// Creates a Vec of CLI configurations for all of the available built-in commands | ||
pub fn built_in_commands() -> Vec<App<'static, 'static>> { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The project's directory structure and the contents of this file were inspired by cargo
, which follows a similar pattern.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are you/cargo making some distinction between "built-in" commands and some other type of commands? If not, perhaps the term is simply "subcommands" (here and elsewhere).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are you/cargo making some distinction between "built-in" commands and some other type of commands?
Yes. "Built-in" commands are part of the same ion
executable (and so show up in the output of ion help
) while "external" commands are (potentially 3rd party) executables installed separately on the user's $PATH
. See #1 for some extra detail.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One question below, otherwise looks like a good starting place, and assuming we're comfortable changing the contract as discussions continue (I assume that's what you mean by "API subject to change" in the readme).
pub mod dump; | ||
|
||
// Creates a Vec of CLI configurations for all of the available built-in commands | ||
pub fn built_in_commands() -> Vec<App<'static, 'static>> { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are you/cargo making some distinction between "built-in" commands and some other type of commands? If not, perhaps the term is simply "subcommands" (here and elsewhere).
Description of changes:
cargo build
orcargo install
will build the code in theion-c
submodule and link against the resulting libraries.ion dump
command that wraps theion-c
CLI and exposes a limited number of options.README.md
file.Testing
If you don't already have it, you can install
cargo
usingrustup
.Example output for
ion
:Example output for
ion help dump
:By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.