Skip to content
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.

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

Adding scope to package to avoid naming collision #10

Merged
merged 1 commit into from
Nov 30, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# eslint-formatter-todo
# @scalvert/eslint-formatter-todo

An ESLint formatter that can report errors as todos.

Expand All @@ -13,23 +13,23 @@ This formatter allows you to introduce new rules immediately without blocking co
When you introduce new linting rules, execute ESLint by setting `UPDATE_TODO=1` and passing this formatter:

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

This command will transform all reported `error`s to `todo`s and will generate files inside the `.lint-todo` directory to track them.

Executing ESLint without `UPDATE_TODO=1` will run `eslint` normally but will transform errors that are present in the `.lint-todo` directory to `todo` items, ignoring them as errors:

```bash
$ eslint --format eslint-formatter-todo
$ eslint --format @scalvert/eslint-formatter-todo

# no output, no errors
```

If you want `todo`s to appear in results, you must set `INCLUDE_TODO=1`:

```bash
$ INCLUDE_TODO=1 eslint --format eslint-formatter-todo
$ INCLUDE_TODO=1 eslint --format @scalvert/eslint-formatter-todo

# todo items will be visible
/path/to/file/fullOfProblems.js
Expand Down
19 changes: 16 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
{
"name": "eslint-formatter-todo",
"name": "@scalvert/eslint-formatter-todo",
"version": "0.1.0",
"description": "An ESLint formatter that can report errors as todos.",
"repository": "https://github.com/scalvert/eslint-formatter-todo.git",
"repository": {
"type": "git",
"url": "git+https://github.com/scalvert/eslint-formatter-todo.git"
},
"license": "MIT",
"author": "Renato Iwashima <renatoiwa@gmail.com>",
"contributors": [
Expand Down Expand Up @@ -75,5 +78,15 @@
"volta": {
"node": "12.18.4",
"yarn": "1.22.10"
}
},
"bugs": {
"url": "https://github.com/scalvert/eslint-formatter-todo/issues"
},
"homepage": "https://github.com/scalvert/eslint-formatter-todo#readme",
"directories": {
"lib": "lib"
},
"keywords": [
"eslint"
]
}