aboutsummaryrefslogtreecommitdiff
path: root/clap/src/suggestions.rs
diff options
context:
space:
mode:
authorRobin Krahl <robin.krahl@ireas.org>2020-01-07 11:18:04 +0000
committerDaniel Mueller <deso@posteo.net>2020-01-08 09:20:25 -0800
commit5e20a29b4fdc8a2d442d1093681b396dcb4b816b (patch)
tree55ab083fa8999d2ccbb5e921c1ffe52560dca152 /clap/src/suggestions.rs
parent203e691f46d591a2cc8acdfd850fa9f5b0fb8a98 (diff)
downloadnitrocli-5e20a29b4fdc8a2d442d1093681b396dcb4b816b.tar.gz
nitrocli-5e20a29b4fdc8a2d442d1093681b396dcb4b816b.tar.bz2
Add structopt dependency in version 0.3.7
This patch series replaces argparse with structopt in the argument handling code. As a first step, we need structopt as a dependency. Import subrepo structopt/:structopt at efbdda4753592e27bc430fb01f7b9650b2f3174d Import subrepo bitflags/:bitflags at 30668016aca6bd3b02c766e8347e0b4080d4c296 Import subrepo clap/:clap at 784524f7eb193e35f81082cc69454c8c21b948f7 Import subrepo heck/:heck at 093d56fbf001e1506e56dbfa38631d99b1066df1 Import subrepo proc-macro-error/:proc-macro-error at 6c4cfe79a622c5de8ae68557993542be46eacae2 Import subrepo proc-macro2/:proc-macro2 at d5d48eddca4566e5438e8a2cbed4a74e049544de Import subrepo quote/:quote at 727436c6c137b20f0f34dde5d8fda2679b9747ad Import subrepo rustversion/:rustversion at 0c5663313516263059ce9059ef81fc7a1cf655ca Import subrepo syn-mid/:syn-mid at 5d3d85414a9e6674e1857ec22a87b96e04a6851a Import subrepo syn/:syn at e87c27e87f6f4ef8919d0372bdb056d53ef0d8f3 Import subrepo textwrap/:textwrap at abcd618beae3f74841032aa5b53c1086b0a57ca2 Import subrepo unicode-segmentation/:unicode-segmentation at 637c9874c4fe0c205ff27787faf150a40295c6c3 Import subrepo unicode-width/:unicode-width at 3033826f8bf05e82724140a981d5941e48fce393 Import subrepo unicode-xid/:unicode-xid at 4baae9fffb156ba229665b972a9cd5991787ceb7
Diffstat (limited to 'clap/src/suggestions.rs')
-rw-r--r--clap/src/suggestions.rs147
1 files changed, 147 insertions, 0 deletions
diff --git a/clap/src/suggestions.rs b/clap/src/suggestions.rs
new file mode 100644
index 0000000..06071d2
--- /dev/null
+++ b/clap/src/suggestions.rs
@@ -0,0 +1,147 @@
+use app::App;
+// Third Party
+#[cfg(feature = "suggestions")]
+use strsim;
+
+// Internal
+use fmt::Format;
+
+/// Produces a string from a given list of possible values which is similar to
+/// the passed in value `v` with a certain confidence.
+/// Thus in a list of possible values like ["foo", "bar"], the value "fop" will yield
+/// `Some("foo")`, whereas "blark" would yield `None`.
+#[cfg(feature = "suggestions")]
+#[cfg_attr(feature = "lints", allow(needless_lifetimes))]
+pub fn did_you_mean<'a, T: ?Sized, I>(v: &str, possible_values: I) -> Option<&'a str>
+where
+ T: AsRef<str> + 'a,
+ I: IntoIterator<Item = &'a T>,
+{
+ let mut candidate: Option<(f64, &str)> = None;
+ for pv in possible_values {
+ let confidence = strsim::jaro_winkler(v, pv.as_ref());
+ if confidence > 0.8 && (candidate.is_none() || (candidate.as_ref().unwrap().0 < confidence))
+ {
+ candidate = Some((confidence, pv.as_ref()));
+ }
+ }
+ match candidate {
+ None => None,
+ Some((_, candidate)) => Some(candidate),
+ }
+}
+
+#[cfg(not(feature = "suggestions"))]
+pub fn did_you_mean<'a, T: ?Sized, I>(_: &str, _: I) -> Option<&'a str>
+where
+ T: AsRef<str> + 'a,
+ I: IntoIterator<Item = &'a T>,
+{
+ None
+}
+
+/// Returns a suffix that can be empty, or is the standard 'did you mean' phrase
+#[cfg_attr(feature = "lints", allow(needless_lifetimes))]
+pub fn did_you_mean_flag_suffix<'z, T, I>(
+ arg: &str,
+ args_rest: &'z [&str],
+ longs: I,
+ subcommands: &'z [App],
+) -> (String, Option<&'z str>)
+where
+ T: AsRef<str> + 'z,
+ I: IntoIterator<Item = &'z T>,
+{
+ if let Some(candidate) = did_you_mean(arg, longs) {
+ let suffix = format!(
+ "\n\tDid you mean {}{}?",
+ Format::Good("--"),
+ Format::Good(candidate)
+ );
+ return (suffix, Some(candidate));
+ }
+
+ subcommands
+ .into_iter()
+ .filter_map(|subcommand| {
+ let opts = subcommand
+ .p
+ .flags
+ .iter()
+ .filter_map(|f| f.s.long)
+ .chain(subcommand.p.opts.iter().filter_map(|o| o.s.long));
+
+ let candidate = match did_you_mean(arg, opts) {
+ Some(candidate) => candidate,
+ None => return None
+ };
+ let score = match args_rest.iter().position(|x| *x == subcommand.get_name()) {
+ Some(score) => score,
+ None => return None
+ };
+
+ let suffix = format!(
+ "\n\tDid you mean to put '{}{}' after the subcommand '{}'?",
+ Format::Good("--"),
+ Format::Good(candidate),
+ Format::Good(subcommand.get_name())
+ );
+
+ Some((score, (suffix, Some(candidate))))
+ })
+ .min_by_key(|&(score, _)| score)
+ .map(|(_, suggestion)| suggestion)
+ .unwrap_or_else(|| (String::new(), None))
+}
+
+/// Returns a suffix that can be empty, or is the standard 'did you mean' phrase
+pub fn did_you_mean_value_suffix<'z, T, I>(arg: &str, values: I) -> (String, Option<&'z str>)
+where
+ T: AsRef<str> + 'z,
+ I: IntoIterator<Item = &'z T>,
+{
+ match did_you_mean(arg, values) {
+ Some(candidate) => {
+ let suffix = format!("\n\tDid you mean '{}'?", Format::Good(candidate));
+ (suffix, Some(candidate))
+ }
+ None => (String::new(), None),
+ }
+}
+
+#[cfg(all(test, features = "suggestions"))]
+mod test {
+ use super::*;
+
+ #[test]
+ fn possible_values_match() {
+ let p_vals = ["test", "possible", "values"];
+ assert_eq!(did_you_mean("tst", p_vals.iter()), Some("test"));
+ }
+
+ #[test]
+ fn possible_values_nomatch() {
+ let p_vals = ["test", "possible", "values"];
+ assert!(did_you_mean("hahaahahah", p_vals.iter()).is_none());
+ }
+
+ #[test]
+ fn suffix_long() {
+ let p_vals = ["test", "possible", "values"];
+ let suffix = "\n\tDid you mean \'--test\'?";
+ assert_eq!(
+ did_you_mean_flag_suffix("tst", p_vals.iter(), []),
+ (suffix, Some("test"))
+ );
+ }
+
+ #[test]
+ fn suffix_enum() {
+ let p_vals = ["test", "possible", "values"];
+ let suffix = "\n\tDid you mean \'test\'?";
+ assert_eq!(
+ did_you_mean_value_suffix("tst", p_vals.iter()),
+ (suffix, Some("test"))
+ );
+ }
+}