Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .changeset/changesets/lucratively-safe-gurnard.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
changeset-operations: none
---
Add Copy derive to PrereleaseAction, GraduationAction, and AdditionalPackageField
4 changes: 4 additions & 0 deletions .changeset/changesets/sensually-profitable-ladybird.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
cargo-changeset: none
---
Replace magic index-to-variant mapping in Select prompts with strum-annotated mirror enums
22 changes: 22 additions & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions crates/cargo-changeset/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ changeset-project = { workspace = true }
changeset-version = { workspace = true }
clap = { workspace = true }
dialoguer = { workspace = true }
strum = { version = "0.28", features = ["derive"] }
tempfile = "3.25"
thiserror = { workspace = true }

Expand Down
54 changes: 23 additions & 31 deletions crates/cargo-changeset/src/commands/additional_packages.rs
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ use changeset_operations::traits::{

use crate::environment::is_interactive;
use crate::error::{CliError, Result};
use crate::interaction::{AdditionalPackageFieldSelectionOption, select_variant};

#[derive(Args)]
pub(crate) struct AdditionalPackagesArgs {
Expand Down Expand Up @@ -215,15 +216,14 @@ impl AdditionalPackageInteractionProvider for TerminalAdditionalPackageInteracti
&self,
package_path: &Path,
) -> changeset_operations::Result<Vec<String>> {
Ok(crate::interaction::prompt_multi_value(
&crate::interaction::MultiValuePromptConfig {
intro: "Enter glob patterns for files that influence this package \
crate::interaction::prompt_multi_value(&crate::interaction::MultiValuePromptConfig {
intro: "Enter glob patterns for files that influence this package \
(one per line, empty line to finish):",
first_prompt: "Glob pattern",
additional_prompt: "Additional pattern",
first_default: Some(format!("{}/**", package_path.display())),
},
)?)
first_prompt: "Glob pattern",
additional_prompt: "Additional pattern",
first_default: Some(format!("{}/**", package_path.display())),
})
.map_err(super::cli_error_to_operation_error)
}

