Close #9: adding a threshold parameter

.eslintignore

@@ -1,3 +1,4 @@
 dist/
 lib/
-node_modules/
+node_modules/
+jest.config.js

.eslintrc.json

@@ -1,6 +1,6 @@
 {
     "plugins": ["jest", "@typescript-eslint"],
-    "extends": ["plugin:github/es6"],
+    "extends": ["plugin:github/typescript"],
     "parser": "@typescript-eslint/parser",
     "parserOptions": {
       "ecmaVersion": 9,
@@ -16,13 +16,38 @@
       "@typescript-eslint/no-require-imports": "error",
       "@typescript-eslint/array-type": "error",
       "@typescript-eslint/await-thenable": "error",
-      "@typescript-eslint/ban-ts-ignore": "error",
+      "@typescript-eslint/ban-ts-comment": [
+        "error",
+        {
+          "ts-expect-error": "allow-with-description",
+          "ts-ignore": true,
+          "ts-nocheck": true,
+          "ts-check": false,
+          "minimumDescriptionLength": 5
+        }
+      ],
       "camelcase": "off",
       "@typescript-eslint/camelcase": "off",
-      "@typescript-eslint/class-name-casing": "error",
+      "@typescript-eslint/consistent-type-assertions": "error",
       "@typescript-eslint/explicit-function-return-type": ["error", {"allowExpressions": true}],
       "@typescript-eslint/func-call-spacing": ["error", "never"],
-      "@typescript-eslint/generic-type-naming": ["error", "^[A-Z][A-Za-z]*$"],
+      "@typescript-eslint/naming-convention": [
+        "error",
+        { 
+          "selector": "variable", 
+          "format": ["camelCase", "UPPER_CASE"]
+        },
+//        {
+//          "selector": "variable",
+//          "modifiers": ["const"],
+//          "format": ["UPPER_CASE"]
+//        },
+        {
+          "selector": "typeParameter",
+          "format": ["PascalCase"],
+          "prefix": ["T"]
+        }
+      ],
       "@typescript-eslint/no-array-constructor": "error",
       "@typescript-eslint/no-empty-interface": "error",
       "@typescript-eslint/no-explicit-any": "error",
@@ -32,27 +57,29 @@
       "@typescript-eslint/no-misused-new": "error",
       "@typescript-eslint/no-namespace": "error",
       "@typescript-eslint/no-non-null-assertion": "warn",
-      "@typescript-eslint/no-object-literal-type-assertion": "error",
       "@typescript-eslint/no-unnecessary-qualifier": "error",
       "@typescript-eslint/no-unnecessary-type-assertion": "error",
       "@typescript-eslint/no-useless-constructor": "error",
       "@typescript-eslint/no-var-requires": "error",
       "@typescript-eslint/prefer-for-of": "warn",
       "@typescript-eslint/prefer-function-type": "warn",
       "@typescript-eslint/prefer-includes": "error",
-      "@typescript-eslint/prefer-interface": "error",
       "@typescript-eslint/prefer-string-starts-ends-with": "error",
       "@typescript-eslint/promise-function-async": "error",
       "@typescript-eslint/require-array-sort-compare": "error",
       "@typescript-eslint/restrict-plus-operands": "error",
       "semi": "off",
       "@typescript-eslint/semi": ["error", "never"],
       "@typescript-eslint/type-annotation-spacing": "error",
-      "@typescript-eslint/unbound-method": "error"
+      "@typescript-eslint/unbound-method": "error",
+      "i18n-text/no-en": "off",
+      "sort-imports": "off",
+      "no-shadow": "off",
+      "@typescript-eslint/no-shadow": ["error"]
     },
     "env": {
       "node": true,
       "es6": true,
       "jest/globals": true
     }
-  }
+  }

.gitattributes

@@ -0,0 +1 @@
+dist/** -diff linguist-generated=true

.github/dependabot.yml

@@ -0,0 +1,9 @@
+version: 2
+updates:
+  # Enable version updates for npm
+  - package-ecosystem: 'npm'
+    # Look for `package.json` and `lock` files in the `root` directory
+    directory: '/'
+    # Check the npm registry for updates every day (weekdays)
+    schedule:
+      interval: 'daily'

.github/workflows/test.yml

@@ -10,9 +10,10 @@ jobs:
   build: # make sure build/ci work properly
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v2
     - run: |
         npm install
+    - run: |
         npm run all
   test: # make sure the action works on a clean machine without building
     runs-on: ubuntu-latest

.gitignore

@@ -68,6 +68,9 @@ typings/
 # dotenv environment variables file
 .env
 .env.test
+.envrc
+.direnv
+.tool-versions
 
 # parcel-bundler cache (https://parceljs.org/)
 .cache

README.md

@@ -24,6 +24,9 @@ Optional. Title for the check run to create. Defaults to `SpotBugs Source Code A
 ### `token`
 Optional. GitHub API access token. Defaults to `${{ github.token }}`, which is set by `actions/checkout@v2` minimally.
 
+### `threshold`
+Optional. Configures the threshold when this job is marked as failed if to many finding. Defaults to `0`.
+
 ## Example usage
 
 ```yaml
@@ -103,7 +106,7 @@ $ npm install
 
 Build the typescript and package it for distribution
 ```bash
-$ npm run build && npm run pack
+$ npm run build && npm run package
 ```
 
 Run the tests :heavy_check_mark:  
@@ -117,3 +120,8 @@ $ npm test
 
 ...
 ```
+
+Before creating the PullRequest make sure you executed all
+```
+npm run all
+```

action.yml

@@ -20,6 +20,9 @@ inputs:
       Also when generating a new PAT, select the least scopes necessary.
       [Learn more about creating and using encrypted secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)
     default: ${{ github.token }}
+  threshold:
+    description: 'Configures the threshold when this job is marked as failed if to many finding'
+    default: 0
 runs:
   using: 'node12'
   main: 'dist/index.js'