1
- # @scalvert /eslint-formatter-todo
1
+ # @lint-todo /eslint-formatter-todo
2
2
3
- ![ CI Build] ( https://github.com/scalvert /eslint-formatter-todo/workflows/CI%20Build/badge.svg )
4
- [ ![ npm version] ( https://badge.fury.io/js/%40scalvert %2Feslint-formatter-todo.svg )] ( https://badge.fury.io/js/%40scalvert %2Feslint-formatter-todo )
5
- [ ![ License] ( https://img.shields.io/npm/l/@scalvert /eslint-formatter-todo.svg )] ( https://github.com/@scalvert /eslint-formatter-todo/blob/master/package.json )
3
+ ![ CI Build] ( https://github.com/lint-todo /eslint-formatter-todo/workflows/CI%20Build/badge.svg )
4
+ [ ![ npm version] ( https://badge.fury.io/js/%40lint-todo %2Feslint-formatter-todo.svg )] ( https://badge.fury.io/js/%40lint-todo %2Feslint-formatter-todo )
5
+ [ ![ 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 )
6
6
![ Dependabot] ( https://badgen.net/badge/icon/dependabot?icon=dependabot&label )
7
7
![ 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 )
8
8
![ TypeScript] ( https://badgen.net/badge/icon/typescript?icon=typescript&label )
@@ -29,7 +29,7 @@ Todos are stored in a `.lint-todo` directory that should be checked in with othe
29
29
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.
30
30
31
31
``` bash
32
- UPDATE_TODO=1 eslint --format @scalvert /eslint-formatter-todo
32
+ UPDATE_TODO=1 eslint --format @lint-todo /eslint-formatter-todo
33
33
```
34
34
35
35
If you want to see todos as part of ` eslint ` 's output, you can include them
@@ -39,14 +39,14 @@ If you want to see todos as part of `eslint`'s output, you can include them
39
39
If an error is fixed manually, ` eslint ` will automatically remove the todo when run again.
40
40
41
41
``` bash
42
- eslint . --format @scalvert /eslint-formatter-todo
42
+ eslint . --format @lint-todo /eslint-formatter-todo
43
43
```
44
44
45
45
If you want to opt out of this behavior, you can run with the ` NO_CLEAN_TODO ` env var set.
46
46
47
47
``` bash
48
48
# Will not remove the todo automatically
49
- NO_CLEAN_TODO=' 1' eslint . --format @scalvert /eslint-formatter-todo
49
+ NO_CLEAN_TODO=' 1' eslint . --format @lint-todo /eslint-formatter-todo
50
50
```
51
51
52
52
### Configuring Due Dates
@@ -88,7 +88,7 @@ Due dates can be configured in one of two ways, but both specify integers for `w
88
88
1 . Via environment variables
89
89
90
90
``` bash
91
- UPDATE_TODO=' 1' TODO_DAYS_TO_WARN=" 5" TODO_DAYS_TO_ERROR=" 10" eslint . --format @scalvert /eslint-formatter-todo
91
+ UPDATE_TODO=' 1' TODO_DAYS_TO_WARN=" 5" TODO_DAYS_TO_ERROR=" 10" eslint . --format @lint-todo /eslint-formatter-todo
92
92
```
93
93
94
94
In order of precedence, environment variables override package.json configuration values.
@@ -111,7 +111,7 @@ Due dates can be configured in one of two ways, but both specify integers for `w
111
111
...and you supply the following environment variables:
112
112
113
113
``` bash
114
- UPDATE_TODO=' 1' TODO_DAYS_TO_WARN= ' 2' eslint . --format @scalvert /eslint-formatter-todo
114
+ UPDATE_TODO=' 1' TODO_DAYS_TO_WARN= ' 2' eslint . --format @lint-todo /eslint-formatter-todo
115
115
```
116
116
117
117
...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.
@@ -165,11 +165,11 @@ Due dates can be configured on a per-rule basis with the `daysToDecayByRule` opt
165
165
Converting errors to todos with ` warn ` and ` error ` dates that transition the ` todo ` to ` warn ` after 10 days and ` error ` after 20 days:
166
166
167
167
``` bash
168
- UPDATE_TODO=' 1' TODO_DAYS_TO_WARN= ' 10' TODO_DAYS_TO_ERROR=' 20' eslint . --format @scalvert /eslint-formatter-todo
168
+ UPDATE_TODO=' 1' TODO_DAYS_TO_WARN= ' 10' TODO_DAYS_TO_ERROR=' 20' eslint . --format @lint-todo /eslint-formatter-todo
169
169
```
170
170
171
171
Converting errors to todos with ` warn ` and ` error ` dates that transition the ` todo ` ` error ` after 20 days, but doesn't include a ` warn ` date:
172
172
173
173
``` bash
174
- UPDATE_TODO=' 1' TODO_DAYS_TO_WARN= ' ' TODO_DAYS_TO_ERROR=' 20' eslint . --format @scalvert /eslint-formatter-todo
174
+ UPDATE_TODO=' 1' TODO_DAYS_TO_WARN= ' ' TODO_DAYS_TO_ERROR=' 20' eslint . --format @lint-todo /eslint-formatter-todo
175
175
```
0 commit comments