Adding ESLint to Sonar (#327)

* Adding eslint
smartcontractkit · Sep 22, 2023 · 3dc6bc4 · 3dc6bc4
1 parent b8ec6b3
commit 3dc6bc4
Show file tree

Hide file tree

Showing 6 changed files with 493 additions and 13 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -0,0 +1,20 @@
+{
+    "env": {
+        "browser": true,
+        "es2021": true
+    },
+    "extends": [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/recommended"
+    ],
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "ecmaVersion": "latest",
+        "sourceType": "module"
+    },
+    "plugins": [
+        "@typescript-eslint"
+    ],
+    "rules": {
+    }
+}
diff --git a/.github/workflows/integration_gauntlet.yml b/.github/workflows/integration_gauntlet.yml
@@ -8,6 +8,32 @@ on:
   pull_request:
 
 jobs:
+  gauntlet_eslint:
+    name: Gauntlet ESLint
+    env:
+      CI: true
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3.5.2
+      - name: Install Nix
+        uses: cachix/install-nix-action@29bd9290ef037a3ecbdafe83cbd2185e9dd0fa0a # v20
+        with:
+          nix_path: nixpkgs=channel:nixos-unstable
+          extra_nix_config: "sandbox = false"
+      - name: Cache Nix
+        uses: cachix/cachix-action@v12
+        with:
+          name: chainlink-cosmos
+          authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
+      - run: nix develop -c yarn install --frozen-lockfile
+      - run: nix develop -c yarn eslint
+      - name: Upload eslint report
+        if: always()
+        uses: actions/upload-artifact@3cea5372237819ed00197afe530f5a7ea3e805c8 # v3.1.0
+        with:
+          name: gauntlet-eslint-report
+          path: ./eslint-report.json
+
   integration_gauntlet_run_tests:
     name: Run Tests
     runs-on: ubuntu-latest

diff --git a/.github/workflows/sonar-scan.yml b/.github/workflows/sonar-scan.yml
@@ -23,7 +23,7 @@ jobs:
         with:
           max-timeout: "1200"
           polling-interval: "30"
-          exclude-workflow-names: "Amarna Analysis,Changesets,Integration Contracts (Vendor, Examples),Integration Gauntlet,Integration Tests Publish,Integration Tests - Smoke,Integration Tests - Soak,Build and push on-chain monitor image to ECR,Contracts,Lint"
+          exclude-workflow-names: "Amarna Analysis,Changesets,Integration Contracts (Vendor, Examples),Integration Tests Publish,Integration Tests - Smoke,Integration Tests - Soak,Build and push on-chain monitor image to ECR,Contracts,Lint"
           exclude-workflow-ids: ""
           github-token: ${{ secrets.GITHUB_TOKEN }}
         env:
@@ -76,6 +76,15 @@ jobs:
           name: golangci-lint-integration-tests-report
           if_no_artifact_found: warn
 
+      - name: Download gauntlet eslint reports
+        uses: dawidd6/[email protected]
+        with:
+          workflow: integration_gauntlet.yml
+          workflow_conclusion: ""
+          name_is_regexp: true
+          name: gauntlet-eslint-report
+          if_no_artifact_found: warn
+
       - name: Set SonarQube Report Paths
         id: sonarqube_report_paths
         shell: bash
@@ -84,14 +93,21 @@ jobs:
             echo "sonarqube_tests_report_paths=$(find . -type f -name output.txt | paste -sd "," -)"
             echo "sonarqube_coverage_report_paths=$(find . -type f -name '*coverage.txt' | paste -sd "," -)"
             echo "sonarqube_golangci_report_paths=$(find . -type f -name 'golangci-*-report.xml' -printf "%p,")"
+            echo "sonarqube_eslint_report_paths=$(find -type f -name 'eslint-report.json' -printf "%p")" >> $GITHUB_OUTPUT
           } >> "$GITHUB_OUTPUT"
+
+      - name: Update ESLint report symlinks
+        continue-on-error: true
+        run: sed -i 's+/home/runner/work/feeds-manager/feeds-manager/+/github/workspace/+g' ${{ steps.sonarqube_report_paths.outputs.sonarqube_eslint_report_paths }}
+
       - name: SonarQube Scan
         uses: sonarsource/sonarqube-scan-action@a6ba0aafc293e03de5437af7edbc97f7d3ebc91a # v1.2.0
         with:
           args: >
             -Dsonar.go.tests.reportPaths=${{ steps.sonarqube_report_paths.outputs.sonarqube_tests_report_paths }}
             -Dsonar.go.coverage.reportPaths=${{ steps.sonarqube_report_paths.outputs.sonarqube_coverage_report_paths }}
             -Dsonar.go.golangci-lint.reportPaths=${{ steps.sonarqube_report_paths.outputs.sonarqube_golangci_report_paths }}
+            -Dsonar.eslint.reportPaths=${{ steps.sonarqube_report_paths.outputs.sonarqube_eslint_report_paths }}
         env:
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
           SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL }}
diff --git a/.gitignore b/.gitignore
@@ -163,3 +163,4 @@ integration-tests/smoke/logs
 integration-tests/soak/logs
 remote.test
 ztarrepo.tar.gz
+eslint-report.json
diff --git a/package.json b/package.json
@@ -19,6 +19,7 @@
     "test": "yarn build && yarn workspaces run test",
     "test:coverage": "yarn test --collectCoverage",
     "test:ci": "yarn test --ci",
+    "eslint": "eslint -f json -o eslint-report.json ./packages-ts || true",
     "lint": "tsc -b ./tsconfig.json",
     "format": "yarn prettier --write .",
     "format:check": "yarn prettier --check .",
@@ -46,6 +47,9 @@
     "@changesets/cli": "^2.22.0",
     "@types/jest": "^28.1.0",
     "@types/node": "^18.7.11",
+    "@typescript-eslint/eslint-plugin": "^6.7.2",
+    "@typescript-eslint/parser": "^6.7.2",
+    "eslint": "^8.49.0",
     "jest": "^28.1.0",
     "pkg": "^5.2.1",
     "prettier": "2.1.1",