Skip to content

Commit

Permalink
Align env var with docs (#449)
Browse files Browse the repository at this point in the history
The docs had `INSTA_FORCE_UPDATE`, but actually `INSTA_FORCE_UPDATE_SNAPSHOTS` was used. I kept the former, since that's consistent with the config file & cli options
  • Loading branch information
max-sixty committed Mar 2, 2024
1 parent a75308a commit 189290f
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 3 deletions.
8 changes: 7 additions & 1 deletion cargo-insta/src/cli.rs
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,9 @@ struct TestCommand {
/// Update all snapshots even if they are still matching.
#[structopt(long)]
force_update_snapshots: bool,
/// Require metadata as well as snapshots' contents to match.
#[structopt(long)]
require_full_match: bool,
/// Handle unreferenced snapshots after a successful test run.
#[structopt(long, default_value="ignore", possible_values=&["ignore", "warn", "reject", "delete", "auto"])]
unreferenced: String,
Expand Down Expand Up @@ -883,7 +886,10 @@ fn prepare_test_runner<'snapshot_ref>(
},
);
if cmd.force_update_snapshots {
proc.env("INSTA_FORCE_UPDATE_SNAPSHOTS", "1");
proc.env("INSTA_FORCE_UPDATE", "1");
}
if cmd.require_full_match {
proc.env("INSTA_REQUIRE_FULL_MATCH", "1");
}
let glob_filter =
cmd.glob_filter
Expand Down
9 changes: 7 additions & 2 deletions src/env.rs
Original file line number Diff line number Diff line change
Expand Up @@ -143,14 +143,19 @@ impl ToolConfig {
}
let cfg = cfg.unwrap_or_else(|| Content::Map(Default::default()));

if let Ok("1") = env::var("INSTA_FORCE_UPDATE_SNAPSHOTS").as_deref() {
eprintln!("INSTA_FORCE_UPDATE_SNAPSHOTS is deprecated, use INSTA_FORCE_UPDATE");
env::set_var("INSTA_FORCE_UPDATE", "1");
}

Ok(ToolConfig {
force_update_snapshots: match env::var("INSTA_FORCE_UPDATE_SNAPSHOTS").as_deref() {
force_update_snapshots: match env::var("INSTA_FORCE_UPDATE").as_deref() {
Err(_) | Ok("") => resolve(&cfg, &["behavior", "force_update"])
.and_then(|x| x.as_bool())
.unwrap_or(false),
Ok("0") => false,
Ok("1") => true,
_ => return Err(Error::Env("INSTA_FORCE_UPDATE_SNAPSHOTS")),
_ => return Err(Error::Env("INSTA_FORCE_UPDATE")),
},
force_pass: match env::var("INSTA_FORCE_PASS").as_deref() {
Err(_) | Ok("") => resolve(&cfg, &["behavior", "force_pass"])
Expand Down

0 comments on commit 189290f

Please sign in to comment.