Add and configure ESLint and update configuration for Prettier (#458)

* Add ESLint config and update Prettier

* Update test files

* Rebuild action

* Update docs

* Update licenses

* Update tsconfig

* Rebuild action

* Update tsconfig.json

* Fix console.time calls

* Rebuild action

* Rebuild action on Linux

.eslintignore

@@ -0,0 +1,6 @@
+# Ignore list
+/*
+
+# Do not ignore these folders:
+!__tests__/
+!src/

.eslintrc.js

@@ -0,0 +1,49 @@
+module.exports = {
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:eslint-plugin-jest/recommended',
+    'eslint-config-prettier'
+  ],
+  parser: '@typescript-eslint/parser',
+  plugins: ['@typescript-eslint', 'eslint-plugin-jest'],
+  rules: {
+    '@typescript-eslint/no-require-imports': 'error',
+    '@typescript-eslint/no-non-null-assertion': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+    '@typescript-eslint/no-empty-function': 'off',
+    '@typescript-eslint/ban-ts-comment': [
+      'error',
+      {
+        'ts-ignore': 'allow-with-description'
+      }
+    ],
+    'no-console': 'error',
+    'yoda': 'error',
+    'prefer-const': [
+      'error',
+      {
+        destructuring: 'all'
+      }
+    ],
+    'no-control-regex': 'off',
+    'no-constant-condition': ['error', {checkLoops: false}]
+  },
+  overrides: [
+    {
+      files: ['**/*{test,spec}.ts'],
+      rules: {
+        '@typescript-eslint/no-unused-vars': 'off',
+        'jest/no-standalone-expect': 'off',
+        'jest/no-conditional-expect': 'off',
+        'no-console': 'off',
+
+      }
+    }
+  ],
+  env: {
+    node: true,
+    es6: true,
+    'jest/globals': true
+  }
+};

.gitattributes

@@ -1,3 +1,4 @@
+* text=auto eol=lf
 dist/index.js    -diff -merge
 dist/index.js    linguist-generated=true
 .licenses/** -diff linguist-generated=true

.github/ISSUE_TEMPLATE/config.yml

@@ -1 +1 @@
-blank_issues_enabled: false
+blank_issues_enabled: false

.github/workflows/basic-validation.yml

@@ -14,4 +14,4 @@ on:
 jobs:
   call-basic-validation:
     name: Basic validation
-    uses: actions/reusable-workflows/.github/workflows/basic-validation.yml@main
+    uses: actions/reusable-workflows/.github/workflows/basic-validation.yml@main

.github/workflows/codeql-analysis.yml

@@ -2,13 +2,13 @@ name: CodeQL analysis
 
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
-    branches: [ main ]
+    branches: [main]
   schedule:
     - cron: '0 3 * * 0'
 
 jobs:
   call-codeQL-analysis:
-    name: CodeQL analysis 
-    uses: actions/reusable-workflows/.github/workflows/codeql-analysis.yml@main
+    name: CodeQL analysis
+    uses: actions/reusable-workflows/.github/workflows/codeql-analysis.yml@main

.github/workflows/e2e-cache.yml

@@ -151,7 +151,6 @@ jobs:
             exit 1
           fi
 
-      
       - name: Check files to cache on ubuntu-latest
         if: matrix.os == 'ubuntu-latest'
         run: |

.github/workflows/e2e-publishing.yml

@@ -86,7 +86,7 @@ jobs:
           if ($content -notlike '*maven*') {
             throw "settings.xml file is not overwritten"
           }
-  
+
   test-publishing-skip-overwrite:
     name: settings.xml is not overwritten if flag is false
     runs-on: ${{ matrix.os }}
@@ -150,4 +150,4 @@ jobs:
           $path = Join-Path $env:RUNNER_TEMP "settings.xml"
           if (-not (Test-Path $path)) {
             throw "settings.xml file is not found in expected location"
-          }
+          }

.github/workflows/e2e-versions.yml

@@ -11,7 +11,7 @@ on:
     paths-ignore:
       - '**.md'
   schedule:
-    - cron:  '0 */12 * * *'
+    - cron: '0 */12 * * *'
   workflow_dispatch:
 jobs:
   setup-java-major-versions:
