v1.5.1

Author: giacomocavalieri

CHANGELOG.md

@@ -1,6 +1,6 @@
 # Changelog
 
-## 1.5.0 - 2025-12-11
+## 1.5.1 - 2025-12-11
 
 - The CLI has been improved with better error messages and a nicer overall look.
 - Birdie now has better tooling to deal with stale snapshots. A stale snapshot

gleam.toml

@@ -1,5 +1,5 @@
 name = "birdie"
-version = "1.5.0"
+version = "1.5.1"
 
 description = "🐦‍⬛ Snapshot testing in Gleam"
 licences = ["Apache-2.0"]
@@ -20,6 +20,7 @@ term_size = ">= 1.0.1 and < 2.0.0"
 edit_distance = ">= 3.0.0 and < 4.0.0"
 global_value = ">= 1.0.0 and < 2.0.0"
 envoy = ">= 1.1.0 and < 2.0.0"
+tom = ">= 2.0.0 and < 3.0.0"
 
 [dev-dependencies]
 gleeunit = ">= 1.2.0 and < 2.0.0"

manifest.toml

@@ -12,6 +12,7 @@ packages = [
   { name = "gleam_json", version = "3.0.2", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleam_json", source = "hex", outer_checksum = "874FA3C3BB6E22DD2BB111966BD40B3759E9094E05257899A7C08F5DE77EC049" },
   { name = "gleam_regexp", version = "1.1.1", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleam_regexp", source = "hex", outer_checksum = "9C215C6CA84A5B35BB934A9B61A9A306EC743153BE2B0425A0D032E477B062A9" },
   { name = "gleam_stdlib", version = "0.64.0", build_tools = ["gleam"], requirements = [], otp_app = "gleam_stdlib", source = "hex", outer_checksum = "EA2E13FC4E65750643E078487D5EF360BEBCA5EBBBA12042FB589C19F53E35C0" },
+  { name = "gleam_time", version = "1.6.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleam_time", source = "hex", outer_checksum = "0DF3834D20193F0A38D0EB21F0A78D48F2EC276C285969131B86DF8D4EF9E762" },
   { name = "gleeunit", version = "1.6.1", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleeunit", source = "hex", outer_checksum = "FDC68A8C492B1E9B429249062CD9BAC9B5538C6FBF584817205D0998C42E1DAC" },
   { name = "glexer", version = "2.3.0", build_tools = ["gleam"], requirements = ["gleam_stdlib", "splitter"], otp_app = "glexer", source = "hex", outer_checksum = "40A1FB0919FA080AD6C5809B4C7DBA545841CAAC8168FACDFA0B0667C22475CC" },
   { name = "global_value", version = "1.0.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "global_value", source = "hex", outer_checksum = "23F74C91A7B819C43ABCCBF49DAD5BB8799D81F2A3736BA9A534BD47F309FF4F" },
@@ -20,6 +21,7 @@ packages = [
   { name = "simplifile", version = "2.3.0", build_tools = ["gleam"], requirements = ["filepath", "gleam_stdlib"], otp_app = "simplifile", source = "hex", outer_checksum = "0A868DAC6063D9E983477981839810DC2E553285AB4588B87E3E9C96A7FB4CB4" },
   { name = "splitter", version = "1.1.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "splitter", source = "hex", outer_checksum = "05564A381580395DCDEFF4F88A64B021E8DAFA6540AE99B4623962F52976AA9D" },
   { name = "term_size", version = "1.0.1", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "term_size", source = "hex", outer_checksum = "D00BD2BC8FB3EBB7E6AE076F3F1FF2AC9D5ED1805F004D0896C784D06C6645F1" },
+  { name = "tom", version = "2.0.0", build_tools = ["gleam"], requirements = ["gleam_stdlib", "gleam_time"], otp_app = "tom", source = "hex", outer_checksum = "74D0C5A3761F7A7D06994755D4D5AD854122EF8E9F9F76A3E7547606D8C77091" },
   { name = "trie_again", version = "1.1.4", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "trie_again", source = "hex", outer_checksum = "E3BD66B4E126EF567EA8C4944EAB216413392ADF6C16C36047AF79EE5EF13466" },
 ]
 
@@ -37,4 +39,5 @@ justin = { version = ">= 1.0.1 and < 2.0.0" }
 rank = { version = ">= 1.0.0 and < 2.0.0" }
 simplifile = { version = ">= 2.2.0 and < 3.0.0" }
 term_size = { version = ">= 1.0.1 and < 2.0.0" }
+tom = { version = ">= 2.0.0 and < 3.0.0" }
 trie_again = { version = ">= 1.1.2 and < 2.0.0" }

src/birdie.gleam

@@ -26,7 +26,7 @@ import rank
 import simplifile.{Eexist, Enoent}
 import term_size
 
-const birdie_version = "1.5.0"
+const birdie_version = "1.5.1"
 
 const hint_review_message = "run `gleam run -m birdie` to review the snapshots"
 
@@ -93,7 +93,7 @@ type Snapshot(status) {
 ///
 fn global_referenced_file() -> Result(String, Error) {
   use <- global_value.create_with_unique_name("birdie.referenced_file")
-  let referenced_file = referenced_file_path()
+  use referenced_file <- result.try(referenced_file_path())
   case simplifile.create_file(referenced_file) {
     Ok(_) -> Ok(referenced_file)
     Error(Eexist) ->
@@ -104,8 +104,12 @@ fn global_referenced_file() -> Result(String, Error) {
   }
 }
 
-fn referenced_file_path() -> String {
-  filepath.join(get_temp_directory(), "referenced.txt")
+fn referenced_file_path() -> Result(String, Error) {
+  use name <- result.try(
+    project.name()
+    |> result.map_error(CannotReadReferencedFile),
+  )
+  Ok(filepath.join(get_temp_directory(), name <> "_referenced.txt"))
 }
 
 fn get_temp_directory() -> String {
@@ -502,7 +506,7 @@ fn accept_snapshot(
   // running `gleam run -m birdie accept` (or `review`) followed by
   // `gleam run -m stale check` would result in all those accepted snapshots
   // being marked as stale!
-  let referenced_file = referenced_file_path()
+  use referenced_file <- result.try(referenced_file_path())
   use _ <- result.try(case simplifile.is_file(referenced_file) {
     Ok(_) -> Ok(Nil)
     Error(_) ->
@@ -1337,7 +1341,7 @@ fn reject_all() -> Result(Nil, Error) {
 
 fn stale_snapshots_file_names() -> Result(List(String), Error) {
   use snapshots_folder <- result.try(snapshot_folder())
-  let referenced_file = referenced_file_path()
+  use referenced_file <- result.try(referenced_file_path())
   case simplifile.read(referenced_file) {
     // If the file is not there we just give up. It means that we didn't run
     // `gleam test` beforehand.

src/birdie/internal/project.gleam

@@ -1,5 +1,7 @@
 import filepath
+import gleam/result
 import simplifile.{type FileError}
+import tom
 
 /// Returns the path to the project's root.
 ///
@@ -19,3 +21,15 @@ fn do_find_root(path: String) -> Result(String, FileError) {
     Error(reason) -> Error(reason)
   }
 }
+
+/// Returns the project's name as specified in its `gleam.toml`.
+///
+pub fn name() -> Result(String, FileError) {
+  use root <- result.try(find_root())
+  use file <- result.try(simplifile.read(filepath.join(root, "gleam.toml")))
+  let assert Ok(toml) = tom.parse(file)
+    as "running birdie in a gleam project with an invalid `gleam.toml` should be impossible"
+  let assert Ok(name) = tom.get_string(toml, ["name"])
+    as "`name` is a required field in `gleam.toml`, it should be impossible to run birdie on a project that doesn't have one"
+  Ok(name)
+}