1
0
mirror of https://github.com/BurntSushi/ripgrep.git synced 2025-06-25 14:22:54 +02:00

ripgrep: better --path-separator error message

This commit improves the error message when --path-separator fails. Namely,
it prints the separator it got and also prints a notice for Windows users
for common failure modes.

Fixes #957
This commit is contained in:
Andrew Gallant
2018-07-22 09:32:31 -04:00
parent 7a44cad599
commit b9c922be53
3 changed files with 19 additions and 2 deletions

View File

@ -22,7 +22,7 @@ use ignore::overrides::{Override, OverrideBuilder};
use ignore::types::{FileTypeDef, Types, TypesBuilder};
use ignore;
use printer::{ColorSpecs, Printer};
use unescape::unescape;
use unescape::{escape, unescape};
use worker::{Worker, WorkerBuilder};
use config;
@ -749,7 +749,12 @@ impl<'a> ArgMatches<'a> {
} else if sep.len() > 1 {
Err(From::from(format!(
"A path separator must be exactly one byte, but \
the given separator is {} bytes.", sep.len())))
the given separator is {} bytes: {}\n\
In some shells on Windows '/' is automatically \
expanded. Use '//' instead.",
sep.len(),
escape(&sep),
)))
} else {
Ok(Some(sep[0]))
}

View File

@ -11,6 +11,15 @@ enum State {
Literal,
}
/// Escapes an arbitrary byte slice such that it can be presented as a human
/// readable string.
pub fn escape(bytes: &[u8]) -> String {
use std::ascii::escape_default;
let escaped = bytes.iter().flat_map(|&b| escape_default(b)).collect();
String::from_utf8(escaped).unwrap()
}
/// Unescapes a string given on the command line. It supports a limited set of
/// escape sequences:
///