https://github.com/edavidaja/todoordie

Write TODOs in Code That Ensure You Actually Do Them
https://github.com/edavidaja/todoordie

Last synced: about 1 month ago
JSON representation

Write TODOs in Code That Ensure You Actually Do Them

• Host: GitHub
• URL: https://github.com/edavidaja/todoordie
• Owner: edavidaja
• License: other
• Created: 2021-10-12T22:41:34.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2021-12-21T23:07:40.000Z (about 3 years ago)
• Last Synced: 2024-10-12T22:34:47.620Z (2 months ago)
• Language: R
• Homepage:
• Size: 44.9 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.Rmd
  • License: LICENSE

Awesome Lists containing this project

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```

# Todo Or Die

[![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)

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)