Corrects several windows bugs and bad names

This commit is contained in:
Dandaedre 2023-05-24 20:08:01 +02:00
parent 88c0506f6a
commit d2f767abc8
4 changed files with 100 additions and 31 deletions

15
TODO.md
View File

@ -3,14 +3,15 @@
[ ] Better use of file modes
[ ] Find a solution for the .badpocalypse
[ ] Edit args only
[ ] Double backslash windows
[ ] Case sensitivity windows
[ ] Bigger message for print "The snippet name can be found at "
[ ] Use Ok for results instead of prints
[ ] Use priority instead of a cursed match statement
[ ] Correct the newline problem (with toml ?)
[ ] Have a method to get name, path and all with a custom error on unwrap
### Currently working on
[ ] Add some examples with --example
[ ] Error: Delete, unclear
[-] Add some examples with --example
[ ] Have an actual human give feedback on the error name readability
## Finished
[*] Edit -> edit-all
@ -19,10 +20,12 @@
[*] Remove the prerequiste of name for --list
[*] Better message on no erase
[*] Comment on no op with replace
[*] Add example to the tests on actions, wrapper_functions
[*] Double backslash windows
## Posponed or rendered useless
[x] Chain the methods when possible with result ?
[ ] Make a lib for dynamic_format and snippets (impl make a trait for have .id() and other future t)
[ ] Change all uncatchables errors to expect to be more helpful or change them to better errors
[ ] Document non coverage
[*] Error: Delete, unclear ?

View File

