md-todo 0.1.1

Work with todos in markdown files.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

use anyhow::Result;
use error::MDTodoError;
use std::path::Path;
use todo::Todo;

pub mod error;
mod md_reader;
mod md_writer;
pub mod todo;

/// Gets a Vector of all todos that can be found in markdown-files in directorys
/// beneath the given Path.
pub fn get_todos_from_path(dir: &dyn AsRef<Path>) -> Result<Vec<Todo>> {
    if !dir.as_ref().is_dir() {
        return Err(anyhow::Error::new(MDTodoError::NotADir));
    }

    md_reader::get_todos_from_dir(dir.as_ref())
}

/// Toggles the done state of the todo in the physical file.
///
/// This is done via finding the line of the todo and replacing `[ ]` with `[x]` or the other way.
/// Before the change is done, its checked if the file changed since the last load of todos.
/// If yes an error is returned.
pub fn toggle_todo(todo: &mut Todo) -> Result<()> {
    md_writer::toggle_todo(todo)
}

#[cfg(test)]
mod tests {

    use super::*;

    #[test]
    #[should_panic]
    fn test_invalid_path() {
        get_todos_from_path(&"thisPath/ShouldNotExist32/2/013".to_string()).unwrap();
    }
}