Minor fixes

Cargo.toml

@@ -2,7 +2,7 @@
 authors = ["chevdor <[email protected]>"]
 edition = "2021"
 name = "gh"
-version = "0.2.0"
+version = "0.2.4"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 

README.md

@@ -28,3 +28,16 @@ The url is fetched on your remotes.
 -   `gh` to simply open the first remote
 
 -   `gh upstream` to open your `upstream` remote
+
+<!-- -->
+
+    Command line utility for the tera templating engine. You need to provide a template using the tera syntax as well as some data (various format are supported)
+
+    Usage: gh [REMOTE]
+
+    Arguments:
+      [REMOTE]  Name of a remote
+
+    Options:
+      -h, --help     Print help information
+      -V, --version  Print version information

README.adoc → README_src.adoc

@@ -28,3 +28,7 @@ The url is fetched on your remotes.
 
 - `gh` to simply open the first remote
 - `gh upstream` to open your `upstream` remote
+
+----
+include::doc/usage.adoc[]
+----

doc/usage.adoc

@@ -0,0 +1,10 @@
+Command line utility for the tera templating engine. You need to provide a template using the tera syntax as well as some data (various format are supported)
+
+Usage: gh [REMOTE]
+
+Arguments:
+  [REMOTE]  Name of a remote
+
+Options:
+  -h, --help     Print help information
+  -V, --version  Print version information

justfile

@@ -8,16 +8,15 @@ default:
 # Generate the readme as .md
 md:
     #!/usr/bin/env bash
-    asciidoctor -b docbook -a leveloffset=+1 -o - README.adoc | pandoc   --markdown-headings=atx --wrap=preserve -t markdown_strict -f docbook - > README.md
+    asciidoctor -b docbook -a leveloffset=+1 -o - README_src.adoc | pandoc   --markdown-headings=atx --wrap=preserve -t markdown_strict -f docbook - > README.md
 
 # Generate usage samples
 _usage:
 	cargo run -q -- --help > doc/usage.adoc
 
 # Generate documentation
 doc:_usage
-	cargo doc -p tera-cli --all-features --no-deps
-
+	cargo doc --all-features --no-deps
 
 # Run rustfmt
 _fmt:

src/main.rs

@@ -25,24 +25,24 @@ fn run_command(cmd: &str) -> Result<String, String> {
 fn get_url(remote: &str) -> Result<String, String> {
 	debug!("get url for: {}", remote);
 
-	let cmd = format!("git config remote.{}.url", remote);
-	debug!("{}", cmd);
+	let cmd = format!("git config remote.{remote}.url");
+	debug!("{cmd}");
 	let url = run_command(&cmd)?;
 
 	// we remove the ".git" to make the regexp simpler
 	let cleaned = url.trim_end().replace(".git", "");
-	debug!("cleaned: {}", cleaned);
+	debug!("cleaned: {cleaned}");
 
 	let re = Regex::new(r"(git@|https?://)(.*?)(:|/)(.*)").unwrap();
 	let caps = re.captures(&cleaned).unwrap();
 
 	let site = caps.get(2).map(|m| m.as_str()).expect("Failed parsing site, please report this issue");
 	let repo = caps.get(4).map(|m| m.as_str()).expect("Failed parsing the repo, please report this issue");
 
-	debug!("site: {}", site);
-	debug!("repo: {}", repo);
+	debug!("site: {site}");
+	debug!("repo: {repo}");
 
-	Ok(format!("https://{site}/{repo}", site = site, repo = repo))
+	Ok(format!("https://{site}/{repo}"))
 }
 
 fn main() -> Result<(), String> {
@@ -62,10 +62,10 @@ fn main() -> Result<(), String> {
 	let remote = String::from(remote);
 	let remote = remote.trim_end();
 
-	let url = get_url(remote).unwrap_or_else(|_| panic!("Failed getting url for '{}'", remote));
+	let url = get_url(remote).unwrap_or_else(|_| panic!("Failed getting url for '{remote}'"));
 
-	debug!("Opening {} => {}", git_remote, url);
-	print!("{}", url);
+	debug!("Opening {git_remote} => {url}");
+	print!("{url}");
 	match webbrowser::open(&url) {
 		Ok(_) => Ok(()),
 		_ => Err("Problem while opening browser".to_string()),