Skip to content

Commit

Permalink
Fix env var syntax in README (#411)
Browse files Browse the repository at this point in the history
  • Loading branch information
joshuabremerdexcom committed Nov 12, 2022
1 parent 1f5b1ce commit 35adc66
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Expand Up @@ -117,7 +117,7 @@ Due dates can be configured in one of two ways, but both specify integers for `w
...and you supply the following environment variables:

```bash
UPDATE_TODO='1' TODO_DAYS_TO_WARN= '2' eslint . --format @lint-todo/eslint-formatter-todo
UPDATE_TODO='1' TODO_DAYS_TO_WARN='2' eslint . --format @lint-todo/eslint-formatter-todo
```

...the todos will be created with a `warn` date 2 days from the created date, and an `error` date 10 days from the created date.
Expand Down Expand Up @@ -171,13 +171,13 @@ Due dates can be configured on a per-rule basis with the `daysToDecayByRule` opt
Converting errors to todos with `warn` and `error` dates that transition the `todo` to `warn` after 10 days and `error` after 20 days:

```bash
UPDATE_TODO='1' TODO_DAYS_TO_WARN= '10' TODO_DAYS_TO_ERROR='20' eslint . --format @lint-todo/eslint-formatter-todo
UPDATE_TODO='1' TODO_DAYS_TO_WARN='10' TODO_DAYS_TO_ERROR='20' eslint . --format @lint-todo/eslint-formatter-todo
```

Converting errors to todos with `warn` and `error` dates that transition the `todo` `error` after 20 days, but doesn't include a `warn` date:

```bash
UPDATE_TODO='1' TODO_DAYS_TO_WARN= '' TODO_DAYS_TO_ERROR='20' eslint . --format @lint-todo/eslint-formatter-todo
UPDATE_TODO='1' TODO_DAYS_TO_WARN='' TODO_DAYS_TO_ERROR='20' eslint . --format @lint-todo/eslint-formatter-todo
```

### Additional options for formatting output
Expand Down

0 comments on commit 35adc66

Please sign in to comment.