Add an explanation of GH actions and an image of a run to readme expl…

…aining why GH action exists
sematext · May 9, 2024 · 625e7aa · 625e7aa
1 parent 0314b56
commit 625e7aa
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -56,6 +56,8 @@ source.js
 ✖ 3 problems (3 errors, 0 warnings)
   3 errors and 0 warnings potentially fixable with the `--fix` option.
 ```
+The purpose of the GH action is to run eslint in order to show the plugin in action:
+![GH action lint run](gh-action.png)
 
 5. Fix
 

diff --git a/gh-action.png b/gh-action.png
diff --git a/package.json b/package.json
@@ -4,8 +4,8 @@
   "description": "ESLint plugin which enforces explicit .js extensions in local imports while leveraging import resolvers.",
   "main": "index.js",
   "scripts": {
-    "lint": "npm i && cd test && npm link .. && npm i && ./node_modules/.bin/eslint .",
-    "fix": "npm i && cd test && npm link .. && npm i && ./node_modules/.bin/eslint . --fix"
+    "lint": "npm i && cd test && npm link .. && npm i && ./node_modules/.bin/eslint . || true",
+    "fix": "npm i && cd test && npm link .. && npm i && ./node_modules/.bin/eslint . --fix || true"
   },
   "repository": {
     "type": "git",