Skip to content

Rename repository to new scope #286

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 6, 2021
Merged

Rename repository to new scope #286

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# @scalvert/eslint-formatter-todo
# @lint-todo/eslint-formatter-todo

![CI Build](https://github.com/scalvert/eslint-formatter-todo/workflows/CI%20Build/badge.svg)
[![npm version](https://badge.fury.io/js/%40scalvert%2Feslint-formatter-todo.svg)](https://badge.fury.io/js/%40scalvert%2Feslint-formatter-todo)
[![License](https://img.shields.io/npm/l/@scalvert/eslint-formatter-todo.svg)](https://github.com/@scalvert/eslint-formatter-todo/blob/master/package.json)
![CI Build](https://github.com/lint-todo/eslint-formatter-todo/workflows/CI%20Build/badge.svg)
[![npm version](https://badge.fury.io/js/%40lint-todo%2Feslint-formatter-todo.svg)](https://badge.fury.io/js/%40lint-todo%2Feslint-formatter-todo)
[![License](https://img.shields.io/npm/l/@lint-todo/eslint-formatter-todo.svg)](https://github.com/@lint-todo/eslint-formatter-todo/blob/master/package.json)
![Dependabot](https://badgen.net/badge/icon/dependabot?icon=dependabot&label)
![Volta Managed](https://img.shields.io/static/v1?label=volta&message=managed&color=yellow&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QAeQC6AMEpK7AhAAAACXBIWXMAAAsSAAALEgHS3X78AAAAB3RJTUUH5AMGFS07qAYEaAAAABl0RVh0Q29tbWVudABDcmVhdGVkIHdpdGggR0lNUFeBDhcAAAFmSURBVDjLY2CgB/g/j0H5/2wGW2xyTAQ1r2DQYOBgm8nwh+EY6TYvZtD7f9rn5e81fAGka17GYPL/esObP+dyj5Cs+edqZsv/V8o//H+z7P+XHarW+NSyoAv8WsFszyKTtoVBM5Tn7/Xys+zf7v76vYrJlPEvAwPjH0YGxp//3jGl/L8LU8+IrPnPUkY3ZomoDQwOpZwMv14zMHy8yMDwh4mB4Q8jA8OTgwz/L299wMDyx4Mp9f9NDAP+bWVwY3jGsJpB3JaDQVCEgYHlLwPDfwYWRqVQJgZmHoZ/+3PPfWP+68Mb/Pw5sqUoLni9ipuRnekrAwMjA8Ofb6K8/PKBF5nU7RX+Hize8Y2DOZTP7+kXogPy1zrH+f/vT/j/Z5nUvGcr5VhJioUf88UC/59L+/97gUgDyVH4YzqXxL8dOs/+zuFLJivd/53HseLPPHZPsjT/nsHi93cqozHZue7rLDYhUvUAADjCgneouzo/AAAAAElFTkSuQmCC&link=https://volta.sh)
![TypeScript](https://badgen.net/badge/icon/typescript?icon=typescript&label)
Expand All @@ -29,7 +29,7 @@ Todos are stored in a `.lint-todo` directory that should be checked in with othe
To convert errors to todos, you can use the `UPDATE_TODO` environment variable. This will convert all active errors to todos, hiding them from the linting output.

```bash
UPDATE_TODO=1 eslint --format @scalvert/eslint-formatter-todo
UPDATE_TODO=1 eslint --format @lint-todo/eslint-formatter-todo
```

If you want to see todos as part of `eslint`'s output, you can include them
Expand All @@ -39,14 +39,14 @@ If you want to see todos as part of `eslint`'s output, you can include them
If an error is fixed manually, `eslint` will automatically remove the todo when run again.

```bash
eslint . --format @scalvert/eslint-formatter-todo
eslint . --format @lint-todo/eslint-formatter-todo
```

If you want to opt out of this behavior, you can run with the `NO_CLEAN_TODO` env var set.

```bash
# Will not remove the todo automatically
NO_CLEAN_TODO='1' eslint . --format @scalvert/eslint-formatter-todo
NO_CLEAN_TODO='1' eslint . --format @lint-todo/eslint-formatter-todo
```

### Configuring Due Dates
Expand Down Expand Up @@ -88,7 +88,7 @@ Due dates can be configured in one of two ways, but both specify integers for `w
1. Via environment variables

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

In order of precedence, environment variables override package.json configuration values.
Expand All @@ -111,7 +111,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 @scalvert/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 @@ -165,11 +165,11 @@ 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 @scalvert/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 @scalvert/eslint-formatter-todo
UPDATE_TODO='1' TODO_DAYS_TO_WARN= '' TODO_DAYS_TO_ERROR='20' eslint . --format @lint-todo/eslint-formatter-todo
```
Loading