Expand description
Devlog is a command-line tool for tracking your day-to-day software development work.
Devlog entries are stored as numbered files in a directory called a repository. Each entry may contain tasks, which each are assigned a status.
This library provides a programmatic interface to the functionality of the devlog tool.
Re-exports§
pub use config::Config;
pub use error::Error;
pub use file::LogFile;
pub use path::LogPath;
pub use repository::LogRepository;
pub use task::Task;
pub use task::TaskStatus;
Modules§
- config
- Load configuration values from environment variables.
- editor
- Open a file using a text editor program (e.g. vim or nano)
- error
- Error type returned by the devlog library.
- file
- Load and parse a devlog entry file.
- hook
- A hook is an executable program called while executing a devlog command.
It allows users to customize devlog for their workflows.
Hooks are located in the
hooks
subdirectory of the devlog repository. - path
- Path to a devlog entry file.
- repository
- A devlog repository is a directory containing devlog entry files.
- rollover
- Rollover is an operation that copies incomplete tasks from the latest devlog entry file to a new devlog entry file.
- status
- Report tasks from the most recent devlog entry file, grouped by task status type.
- task
- A task is something the user wants or needs to do.