Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore(show): Rename search-term to pkg-path #1445

Merged
merged 3 commits into from
May 15, 2024
Merged

chore(show): Rename search-term to pkg-path #1445

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b537848
chore(show): Rename search-term to pkg-path
dcarley May 10, 2024
d6b6ac2
fixup! chore(show): Rename search-term to pkg-path
dcarley May 10, 2024
717e8e9
Merge branch 'main' into dcarley/show-rename-arg
ysndr May 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions cli/flox/doc/flox-show.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ flox-show - show detailed information about a single package
# SYNOPSIS

```
flox [<general-options>] show <search-term>
flox [<general-options>] show <pkg-path>
```

# DESCRIPTION
Expand All @@ -35,7 +35,7 @@ and version.

## Show Options

`<search-term>`
`<pkg-path>`
: Package name to show details for.

# EXAMPLES:
Expand Down
19 changes: 8 additions & 11 deletions cli/flox/src/commands/show.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,18 +28,18 @@ pub struct Show {

/// The package to show detailed information about. Must be an exact match
/// for a pkg-path e.g. something copy-pasted from the output of `flox search`.
#[bpaf(positional("search-term"))]
pub search_term: String,
#[bpaf(positional("pkg-path"))]
pub pkg_path: String,
}

impl Show {
#[instrument(name = "show", fields(show_all = self.all, search_term = self.search_term), skip_all)]
#[instrument(name = "show", fields(show_all = self.all, pkg_path = self.pkg_path), skip_all)]
pub async fn handle(self, flox: Flox) -> Result<()> {
subcommand_metric!("show");

let (results, exit_status) = if let Some(client) = flox.catalog_client {
tracing::debug!("using catalog client for show");
match client.package_versions(&self.search_term).await {
match client.package_versions(&self.pkg_path).await {
Ok(results) => (results, None),
// Below, results.is_empty() is used to mean the search_term
// didn't match a package.
Expand All @@ -60,7 +60,7 @@ impl Show {
let (manifest, lockfile) = manifest_and_lockfile(&flox, "Show using")
.context("failed while looking for manifest and lockfile")?;
let search_params = construct_show_params(
&self.search_term,
&self.pkg_path,
manifest.map(|p| p.try_into()).transpose()?,
global_manifest_path(&flox).try_into()?,
PathOrJson::Path(lockfile),
Expand All @@ -71,10 +71,7 @@ impl Show {
};

if results.results.is_empty() {
bail!(
"no packages matched this search term: '{}'",
self.search_term
);
bail!("no packages matched this pkg-path: '{}'", self.pkg_path);
}
// Render what we have no matter what, then indicate whether we encountered an error.
render_show(results.results.as_slice(), self.all)?;
Expand Down Expand Up @@ -197,15 +194,15 @@ mod test {
let search_term = "search_term";
let err = Show {
all: false,
search_term: search_term.to_string(),
pkg_path: search_term.to_string(),
}
.handle(flox)
.await
.unwrap_err();

assert_eq!(
err.to_string(),
format!("no packages matched this search term: '{}'", search_term)
format!("no packages matched this pkg-path: '{}'", search_term)
);
}
}