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

* Add ESLint, update Prettier * Update docs * Update tests * Update licenses * Fix review points
actions · Mar 9, 2023 · ec365b4 · ec365b4
1 parent 7b9ef6f
commit ec365b4
Show file tree

Hide file tree

Showing 36 changed files with 3,781 additions and 553 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1,6 @@
+# Ignore list
+/*
+
+# Do not ignore these folders:
+!__tests__/
+!src/
diff --git a/.eslintrc.js b/.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
+  }
+};
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -1 +1 @@
-blank_issues_enabled: false
+blank_issues_enabled: false
diff --git a/.github/workflows/basic-validation.yml b/.github/workflows/basic-validation.yml
@@ -12,4 +12,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
diff --git a/.github/workflows/check-dist.yml b/.github/workflows/check-dist.yml
@@ -14,4 +14,4 @@ on:
 jobs:
   call-check-dist:
     name: Check dist/
-    uses: actions/reusable-workflows/.github/workflows/check-dist.yml@main
+    uses: actions/reusable-workflows/.github/workflows/check-dist.yml@main
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -2,12 +2,12 @@ name: CodeQL analysis
 
 on:
   push:
-    branches: [ 'main' ]
+    branches: ['main']
   pull_request:
   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
diff --git a/.github/workflows/e2e-cache.yml b/.github/workflows/e2e-cache.yml
@@ -128,4 +128,4 @@ jobs:
             pipenv install --keep-outdated --python pypy
           } else {
             pipenv install --keep-outdated --python ${{ matrix.python-version }}
-          }
+          }
diff --git a/.github/workflows/e2e-tests.yml b/.github/workflows/e2e-tests.yml
@@ -9,7 +9,7 @@ on:
   pull_request:
     paths-ignore:
       - '**.md'
-      
+
 jobs:
   test-setup-python:
     name: Test setup-python
@@ -18,71 +18,71 @@ jobs:
       matrix:
         operating-system: [ubuntu-20.04, windows-latest]
     steps:
-    - name: Checkout
-      uses: actions/checkout@v3
+      - name: Checkout
+        uses: actions/checkout@v3
 
-    - name: Run with setup-python 2.7
-      uses: ./
-      with:
-        python-version: 2.7
-    - name: Verify 2.7
-      run: python __tests__/verify-python.py 2.7
+      - name: Run with setup-python 2.7
+        uses: ./
+        with:
+          python-version: 2.7
+      - name: Verify 2.7
+        run: python __tests__/verify-python.py 2.7
 
-    - name: Run with setup-python 3.5
-      uses: ./
-      with:
-        python-version: 3.5
-    - name: Verify 3.5
-      run: python __tests__/verify-python.py 3.5
+      - name: Run with setup-python 3.5
+        uses: ./
+        with:
+          python-version: 3.5
+      - name: Verify 3.5
+        run: python __tests__/verify-python.py 3.5
 
-    - name: Run with setup-python 3.6
-      uses: ./
-      with:
-        python-version: 3.6
-    - name: Verify 3.6
-      run: python __tests__/verify-python.py 3.6
+      - name: Run with setup-python 3.6
+        uses: ./
+        with:
+          python-version: 3.6
+      - name: Verify 3.6
+        run: python __tests__/verify-python.py 3.6
 
-    - name: Run with setup-python 3.7
-      uses: ./
-      with:
-        python-version: 3.7
-    - name: Verify 3.7
-      run: python __tests__/verify-python.py 3.7
+      - name: Run with setup-python 3.7
+        uses: ./
+        with:
+          python-version: 3.7
+      - name: Verify 3.7
+        run: python __tests__/verify-python.py 3.7
 
-    - name: Run with setup-python 3.8
-      uses: ./
-      with:
-        python-version: 3.8
-    - name: Verify 3.8
-      run: python __tests__/verify-python.py 3.8
+      - name: Run with setup-python 3.8
+        uses: ./
+        with:
+          python-version: 3.8
+      - name: Verify 3.8
+        run: python __tests__/verify-python.py 3.8
 
-    - name: Run with setup-python 3.7.5
-      uses: ./
-      with:
-        python-version: 3.7.5
-    - name: Verify 3.7.5
-      run: python __tests__/verify-python.py 3.7.5
+      - name: Run with setup-python 3.7.5
+        uses: ./
+        with:
+          python-version: 3.7.5
+      - name: Verify 3.7.5
+        run: python __tests__/verify-python.py 3.7.5
 
-    - name: Run with setup-python 3.6.7
-      uses: ./
-      with:
-        python-version: 3.6.7
-    - name: Verify 3.6.7
-      run: python __tests__/verify-python.py 3.6.7
+      - name: Run with setup-python 3.6.7
+        uses: ./
+        with:
+          python-version: 3.6.7
+      - name: Verify 3.6.7
+        run: python __tests__/verify-python.py 3.6.7
 
-    - name: Run with setup-python 3.8.1
-      uses: ./
-      with:
-        python-version: 3.8.1
-    - name: Verify 3.8.1
-      run: python __tests__/verify-python.py 3.8.1
+      - name: Run with setup-python 3.8.1
+        uses: ./
+        with:
+          python-version: 3.8.1
+      - name: Verify 3.8.1
+        run: python __tests__/verify-python.py 3.8.1
 
-    - name: Run with setup-python 3.10
-      id: cp310
-      uses: ./
-      with:
-        python-version: "3.10"
-    - name: Verify 3.10
-      run: python __tests__/verify-python.py 3.10
-    - name: Run python-path sample 3.10
-      run: pipx run --python '${{ steps.cp310.outputs.python-path }}' nox --version
+      - name: Run with setup-python 3.10
+        id: cp310
+        uses: ./
+        with:
+          python-version: '3.10'
+      - name: Verify 3.10
+        run: python __tests__/verify-python.py 3.10
+      - name: Run python-path sample 3.10
+        run: pipx run --python '${{ steps.cp310.outputs.python-path }}' nox --version
diff --git a/.github/workflows/licensed.yml b/.github/workflows/licensed.yml
@@ -11,4 +11,4 @@ on:
 jobs:
   call-licensed:
     name: Licensed
-    uses: actions/reusable-workflows/.github/workflows/licensed.yml@main
+    uses: actions/reusable-workflows/.github/workflows/licensed.yml@main
diff --git a/.github/workflows/release-new-action-version.yml b/.github/workflows/release-new-action-version.yml
@@ -21,8 +21,8 @@ jobs:
       name: releaseNewActionVersion
     runs-on: ubuntu-latest
     steps:
-    - name: Update the ${{ env.TAG_NAME }} tag
-      uses: actions/[email protected]
-      with:
-        source-tag: ${{ env.TAG_NAME }}
-        slack-webhook: ${{ secrets.SLACK_WEBHOOK }}
+      - name: Update the ${{ env.TAG_NAME }} tag
+        uses: actions/[email protected]
+        with:
+          source-tag: ${{ env.TAG_NAME }}
+          slack-webhook: ${{ secrets.SLACK_WEBHOOK }}
diff --git a/.github/workflows/test-pypy.yml b/.github/workflows/test-pypy.yml
@@ -1,6 +1,6 @@
 name: Validate PyPy e2e
 
-on: 
+on:
   push:
     branches:
       - main
@@ -21,22 +21,22 @@ jobs:
       matrix:
         os: [macos-latest, windows-latest, ubuntu-18.04, ubuntu-latest]
         pypy:
-        - 'pypy-2.7'
-        - 'pypy-3.7'
-        - 'pypy3.9'
-        - 'pypy-2.7-v7.3.4'
-        - 'pypy-3.7-v7.3.5'
-        - 'pypy-3.7-v7.3.4'
-        - 'pypy-3.7-v7.3.x'
-        - 'pypy-3.7-v7.x'
-        - 'pypy-2.7-v7.3.4rc1'
-        - 'pypy-3.7-nightly'
-        - 'pypy3.8-v7.3.7'
+          - 'pypy-2.7'
+          - 'pypy-3.7'
+          - 'pypy3.9'
+          - 'pypy-2.7-v7.3.4'
+          - 'pypy-3.7-v7.3.5'
+          - 'pypy-3.7-v7.3.4'
+          - 'pypy-3.7-v7.3.x'
+          - 'pypy-3.7-v7.x'
+          - 'pypy-2.7-v7.3.4rc1'
+          - 'pypy-3.7-nightly'
+          - 'pypy3.8-v7.3.7'
 
     steps:
       - name: Checkout
         uses: actions/checkout@v3
-  
+
       - name: setup-python ${{ matrix.pypy }}
         id: setup-python
         uses: ./
@@ -49,7 +49,7 @@ jobs:
 
       - name: PyPy and Python version
         run: python --version
-  
+
       - name: Run simple code
         run: python -c 'import math; print(math.factorial(5))'
 
@@ -138,8 +138,8 @@ jobs:
         uses: ./
         with:
           python-version: |
-              pypy-3.7-v7.3.x
-              pypy3.8
+            pypy-3.7-v7.3.x
+            pypy3.8
           check-latest: true
       - name: PyPy and Python version
         run: python --version
@@ -166,4 +166,4 @@ jobs:
           EXECUTABLE=${EXECUTABLE/pypy-/pypy}  # remove the first '-' in "pypy-X.Y" -> "pypyX.Y" to match executable name
           EXECUTABLE=${EXECUTABLE%%-*}  # remove any -* suffixe
           ${EXECUTABLE} --version
-        shell: bash
+        shell: bash