Version a Cargo.lock file

[theCapypara]

Currently MathCAT does not version a Cargo.lock file, it's on the gitignore. Could you consider versioning a Lockfile?

I'm currently packaging MathCAT for NixOS as part of the upcoming GNOME 51 update, since Orca, GNOME's screen reader uses MathCAT by default.

We need a lockfile to be able to package MathCAT. If you really don't want to we could vendor it ourselves but it would be really inconvenient for us for a number of reasons.

[moritz-gross]

I think this really makes sense. Don't know how I skimmed over that so far...
Doubly embarrassing, as we track uv.lock for the Python stuff.

omw to fix this, thx

[moritz-gross]

are there any things to consider apart from committing the file? Like any flags to set, etc?

[theCapypara]

No, just adding the Cargo.lock is enough for us in that regard. Just tested your PR, builds fine! Thanks!

I just noticed Orca actually vendors MathCAT itself and provides its own Cargo.lock we can use. While I'll use that for Orca, I'll probably still package MathCAT for NixOS as a standalone package, because why not :).

The only other somewhat annoying thing for that is the way that the path to the rules directory is currently somewhat hardcoded and the MathCATRulesDir env variable only being read when a code change is made.

For various reasons we need to provide a custom path to MathCAT.

This requires us to do these patches to make it work:

{
  postPatch = ''
    substituteInPlace src/main.rs \
      --replace-fail 'set_rules_dir(get_rules_dir())' 'set_rules_dir("".to_string())'
    substituteInPlace tests/common/mod.rs \
      --replace-fail 'set_rules_dir(abs_rules_dir_path())' 'set_rules_dir("".to_string())'
  '';

  preCheck = ''
    export MathCATRulesDir="$src/Rules"
  '';

  postInstall = ''
    install -dm755 "$out/rules"
    cp -a ./Rules "$out/rules"
    wrapProgram $out/bin/mathcat --set MathCATRulesDir "$out/rules"
  '';
}

• The "postPatch" section here replaces set_rules_dir(get_rules_dir()) with set_rules_dir("".to_string()) (and does the same for the tests)
• In "preCheck" we make sure the tests see the rules
• In "postInstall" we install the rules and make sure the final mathcat binary actually sees them

Ideally for us, the "postPatch" section would not be needed.