README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# Todo Or Die

<!-- badges: start -->

[![CRAN status](https://www.r-pkg.org/badges/version/todoordie)](https://CRAN.R-project.org/package=todoordie) [![R-CMD-check](https://github.com/edavidaja/todoordie/workflows/R-CMD-check/badge.svg)](https://github.com/edavidaja/todoordie/actions)

<!-- badges: end -->

Write TODOs in Code That Ensure You Actually Do Them

## Installation

You can install the development version from [GitHub](https://github.com/) with:

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

## Usage

Use the functions directly:

```{r date, error=TRUE}
todoordie::after_date("2021-01-21", "fix after conf 2021")
```

```{r github, error=TRUE}
todoordie::issue_closed("tidyverse/dtplyr#154", "rewrite once dtplyr supports across()")
```

```{r cran, error=TRUE}
todoordie::cran_version("plumber", "1.0.0", "no 0.* in production")
```

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

``` r
#' 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](https://github.com/searls/todo_or_die)  
[Rust](https://github.com/davidpdrsn/todo-or-die)  
[Python](https://github.com/achedeuzot/py-todo-or-die)  
[Elixir](https://hex.pm/packages/credo_todo_or_die)  
[Typescript](https://github.com/ngnijland/typescript-todo-or-die-plugin)