Is the format of `.lycheecache` stable?

lycheeverse / lychee

⚡ Fast, async, stream-based link checker written in Rust. Finds broken URLs and mail addresses inside Markdown, HTML, reStructuredText, websites and more!

https://lychee.cli.rs

Apache License 2.0

2.22k stars 134 forks source link

Is the format of `.lycheecache` stable? #1567

Closed wiktor-k closed 1 week ago

wiktor-k commented 1 week ago

Hi,

Thanks for your great project!

I'd like to use .lycheecache as an input to my blogging system (to show info such as "as of [date]" as used in academic world) and would like to know if the file format is stable.

Thanks for your time! :wave:

mre commented 1 week ago

Interesting use-case! I wouldn't want to make any stability guarantees, but I also don't see it changing in the foreseeable future. At the end, it's just a CSV file with comment support (lines with # at the start). If we add fields, then likely at the end, but I wouldn't even know what to add there.

In summary, it's probably safe to use.