fn prompt_manifest_file_path(&self) -> changeset_operations::Result<PathBuf> {
Expand Down Expand Up @@ -328,29 +328,21 @@ impl AdditionalPackageInteractionProvider for TerminalAdditionalPackageInteracti
fn select_field_to_edit(
&self,
) -> changeset_operations::Result<MenuSelection<AdditionalPackageField>> {
let options = [
"path",
"influence patterns",
"manifest file path",
"manifest format",
"manifest version path",
"Done",
];

let selection = Select::new()
.with_prompt("Which field would you like to edit?")
.items(options)
.interact_opt()
.map_err(super::dialoguer_to_operation_error)?;

Ok(match selection {
Some(0) => MenuSelection::Selected(AdditionalPackageField::Path),
Some(1) => MenuSelection::Selected(AdditionalPackageField::Influence),
Some(2) => MenuSelection::Selected(AdditionalPackageField::ManifestFilePath),
Some(3) => MenuSelection::Selected(AdditionalPackageField::ManifestFormat),
Some(4) => MenuSelection::Selected(AdditionalPackageField::ManifestVersionFieldPath),
_ => MenuSelection::Cancelled,
})
let selection = select_variant::<AdditionalPackageFieldSelectionOption>(
"Which field would you like to edit?",
0,
)
.map_err(super::cli_error_to_operation_error)?;

Ok(
match selection
.unwrap_or(AdditionalPackageFieldSelectionOption::Done)
.into_field()
{
Some(field) => MenuSelection::Selected(field),
None => MenuSelection::Cancelled,
},
)
}

fn confirm_removal(&self, name: &str) -> changeset_operations::Result<bool> {
Expand Down
54 changes: 24 additions & 30 deletions crates/cargo-changeset/src/commands/manage.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ use changeset_operations::traits::{
use super::{ManageArgs, ManageCommand, ManageGraduationArgs, ManagePrereleaseArgs};
use crate::environment::is_interactive;
use crate::error::{CliError, Result};
use crate::interaction::select_from_options;

struct TerminalManageInteractionProvider;

Expand All @@ -24,25 +25,21 @@ impl PrereleaseInteractionProvider for TerminalManageInteractionProvider {
&self,
) -> changeset_operations::Result<MenuSelection<PrereleaseAction>> {
let options = [
"Add crate to pre-release",
"Remove crate from pre-release",
"Graduate crate (move to graduation queue)",
"Done",
(PrereleaseAction::Add, "Add crate to pre-release"),
(PrereleaseAction::Remove, "Remove crate from pre-release"),
(
PrereleaseAction::Graduate,
"Graduate crate (move to graduation queue)",
),
(PrereleaseAction::Done, "Done"),
];

let selection = Select::new()
.with_prompt("What would you like to do?")
.items(options)
.default(0)
.interact_opt()
.map_err(super::dialoguer_to_operation_error)?;
let selection = select_from_options("What would you like to do?", &options, 0)
.map_err(super::cli_error_to_operation_error)?;

Ok(match selection {
Some(0) => MenuSelection::Selected(PrereleaseAction::Add),
Some(1) => MenuSelection::Selected(PrereleaseAction::Remove),
Some(2) => MenuSelection::Selected(PrereleaseAction::Graduate),
_ => MenuSelection::Selected(PrereleaseAction::Done),
})
Ok(MenuSelection::Selected(
selection.unwrap_or(PrereleaseAction::Done),
))
}

fn select_package_for_prerelease(
Expand Down Expand Up @@ -102,23 +99,20 @@ impl GraduationInteractionProvider for TerminalManageInteractionProvider {
&self,
) -> changeset_operations::Result<MenuSelection<GraduationAction>> {
let options = [
"Add crate to graduation queue",
"Remove crate from graduation queue",
"Done",
(GraduationAction::Add, "Add crate to graduation queue"),
(
GraduationAction::Remove,
"Remove crate from graduation queue",
),
(GraduationAction::Done, "Done"),
];

let selection = Select::new()
.with_prompt("What would you like to do?")
.items(options)
.default(0)
.interact_opt()
.map_err(super::dialoguer_to_operation_error)?;
let selection = select_from_options("What would you like to do?", &options, 0)
.map_err(super::cli_error_to_operation_error)?;

Ok(match selection {
Some(0) => MenuSelection::Selected(GraduationAction::Add),
Some(1) => MenuSelection::Selected(GraduationAction::Remove),
_ => MenuSelection::Selected(GraduationAction::Done),
})
Ok(MenuSelection::Selected(
selection.unwrap_or(GraduationAction::Done),
))
}

fn select_package_for_graduation(
Expand Down
103 changes: 103 additions & 0 deletions crates/cargo-changeset/src/commands/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -391,6 +391,27 @@ pub(super) fn dialoguer_to_operation_error(e: dialoguer::Error) -> OperationErro
}
}

pub(super) fn cli_error_to_operation_error(e: crate::error::CliError) -> OperationError {
use crate::error::CliError;
match e {
CliError::Io(io) => OperationError::Io(io),
CliError::NotATty => OperationError::InteractionRequired,
CliError::EditorFailed { source } => OperationError::Io(source),
CliError::Core(e) => OperationError::Core(e),
CliError::Git(e) => OperationError::Git(e),
CliError::Project(e) => OperationError::Project(e),
CliError::Operation(e) => e,
CliError::CurrentDir(io) => OperationError::Io(io),
CliError::ManifestFormatRequired | CliError::IncompleteArgs => {
OperationError::InteractionRequired
}
CliError::InvalidPackageBumpFormat { .. }
| CliError::InvalidBumpType { .. }
| CliError::VerificationFailed { .. }
| CliError::ChangesetDeleted { .. } => OperationError::Cancelled,
}
}

#[cfg(test)]
mod dialoguer_conversion_tests {
use std::io;
Expand Down Expand Up @@ -458,3 +479,85 @@ mod dialoguer_conversion_tests {
}
}
}

#[cfg(test)]
mod cli_error_conversion_tests {
use std::io;

use changeset_operations::OperationError;

use crate::error::CliError;

use super::cli_error_to_operation_error;

#[test]
fn io_error_maps_to_operation_io() {
let err = CliError::Io(io::Error::new(io::ErrorKind::NotFound, "not found"));

let result = cli_error_to_operation_error(err);

assert!(matches!(result, OperationError::Io(_)));
}

#[test]
fn not_a_tty_maps_to_interaction_required() {
let err = CliError::NotATty;

let result = cli_error_to_operation_error(err);

assert!(matches!(result, OperationError::InteractionRequired));
}

#[test]
fn incomplete_args_maps_to_interaction_required() {
let err = CliError::IncompleteArgs;

let result = cli_error_to_operation_error(err);

assert!(matches!(result, OperationError::InteractionRequired));
}

#[test]
fn operation_error_passes_through() {
let inner = OperationError::Cancelled;
let err = CliError::Operation(inner);

let result = cli_error_to_operation_error(err);

assert!(matches!(result, OperationError::Cancelled));
}

#[test]
fn project_error_maps_to_operation_project() {
use std::path::PathBuf;
let err = CliError::Project(changeset_project::ProjectError::NotFound {
start_dir: PathBuf::from("/test"),
});

let result = cli_error_to_operation_error(err);

assert!(matches!(result, OperationError::Project(_)));
}

#[test]
fn editor_failed_maps_to_operation_io() {
let err = CliError::EditorFailed {
source: io::Error::new(io::ErrorKind::NotFound, "editor not found"),
};

let result = cli_error_to_operation_error(err);

assert!(matches!(result, OperationError::Io(_)));
}

#[test]
fn invalid_package_bump_format_maps_to_cancelled() {
let err = CliError::InvalidPackageBumpFormat {
input: "bad".to_string(),
};

let result = cli_error_to_operation_error(err);

assert!(matches!(result, OperationError::Cancelled));
}
}
18 changes: 18 additions & 0 deletions crates/cargo-changeset/src/error.rs
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,14 @@ pub enum CliError {

pub type Result<T> = std::result::Result<T, CliError>;

impl From<dialoguer::Error> for CliError {
fn from(e: dialoguer::Error) -> Self {
match e {
dialoguer::Error::IO(io) => Self::Io(io),
}
}
}

#[cfg(test)]
mod tests {
use std::path::PathBuf;
Expand Down Expand Up @@ -153,4 +161,14 @@ mod tests {

assert!(matches!(cli_err, CliError::Operation(_)));
}

#[test]
fn dialoguer_error_converts_via_from() {
let io_err = std::io::Error::new(std::io::ErrorKind::BrokenPipe, "pipe closed");
let dialoguer_err = dialoguer::Error::IO(io_err);

let cli_err: CliError = dialoguer_err.into();

assert!(matches!(cli_err, CliError::Io(_)));
}
}
Loading
Loading