feat(fossil_metrics): add fossil_metrics module #4874
Conversation
src/modules/fossil_metrics.rs
Outdated
| log::warn!("Error in module `fossil_metrics`:\nLast line of numstat diff missing."); | ||
| return None; |
There was a problem hiding this comment.
Error in module `fossil_metrics`:\n is a bit redundant, and the duplicate log message detector may have trouble with this. I would prefer having try_parse return a Result<Self, &str> instead. Please also add tests for some of the different error conditions.
There was a problem hiding this comment.
I didn't mean to say that you should be removing all error handling in the module, I think that is nice to have. The Error in module `fossil_metrics`:\n-prefix was redundant, because the log message will already contain WARN and the module name.
There was a problem hiding this comment.
Okay, I see. I tried to move closer to the implementation of git_metrics where an unexpected output leads to 0 changes reported, e.g. if the format of the command output changes in an update or the git binary is not actually Git. The different error conditions explicitly checked for previously should not be able to occur if a Fossil version later than v2.3 (2017-07-21) is installed (which introduced the --numstat option). I can revert the latest commit and fix the log messages if preferable, but I'm uncertain about what other input to test when it cannot be produced by Fossil.
|
A possible error condition is if the user has installed a version of Fossil >=v2.3 (2017-07-21), but older than v2.14 (2021-01-20). The final line with the total changes was introduced in v2.14, such that this module would then incorrectly report only the changes in whatever file is listed last. My initial thinking was that checking the installed version of Fossil on each run would be too much overhead in Starship (especially since the number of users of these versions is vanishingly small, for reference of the supported Debian repos only Buster ships one of these versions as far as I can see, and those users likely won't install a new version of Starship either), though the format of the last line could be checked before possibly looping over the earlier output and doing the summation manually. |
|
There were an error in the Fossil check-out detection logic where subdirectories were not detected. This also affects the |
|
Please create another PR and try to have it share its code with the hg upwards search. You can put it into one of the |
Please document this in the module docs. |
|
Thank you for your contribution @VegardSkui and thanks for reviewing @davidkna. |
Description
Add a module to show the count of currently added and deleted lines in a Fossil check-out in the current directory. The module is analogous to the
git_metricsmodule.Motivation and Context
This is part of adding initial Fossil support to Starship. This lets users of Fossil repositories have some of the same functionality available in their check-outs as they already enjoy in their Git repositories. Initial support for Fossil was included in #4806, which added the
fossil_branchmodule.Contributes to the closing of #4036.
Screenshots (if appropriate):
NA
How Has This Been Tested?
Manual tests were ran both with and without Fossil installed and in multiple check-outs. I have also tested the module on FreeBSD.
Checklist: