From ccf35f6068a2201e08664d1f692ad7ac901ace75 Mon Sep 17 00:00:00 2001 From: ahilton-godaddy <88430575+ahilton-godaddy@users.noreply.github.com> Date: Fri, 24 Sep 2021 15:13:24 +0100 Subject: [PATCH 1/3] update readme with how to disable autofix it took me a while to figure out how to disable autofix, and on ci, auto-fixing is not always desirable, as opposed to just erroring --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 87454fcb..0afa83bb 100644 --- a/README.md +++ b/README.md @@ -124,6 +124,20 @@ This section is a place for additional best practices that may be useful but are } ``` +## How do I disable auto fix + +You may wish to disable autofix, so you can run eslint in ci, and error +if it catches anything unlinted + +``` js +{ + "scripts": { + "eslint:ci": "eslint-godaddy --fix=false --max-warnings=0 lib/ test/", + } +} +``` + + ## How do I contribute? Fork this repository and submit a pull request. From 437b7ddfd50240722672f1ddf27d7904e27f28b8 Mon Sep 17 00:00:00 2001 From: ahilton-godaddy <88430575+ahilton-godaddy@users.noreply.github.com> Date: Fri, 24 Sep 2021 15:22:51 +0100 Subject: [PATCH 2/3] Update README.md Co-authored-by: Jacob Page <85361835+jpage-godaddy@users.noreply.github.com> --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0afa83bb..f0f9edef 100644 --- a/README.md +++ b/README.md @@ -126,8 +126,8 @@ This section is a place for additional best practices that may be useful but are ## How do I disable auto fix -You may wish to disable autofix, so you can run eslint in ci, and error -if it catches anything unlinted +You may wish to disable autofix so when you run `eslint` in ci it will error +if it catches anything unlinted. ``` js { From 3b4d3ca3f15c4a25c41cb99169558eb83faeb420 Mon Sep 17 00:00:00 2001 From: ahilton-godaddy <88430575+ahilton-godaddy@users.noreply.github.com> Date: Wed, 29 Sep 2021 10:38:06 +0100 Subject: [PATCH 3/3] Update README.md Co-authored-by: msluther --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f0f9edef..9342adc2 100644 --- a/README.md +++ b/README.md @@ -126,7 +126,7 @@ This section is a place for additional best practices that may be useful but are ## How do I disable auto fix -You may wish to disable autofix so when you run `eslint` in ci it will error +You may wish to disable auto fix so when you run `eslint` in ci it will error if it catches anything unlinted. ``` js