Log results to platform specific location #3
Conversation
src/thok.rs
Outdated
| @@ -68,6 +71,33 @@ impl Thok { | |||
| } | |||
| } | |||
|
|
|||
| pub fn save_results(&self) -> io::Result<()> { | |||
| let log_path = dirs::data_dir().unwrap().join("thokr.log"); | |||
There was a problem hiding this comment.
Given the fact that we'd be exporting the data in a csv format already, I'd prefer we just name the file [filename].csv!
There was a problem hiding this comment.
Also I think I'd rather thokr be a folder and this file be nested inside, that way there's already a folder for potential more files down the road
There was a problem hiding this comment.
Just checking that there should be no issues with dirs and windows? I'm extremely unfamiliar with windows os lol. Do they have a XDG_DATA_HOME?
There was a problem hiding this comment.
Yeah, I agree with the folder idea. $XDG_DATA_HOME/thokr/log.csv?
Also yeah I think that dirs is good on windows (at least they say so haha)
There was a problem hiding this comment.
Pushed this change
| @@ -141,6 +171,8 @@ impl Thok { | |||
| self.wpm = 0.0; | |||
| } | |||
| self.accuracy = ((correct_chars.len() as f64 / self.input.len() as f64) * 100.0).round(); | |||
|
|
|||
| let _ = self.save_results(); | |||
There was a problem hiding this comment.
It's the least gross way to ignore an error. It could be replaced with .ok() or .drop().
I think it makes sense to ignore the error here, as failing to log results shouldn't crash the program. Maybe instead it should log to stderr or display on the results screen?
src/thok.rs
Outdated
| .open(log_path)?; | ||
|
|
||
| if needs_header { | ||
| writeln!(log_file, "# Date, WPM, Accuracy, Standard Deviation")?; |
There was a problem hiding this comment.
Not a big fan of # Date -- mostly just the # feels confusing. I'd want to add a few more headers here too, namely to track what parameters the test was run with. Was it 15 words? 100? Was it a 30 second test? 60? Stuff like that!
There was a problem hiding this comment.
I'm happy to add that for sure. I'm not the most familiar with the project, so what might be the best way to get the word count other than counting the ' ' chars in self.prompt?
Co-authored-by: colby thomas <coloradocolby@gmail.com>
|
It should now log with the wordcount and duration. I modified the Thok structure to include a test_duration, and renamed the existing |
|
Will cut a release in a bit, but merging for now! Thanks for the hard work @nickwanninger ! |
|
For sure! Happy to help! |
What: Logging historical data to $XDG_DATA_HOME/thokr.log
Why: So nerds like me can plot progress over time
How: Results are logged whenever results are calculated. It may be smart to add a configuration to disable this, but that could be another comit
Checklist: N/A