mab122
/
radicle-heartwood-lfs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

cli: Improve `rad init` wording 

If the user passes a <path> argument to init, it is incorrect and a
bit confusing to reference the "current directory" or "this directory"
e.g. "run rad . in current directory" when the repo was not created in the
current directory and was created with a path argument instead.

Use the path provided by the user in help text, otherwise reference
the current directory.
This commit is contained in:
josibake 2024-02-21 16:20:39 +01:00 committed by cloudhead
parent 18fc41c53f
commit ce1e1f71ae
No known key found for this signature in database
2 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
radicle-cli/examples/rad-init-no-git.md
View File

@ -3,7 +3,7 @@ it will fail:
``` (fail) ``` (fail)
$ rad init $ rad init
✗ Error: a Git repository was not found at the current path ✗ Error: a Git repository was not found at the given path
``` ```
Ok so let's initialize one. Ok so let's initialize one.

9
radicle-cli/src/commands/init.rs
View File

@ -196,7 +196,7 @@ pub fn init(options: Options, profile: &profile::Profile) -> anyhow::Result<()>
let repo = match git::Repository::open(&path) { let repo = match git::Repository::open(&path) {
Ok(r) => r, Ok(r) => r,
Err(e) if radicle::git::ext::is_not_found_err(&e) => { Err(e) if radicle::git::ext::is_not_found_err(&e) => {
anyhow::bail!("a Git repository was not found at the current path") anyhow::bail!("a Git repository was not found at the given path")
} }
Err(e) => return Err(e.into()), Err(e) => return Err(e.into()),
}; };
@ -316,8 +316,13 @@ pub fn init(options: Options, profile: &profile::Profile) -> anyhow::Result<()>
term::format::dim("(RID)"), term::format::dim("(RID)"),
term::format::highlight(rid.urn()) term::format::highlight(rid.urn())
); );
let directory = if path == cwd {
"this directory".to_owned()
} else {
term::format::tertiary(path.display()).to_string()
};
term::info!( term::info!(
"You can show it any time by running {} from this directory.", "You can show it any time by running {} from {directory}.",
term::format::command("rad .") term::format::command("rad .")
); );
term::blank(); term::blank();