@@ -21,21 +21,29 @@ jobs:
       fail-fast: false
       matrix:
         os: [macos-latest, windows-latest, ubuntu-latest]
-        distribution: ['temurin', 'adopt', 'adopt-openj9', 'zulu', 'liberica', 'microsoft', 'corretto' ] # internally 'adopt-hotspot' is the same as 'adopt'
+        distribution: [
+            'temurin',
+            'adopt',
+            'adopt-openj9',
+            'zulu',
+            'liberica',
+            'microsoft',
+            'corretto'
+          ] # internally 'adopt-hotspot' is the same as 'adopt'
         version: ['8', '11', '16']
         exclude:
-        - distribution: microsoft
-          version: 8
+          - distribution: microsoft
+            version: 8
         include:
-        - distribution: oracle
-          os: macos-latest
-          version: 17
-        - distribution: oracle
-          os: windows-latest
-          version: 19
-        - distribution: oracle
-          os: ubuntu-latest
-          version: 19
+          - distribution: oracle
+            os: macos-latest
+            version: 17
+          - distribution: oracle
+            os: windows-latest
+            version: 19
+          - distribution: oracle
+            os: ubuntu-latest
+            version: 19
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -59,13 +67,13 @@ jobs:
         os: [macos-latest, windows-latest, ubuntu-latest]
         distribution: ['temurin', 'zulu', 'liberica']
         version:
-        - '11.0'
-        - '8.0.302'
-        - '16.0.2+7'
+          - '11.0'
+          - '8.0.302'
+          - '16.0.2+7'
         include:
-        - distribution: oracle
-          os: ubuntu-latest
-          version: '19.0.1'
+          - distribution: oracle
+            os: ubuntu-latest
+            version: '19.0.1'
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -262,7 +270,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [macos-latest, windows-latest, ubuntu-latest]
-        distribution: ['temurin', 'microsoft', 'corretto' ]
+        distribution: ['temurin', 'microsoft', 'corretto']
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -287,7 +295,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [macos-latest, windows-latest, ubuntu-latest]
-        distribution: ['temurin', 'zulu', 'liberica', 'microsoft', 'corretto' ]
+        distribution: ['temurin', 'zulu', 'liberica', 'microsoft', 'corretto']
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -311,7 +319,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [macos-latest, windows-latest, ubuntu-latest]
-        distribution: [ 'adopt', 'adopt-openj9', 'zulu' ]
+        distribution: ['adopt', 'adopt-openj9', 'zulu']
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -335,7 +343,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [macos-latest, windows-latest, ubuntu-latest]
-        distribution: ['adopt', 'zulu', 'liberica'  ]
+        distribution: ['adopt', 'zulu', 'liberica']
     steps:
       - name: Checkout
         uses: actions/checkout@v3

.github/workflows/release-new-action-version.yml

@@ -21,9 +21,9 @@ jobs:
       name: releaseNewActionVersion
     runs-on: ubuntu-latest
     steps:
-    - name: Update the ${{ env.TAG_NAME }} tag
-      id: update-major-tag
-      uses: actions/publish-action@v0.2.2
-      with:
-        source-tag: ${{ env.TAG_NAME }}
-        slack-webhook: ${{ secrets.SLACK_WEBHOOK }}
+      - name: Update the ${{ env.TAG_NAME }} tag
+        id: update-major-tag
+        uses: actions/publish-action@v0.2.2
+        with:
+          source-tag: ${{ env.TAG_NAME }}
+          slack-webhook: ${{ secrets.SLACK_WEBHOOK }}

.prettierignore

@@ -0,0 +1,7 @@
+# Ignore list
+/*
+
+# Do not ignore these folders:
+!__tests__/
+!.github/
+!src/

.prettierrc.js

@@ -0,0 +1,10 @@
+module.exports = {
+  printWidth: 80,
+  tabWidth: 2,
+  useTabs: false,
+  semi: true,
+  singleQuote: true,
+  trailingComma: 'none',
+  bracketSpacing: false,
+  arrowParens: 'avoid'
+};