chore(path): make path reading api more rusty

vercel / turborepo

Build system optimized for JavaScript and TypeScript, written in Rust

https://turbo.build/repo/docs

MIT License

26.33k stars 1.82k forks source link

chore(path): make path reading api more rusty #9103

Closed chris-olszewski closed 2 months ago

chris-olszewski commented 2 months ago

Description

Remove read_existing_to_string_or in favor of read_existing_to_string to consolidate on the more Rust-y API for reading a path to a file.

read_existing_to_string_or is an awkward API due:

It conflates two outcomes: The file not existing and the file existing with the contents of the default
The default is provided as Result<impl Into<String>, io::Error>. impl Into<String> was chosen so unnecessary work could be avoided. This is limiting compared to FnOnce() -> String.
It prevents us from using the battle tested Option API

The benefits of not conflating the two outcomes is best displayed when trying to read a config file. Instead of defaulting having a default of {} and then parsing it as JSON we can skip the parse and just use ConfigurationOptions::default()

Testing Instructions

Existing unit tests + 👀

vercel[bot] commented 2 months ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
examples-nonmonorepo	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Sep 3, 2024 7:18pm

8 Skipped Deployments