mirror of
https://github.com/nushell/nushell.git
synced 2025-04-11 06:48:31 +02:00
Better help search (#789)
This commit is contained in:
JT
GitHub
parent
69b2ed5566
commit
91883bd572
@ -88,7 +88,7 @@ fn help(
|
|||||||
let full_commands = engine_state.get_signatures_with_examples(false);
|
let full_commands = engine_state.get_signatures_with_examples(false);
|
||||||
|
|
||||||
if let Some(f) = find {
|
if let Some(f) = find {
|
||||||
let search_string = f.item;
|
let search_string = f.item.to_lowercase();
|
||||||
let mut found_cmds_vec = Vec::new();
|
let mut found_cmds_vec = Vec::new();
|
||||||
|
|
||||||
for (sig, _, is_plugin, is_custom) in full_commands {
|
for (sig, _, is_plugin, is_custom) in full_commands {
|
||||||
@ -226,150 +226,6 @@ fn help(
|
|||||||
])))
|
])))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// FIXME: the fancy help stuff needs to be reimplemented
|
|
||||||
/*
|
|
||||||
if rest[0].item == "commands" {
|
|
||||||
let mut sorted_names = scope.get_command_names();
|
|
||||||
sorted_names.sort();
|
|
||||||
|
|
||||||
let (mut subcommand_names, command_names) = sorted_names
|
|
||||||
.into_iter()
|
|
||||||
// private only commands shouldn't be displayed
|
|
||||||
.filter(|cmd_name| {
|
|
||||||
scope
|
|
||||||
.get_command(cmd_name)
|
|
||||||
.filter(|command| !command.is_private())
|
|
||||||
.is_some()
|
|
||||||
})
|
|
||||||
.partition::<Vec<_>, _>(|cmd_name| cmd_name.contains(' '));
|
|
||||||
|
|
||||||
fn process_name(
|
|
||||||
dict: &mut TaggedDictBuilder,
|
|
||||||
cmd_name: &str,
|
|
||||||
scope: Scope,
|
|
||||||
rest: Vec<Tagged<String>>,
|
|
||||||
name: Tag,
|
|
||||||
) -> Result<(), ShellError> {
|
|
||||||
let document_tag = rest[0].tag.clone();
|
|
||||||
let value = command_dict(
|
|
||||||
scope.get_command(cmd_name).ok_or_else(|| {
|
|
||||||
ShellError::labeled_error(
|
|
||||||
format!("Could not load {}", cmd_name),
|
|
||||||
"could not load command",
|
|
||||||
document_tag,
|
|
||||||
)
|
|
||||||
})?,
|
|
||||||
name,
|
|
||||||
);
|
|
||||||
|
|
||||||
dict.insert_untagged("name", cmd_name);
|
|
||||||
dict.insert_untagged(
|
|
||||||
"description",
|
|
||||||
value
|
|
||||||
.get_data_by_key("usage".spanned_unknown())
|
|
||||||
.ok_or_else(|| {
|
|
||||||
ShellError::labeled_error(
|
|
||||||
"Expected a usage key",
|
|
||||||
"expected a 'usage' key",
|
|
||||||
&value.tag,
|
|
||||||
)
|
|
||||||
})?
|
|
||||||
.as_string()?,
|
|
||||||
);
|
|
||||||
|
|
||||||
Ok(())
|
|
||||||
}
|
|
||||||
|
|
||||||
fn make_subcommands_table(
|
|
||||||
subcommand_names: &mut Vec<String>,
|
|
||||||
cmd_name: &str,
|
|
||||||
scope: Scope,
|
|
||||||
rest: Vec<Tagged<String>>,
|
|
||||||
name: Tag,
|
|
||||||
) -> Result<Value, ShellError> {
|
|
||||||
let (matching, not_matching) =
|
|
||||||
subcommand_names.drain(..).partition(|subcommand_name| {
|
|
||||||
subcommand_name.starts_with(&format!("{} ", cmd_name))
|
|
||||||
});
|
|
||||||
*subcommand_names = not_matching;
|
|
||||||
Ok(if !matching.is_empty() {
|
|
||||||
UntaggedValue::table(
|
|
||||||
&(matching
|
|
||||||
.into_iter()
|
|
||||||
.map(|cmd_name: String| -> Result<_, ShellError> {
|
|
||||||
let mut short_desc = TaggedDictBuilder::new(name.clone());
|
|
||||||
process_name(
|
|
||||||
&mut short_desc,
|
|
||||||
&cmd_name,
|
|
||||||
scope.clone(),
|
|
||||||
rest.clone(),
|
|
||||||
name.clone(),
|
|
||||||
)?;
|
|
||||||
Ok(short_desc.into_value())
|
|
||||||
})
|
|
||||||
.collect::<Result<Vec<_>, _>>()?[..]),
|
|
||||||
)
|
|
||||||
.into_value(name)
|
|
||||||
} else {
|
|
||||||
UntaggedValue::nothing().into_value(name)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
let iterator =
|
|
||||||
command_names
|
|
||||||
.into_iter()
|
|
||||||
.map(move |cmd_name| -> Result<_, ShellError> {
|
|
||||||
let mut short_desc = TaggedDictBuilder::new(name.clone());
|
|
||||||
process_name(
|
|
||||||
&mut short_desc,
|
|
||||||
&cmd_name,
|
|
||||||
scope.clone(),
|
|
||||||
rest.clone(),
|
|
||||||
name.clone(),
|
|
||||||
)?;
|
|
||||||
short_desc.insert_value(
|
|
||||||
"subcommands",
|
|
||||||
make_subcommands_table(
|
|
||||||
&mut subcommand_names,
|
|
||||||
&cmd_name,
|
|
||||||
scope.clone(),
|
|
||||||
rest.clone(),
|
|
||||||
name.clone(),
|
|
||||||
)?,
|
|
||||||
);
|
|
||||||
ReturnSuccess::value(short_desc.into_value())
|
|
||||||
});
|
|
||||||
|
|
||||||
Ok(iterator.into_action_stream())
|
|
||||||
} else if rest[0].item == "generate_docs" {
|
|
||||||
Ok(ActionStream::one(ReturnSuccess::value(generate_docs(
|
|
||||||
&scope,
|
|
||||||
))))
|
|
||||||
} else if rest.len() == 2 {
|
|
||||||
// Check for a subcommand
|
|
||||||
let command_name = format!("{} {}", rest[0].item, rest[1].item);
|
|
||||||
if let Some(command) = scope.get_command(&command_name) {
|
|
||||||
Ok(ActionStream::one(ReturnSuccess::value(
|
|
||||||
UntaggedValue::string(get_full_help(command.stream_command(), &scope))
|
|
||||||
.into_value(Tag::unknown()),
|
|
||||||
)))
|
|
||||||
} else {
|
|
||||||
Ok(ActionStream::empty())
|
|
||||||
}
|
|
||||||
} else if let Some(command) = scope.get_command(&rest[0].item) {
|
|
||||||
Ok(ActionStream::one(ReturnSuccess::value(
|
|
||||||
UntaggedValue::string(get_full_help(command.stream_command(), &scope))
|
|
||||||
.into_value(Tag::unknown()),
|
|
||||||
)))
|
|
||||||
} else {
|
|
||||||
Err(ShellError::labeled_error(
|
|
||||||
"Can't find command (use 'help commands' for full list)",
|
|
||||||
"can't find command",
|
|
||||||
rest[0].tag.span,
|
|
||||||
))
|
|
||||||
}
|
|
||||||
*/
|
|
||||||
} else {
|
} else {
|
||||||
let msg = r#"Welcome to Nushell.
|
let msg = r#"Welcome to Nushell.
|
||||||
|
|
||||||
@ -400,62 +256,3 @@ You can also learn more at https://www.nushell.sh/book/"#;
|
|||||||
.into_pipeline_data())
|
.into_pipeline_data())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/*
|
|
||||||
fn for_spec(name: &str, ty: &str, required: bool, tag: impl Into<Tag>) -> Value {
|
|
||||||
let tag = tag.into();
|
|
||||||
|
|
||||||
let mut spec = TaggedDictBuilder::new(tag);
|
|
||||||
|
|
||||||
spec.insert_untagged("name", UntaggedValue::string(name));
|
|
||||||
spec.insert_untagged("type", UntaggedValue::string(ty));
|
|
||||||
spec.insert_untagged(
|
|
||||||
"required",
|
|
||||||
UntaggedValue::string(if required { "yes" } else { "no" }),
|
|
||||||
);
|
|
||||||
|
|
||||||
spec.into_value()
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn signature_dict(signature: Signature, tag: impl Into<Tag>) -> Value {
|
|
||||||
let tag = tag.into();
|
|
||||||
let mut sig = TaggedListBuilder::new(&tag);
|
|
||||||
|
|
||||||
for arg in &signature.positional {
|
|
||||||
let is_required = matches!(arg.0, PositionalType::Mandatory(_, _));
|
|
||||||
|
|
||||||
sig.push_value(for_spec(arg.0.name(), "argument", is_required, &tag));
|
|
||||||
}
|
|
||||||
|
|
||||||
if signature.rest_positional.is_some() {
|
|
||||||
let is_required = false;
|
|
||||||
sig.push_value(for_spec("rest", "argument", is_required, &tag));
|
|
||||||
}
|
|
||||||
|
|
||||||
for (name, ty) in &signature.named {
|
|
||||||
match ty.0 {
|
|
||||||
NamedType::Mandatory(_, _) => sig.push_value(for_spec(name, "flag", true, &tag)),
|
|
||||||
NamedType::Optional(_, _) => sig.push_value(for_spec(name, "flag", false, &tag)),
|
|
||||||
NamedType::Switch(_) => sig.push_value(for_spec(name, "switch", false, &tag)),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
sig.into_value()
|
|
||||||
}
|
|
||||||
|
|
||||||
fn command_dict(command: Command, tag: impl Into<Tag>) -> Value {
|
|
||||||
let tag = tag.into();
|
|
||||||
|
|
||||||
let mut cmd_dict = TaggedDictBuilder::new(&tag);
|
|
||||||
|
|
||||||
cmd_dict.insert_untagged("name", UntaggedValue::string(command.name()));
|
|
||||||
|
|
||||||
cmd_dict.insert_untagged("type", UntaggedValue::string("Command"));
|
|
||||||
|
|
||||||
cmd_dict.insert_value("signature", signature_dict(command.signature(), tag));
|
|
||||||
cmd_dict.insert_untagged("usage", UntaggedValue::string(command.usage()));
|
|
||||||
|
|
||||||
cmd_dict.into_value()
|
|
||||||
}
|
|
||||||
|
|
||||||
*/
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user