edavidaja / todoordie

Write TODOs in Code That Ensure You Actually Do Them

Todo Or Die

Write TODOs in Code That Ensure You Actually Do Them

Installation

You can install the development version from GitHub with:

# install.packages("devtools")
devtools::install_github("edavidaja/todoordie")

Usage

Use the functions directly:

todoordie::after_date("2021-01-21", "fix after conf 2021")
#> Error in todoordie::after_date("2021-01-21", "fix after conf 2021"): fix after conf 2021 was due on 2021-01-21

todoordie::issue_closed("tidyverse/dtplyr#154", "rewrite once dtplyr supports across()")
#> Error in todoordie::issue_closed("tidyverse/dtplyr#154", "rewrite once dtplyr supports across()"): rewrite once dtplyr supports across() has been resolved

todoordie::cran_version("plumber", "1.0.0", "no 0.* in production")
#> Error in todoordie::cran_version("plumber", "1.0.0", "no 0.* in production"): no 0.* in production has exceeded version 1.0.0

If you’d prefer for them to live in your function documentation, you can also use them as roxgyen tags:

#' sketchy function 
#'
#' @todoordie after_date 2012-12-21 if we're not all dead make this less sketchy
sketchy <- function() {}

expired todos should produce errors when you run devtools::document().

Prior art:

Ruby
Rust
Python
Elixir
Typescript