@ -23,6 +23,8 @@ pub enum Actions {
Rename,
/// Find a snippet matching a name/regex
Find,
/// Create an example snippet
Example,
}
/// The main worker, execute all commands given as Args
@ -38,6 +40,7 @@ pub fn execute_parsed_cli(cli: Cli) -> Result<(), errors::SnippetError> {
Actions::Delete => wrapper_functions::delete_snippet(&cli),
Actions::Rename => wrapper_functions::rename_snippet(&cli),
Actions::List => wrapper_functions::list_snippets(&cli),
Actions::Example => wrapper_functions::create_example(&cli),
} {
println!("An error occured during runtime:\n\t{}", e);
// if let Some(e) = e.source() {
@ -62,17 +65,19 @@ fn populate_actions(cli: &Cli) -> Vec<Actions> {
cli.delete,
&cli.rename,
cli.list,
cli.example,
) {
(true, _, _, _, false, _, false) => actions.push(Actions::Find),
(_, false, false, true, false, _, false) => actions.push(Actions::EditAll),
(_, true, _, true, false, _, false) => actions.push(Actions::EditAll),
(_, true, false, false, false, _, false) => actions.push(Actions::Create),
(_, false, true, _, false, _, false) => actions.push(Actions::Edit),
(_, true, true, false, false, _, false) => actions.push(Actions::Edit),
(false, false, false, false, false, None, false) => actions.push(Actions::Show),
(_, _, _, _, true, _, false) => actions.push(Actions::Delete),
(_, _, _, _, _, Some(_), false) => actions.push(Actions::Rename),
(_, _, _, _, _, _, true) => actions.push(Actions::List),
(true, _, _, _, false, _, false, false) => actions.push(Actions::Find),
(_, false, false, true, false, _, false, false) => actions.push(Actions::EditAll),
(_, true, _, true, false, _, false, false) => actions.push(Actions::EditAll),
(_, true, false, false, false, _, false, false) => actions.push(Actions::Create),
(_, false, true, _, false, _, false, false) => actions.push(Actions::Edit),
(_, true, true, false, false, _, false, false) => actions.push(Actions::Edit),
(false, false, false, false, false, None, false, false) => actions.push(Actions::Show),
(_, _, _, _, true, _, false, false) => actions.push(Actions::Delete),
(_, _, _, _, _, Some(_), false, false) => actions.push(Actions::Rename),
(_, _, _, _, _, _, true, false) => actions.push(Actions::List),
(_, _, _, _, _, _, _, true) => actions.push(Actions::Example),
}
actions
}
@ -138,6 +143,7 @@ mod test {
vec![Actions::Create]
),
(false_cli!("snp", "-l"), vec![Actions::List]),
(false_cli!("snp", "--example"), vec![Actions::Example]),
(false_cli!("snp"), vec![Actions::Show]), // It's an acceptable error
// (false_cli!("snp", "-l"), vec![Actions::List]),
);
@ -162,6 +168,8 @@ mod test {
false_cli!("snp", "parsed_cli", "-r", "new_name", "-f"),
false_cli!("snp", "new_name", "-d"),
false_cli!("snp", "-l"),
false_cli!("snp"),
false_cli!("snp", "--example"),
];
let bad_cli = vec![

View File

@ -12,9 +12,16 @@ mod tokenizer;
mod wrapper_functions;
/// SNP an utility to create and manage Snippets of code
/// Use "snp -c -E snippet_name" to create a new Snippet and start editing it and "snp snippet_name argument" to use it
/// You can use "{}" or "{0}" in your Snippet to later format it to your needs as would python .format() or rust format!("",) work
/// Doing so will need as many default arguments to fill the command than the total count of {}
/// -
/// Use "snp -c -E snippet_name" to create a new Snippet and
/// directly start editing it, then use"snp snippet_name" to use it.
/// You can use "{}" or "{0}" in your Snippet to later format it to
/// your needs as would python .format() or rust format!("",) work
/// Doing so will need as many default arguments to fill the command
/// than the total count of {}
/// -
/// You can get a working example with --example witch will guide you
/// through all the basic steps for snippet creation and edition
#[derive(Parser, Debug)]
#[command(author, version, about, verbatim_doc_comment)]
pub struct Cli {
@ -43,8 +50,7 @@ pub struct Cli {
)]
edit_all: bool,
/// The list of arguments to give to the snippet
/// if the -c flag is used, it's used to create the default arguments
/// The list of arguments to give to the snippet or the snippet creator
#[arg(requires = "mandatory")]
args: Vec<String>,
@ -63,6 +69,10 @@ pub struct Cli {
/// List all snippets in the snippet folder
#[arg(short, long, default_value_t = false, group = "mutex")]
list: bool,
/// Create an example snippet named example with some basic documentation
#[arg(long, default_value_t = false, group = "mutex")]
example: bool,
}
/// Main entry point, everything is defered for testing and coverage

View File

@ -22,7 +22,11 @@ pub fn locate_snippet(cli: &Cli) -> Result<(), SnippetError> {
let status = check_dir_and_open(cli.snippet.as_ref().unwrap())?;
match status {
FileStatus::Opened((p, _)) => {
println!("{:?}", p.as_os_str());
println!(
"The snippet {} is located at \"{}\"",
cli.snippet.as_ref().unwrap(),
p.as_os_str().to_str().unwrap()
);
Ok(())
}
FileStatus::NotFound(p) => Err(SnippetError::NotFoundNoRetryError(p)),
@ -51,7 +55,10 @@ pub fn create_snippet(cli: &Cli) -> Result<(), SnippetError> {
FileStatus::NotFound(p) => (File::create(&p)?, p), // Create a new snippet
};
snp.save_in(&f)?;
println!("The snippet {:?} was created successfully", p);
println!(
"The snippet {} was created successfully",
p.as_os_str().to_str().unwrap()
);
Ok(())
}
@ -124,8 +131,8 @@ pub fn edit_snippet(cli: &Cli) -> Result<(), SnippetError> {
snp.write_over(&p)?;
println!(
"The snippet {:?} was succesfully saved",
p.file_name().unwrap()
"The snippet {} was succesfully saved",
p.file_name().unwrap().to_str().unwrap()
);
Ok(())
}
@ -161,8 +168,8 @@ pub fn edit_whole_snippet(cli: &Cli) -> Result<(), SnippetError> {
// No renaming has occured, the file can safely be overriten
snp.write_over(&origin_p)?;
println!(
"The snippet {:?} was succesfully saved",
origin_p.file_name().unwrap()
"The snippet {} was succesfully saved",
origin_p.file_name().unwrap().to_str().unwrap()
);
Ok(())
} else {
@ -183,7 +190,10 @@ pub fn edit_whole_snippet(cli: &Cli) -> Result<(), SnippetError> {
FileStatus::NotFound(p) => (File::create(&p)?, p),
};
snp.save_in(&dest_f)?;
println!("The snippet was successfuly saved in {:?}", dest_p);
println!(
"The snippet was successfuly saved in {}",
dest_p.into_os_string().to_str().unwrap()
);
Ok(())
}
}
@ -195,8 +205,8 @@ pub fn edit_whole_snippet(cli: &Cli) -> Result<(), SnippetError> {
write!(failover, "{}", &buf)?;
println!(
"The snippet was saved under {:?} in your config",
origin_p.file_name().unwrap()
"The snippet was saved under {} in your config",
origin_p.file_name().unwrap().to_str().unwrap()
);
Err(SnippetError::ReparsingError)
}
@ -227,9 +237,10 @@ pub fn list_snippets(_cli: &Cli) -> Result<(), SnippetError> {
/// Print the snippet to stdout
pub fn print_snippet(cli: &Cli) -> Result<(), SnippetError> {
// Try to load the snippet <name>i
if let None = cli.snippet {
if cli.snippet.is_none() {
// This wonky hack exists because of subcommands
// It could also be checked when populating, but is way easier this
#[cfg(not(feature = "test"))]
Cli::command().print_long_help()?;
return Ok(());
}
@ -263,6 +274,43 @@ pub fn delete_snippet(cli: &Cli) -> Result<(), SnippetError> {
);
Ok(())
}
/// Create an example snippet with a small guide and the next step printed out
pub fn create_example(_cli: &Cli) -> Result<(), SnippetError> {
let mut path = config_folder()?;
path.push("unique_example.yaml");
println!(
"The snippet unique_example was created. You can use the following command to launch an editor and begin editing it:
$ snp unique_example -E
Once you are done with the editing, you can try using the snippet with:
$ snp unique_example
If you wish to delete the snippet, you can use the following command:
$ snp -d unique_example"
);
let arguments = vec!["Argument 1", "Argument 2", "Foo", "Bar"];
let text = "This is a snippet created as an example.
You can type several lines of code to help you in your daily coding process.
This snippet manager accepts either {} as a argument placeholder
and will fill it with Argument 1, the first argument.
You can also use {0} to have the first argument somewhere else.
Or {3} to skip to the last argument and finish with {} {} {}
If you only needed to edit this code part and not the snippet,
you can use instead `snp unique_example -e` (not -E).
Please consult the --help for the full list of commands !
";
let snp = Snippet::new(
"unique_example".to_string(),
arguments.iter().map(|s| s.to_string()).collect(),
text.to_string(),
);
_ = std::fs::remove_file(&path);
let f = File::create(path)?;
snp.save_in(&f)?;
Ok(())
}
/// The status of the request after the path was attempted to be opened
pub enum FileStatus {
/// The file was opened with success a tuple is returned