Support file substitutions

[samypr100]

In order to support astral-sh/uv#15196

This adds initial support to rooster for file substitutions.

Replace old version with new version in README.md using the special substitution string rooster.previous.

[tool.rooster]
...
substitution_files = { "README.md"  = ["rooster.previous"] }

or

Replace FOO and BAR with the new version on all md files.

[tool.rooster]
...
substitution_files = { "**/*.md"  = ["FOO", "BAR"] }

[zanieb]

I might prefer something like

substitution-files = ["README.md", {file = "**/*.md", replace = "foo"}]

So we don't need to add the special rooster.previous string? wdyt?

[samypr100]

I might prefer something like

substitution-files = ["README.md", {file = "**/*.md", replace = "foo"}]

So we don't need to add the special rooster.previous string? wdyt?

We can also assume the behavior of "rooster.previous" if the substitution array is empty? Since right now this also works:

[tool.rooster]
...
substitution_files = { "**/*.md"  = ["rooster.previous", "FOO", "BAR"], "README.md"  = ["BAZ"] }

I didn't add single file support because I feel that's covered by version_files, or is your intent to supersede it by this?

[samypr100]

I do get rooster.previous may feel weird though 😅

[zanieb]

Oh I see — sorry I don't know my own APIs here. Yeah, I think I'd replace version_files? Or at least, I wouldn't have two settings that do such similar things. I think if we did a generic substitution I'd expect more like..

substitutions = [ {find = "rooster.previous", replace = "rooster.next", files = "**/*.md"} ]

I don't know if I really want that yet though, so maybe we should just add some functionality to version_files?

[samypr100]

I ended up going ahead and adding support to replacements to the existing version_files like you proposed originally.

This will work now:

version_files = [ 
    "README.md", # Existing functionality
    { target = "**/*.md" },  # Replaces all prev versions with new version on all matches
    { target = "**/*.md", replace = "FOO" } # Replaces all instances of FOO with new version on all matches
]

[samypr100]

Note, I chose target over file for the glob as it felt weird to name a glob pattern parameter file but I can switch to file if that's preferred.

[samypr100]

Sorry for the ping as you're very busy; thoughts here? 😄