From 0b1ea09969dfee4ebd79b26525a2cea0a2bf3ce3 Mon Sep 17 00:00:00 2001 From: Steve Calvert Date: Mon, 30 Nov 2020 15:49:56 -0800 Subject: [PATCH] Adding scope to package to avoid naming collision (#10) --- README.md | 8 ++++---- package.json | 19 ++++++++++++++++--- 2 files changed, 20 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 14b5850..44ab8a2 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# eslint-formatter-todo +# @scalvert/eslint-formatter-todo An ESLint formatter that can report errors as todos. @@ -13,7 +13,7 @@ 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. @@ -21,7 +21,7 @@ This command will transform all reported `error`s to `todo`s and will generate f 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 ``` @@ -29,7 +29,7 @@ $ eslint --format eslint-formatter-todo 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 diff --git a/package.json b/package.json index b8905c8..37110d4 100644 --- a/package.json +++ b/package.json @@ -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 ", "contributors": [ @@ -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" + ] }