Fix ESLint (#184)

ovotech · Feb 28, 2024 · f59156a · f59156a
1 parent 5a3055e
commit f59156a
Show file tree

Hide file tree

Showing 10 changed files with 70 additions and 276 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -0,0 +1,20 @@
+{
+    "env": {
+        "commonjs": true,
+        "es2021": true,
+        "node": true
+    },
+    "extends": [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/recommended"
+    ],
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "ecmaVersion": "latest"
+    },
+    "plugins": [
+        "@typescript-eslint"
+    ],
+    "rules": {
+    }
+}
diff --git a/.github/workflows/on-push.yml b/.github/workflows/on-push.yml
@@ -3,18 +3,18 @@ name: On Push
 on: [push]
 
 jobs:
-#  lint:
-#    runs-on: ubuntu-latest
-#    steps:
-#      - uses: actions/checkout@v4
-#      - name: Setup Node
-#        uses: actions/setup-node@v1
-#        with:
-#          node-version: 16.x
-#      - run: yarn
-#      - run: yarn lint
-#        env:
-#          CI: true
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 16.x
+      - run: yarn
+      - run: yarn lint
+        env:
+          CI: true
 
   test-and-build:
     runs-on: ubuntu-latest

diff --git a/docs/linting.md b/docs/linting.md
@@ -0,0 +1,7 @@
+# ESLint
+
+ESLint is installed against each package using:
+
+```shell
+npx eslint --init
+```
diff --git a/examples/api/package.json b/examples/api/package.json
@@ -4,7 +4,7 @@
   "private": true,
   "packageManager": "[email protected]",
   "scripts": {
-    "lint": "eslint 'src/**/*.ts'",
+    "lint": "eslint -c ../../.eslintrc.json 'src/**/*.ts' '__tests__/**/*.ts'",
     "test": "jest __tests__",
     "test:js": "node ../api/src/js-script.js",
     "test:ts": "node -r ts-node/register ../api/src/ts-script.ts"
@@ -13,13 +13,10 @@
     "@ovotech/genesys-web-messaging-tester": "2.0.7",
     "@types/jest": "^29.0.3",
     "@types/node": "^14.14.2",
-    "@typescript-eslint/eslint-plugin": "^7.1.0",
-    "@typescript-eslint/parser": "^7.1.0",
+    "@typescript-eslint/eslint-plugin": "latest",
+    "@typescript-eslint/parser": "latest",
+    "eslint": "latest",
     "dotenv": "^16.3.1",
-    "eslint": "^8.57.0",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-jest": "^27.9.0",
-    "eslint-plugin-prettier": "^5.1.3",
     "jest": "^29.0.3",
     "prettier": "^3.1.1",
     "ts-jest": "^29.1.1",

diff --git a/packages/genesys-web-messaging-tester-cli/package.json b/packages/genesys-web-messaging-tester-cli/package.json
@@ -19,7 +19,7 @@
   "scripts": {
     "build": "rm -rf ./lib && tsc -p tsconfig.json",
     "test": "jest __tests__/",
-    "lint": "eslint 'src/**/*.ts'",
+    "lint": "eslint -c ../../.eslintrc.json 'src/**/*.ts' '__tests__/**/*.ts'",
     "test:execute:scripted": "ts-node src/index.ts scripted ../../examples/cli-scripted-tests/example.yml -id $DEPLOYMENT_ID -r $REGION -p 10",
     "test:execute:scripted:help": "ts-node src/index.ts --help",
     "test:execute:ai": "ts-node src/index.ts ai ../../examples/cli-ai-tests/chatgpt-example.yml -id $DEPLOYMENT_ID -r $REGION",
@@ -48,12 +48,9 @@
     "@types/jest-when": "^3.5.2",
     "@types/js-yaml": "^4.0.5",
     "@types/node": "^14.14.2",
-    "@typescript-eslint/eslint-plugin": "^7.1.0",
-    "@typescript-eslint/parser": "^7.1.0",
-    "eslint": "^8.57.0",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-jest": "^27.9.0",
-    "eslint-plugin-prettier": "^5.1.3",
+    "@typescript-eslint/eslint-plugin": "latest",
+    "@typescript-eslint/parser": "latest",
+    "eslint": "latest",
     "get-port": "^5.1.1",
     "jest": "^29.0.3",
     "jest-when": "^3.5.0",

diff --git a/packages/genesys-web-messaging-tester/package.json b/packages/genesys-web-messaging-tester/package.json
@@ -20,7 +20,7 @@
     "build": "rm -rf ./lib && tsc -p tsconfig.json",
     "build:readme": "cd ../.. && yarn build-readme ./packages/genesys-web-messaging-tester/README.md https://github.com/ovotech/genesys-web-messaging-tester/tree/main",
     "test": "jest __tests__/",
-    "lint": "eslint 'src/**/*.ts'"
+    "lint": "eslint -c ../../.eslintrc.json 'src/**/*.ts' '__tests__/**/*.ts'"
   },
   "dependencies": {
     "debug": "^4.3.3",
@@ -36,12 +36,9 @@
     "@types/sinonjs__fake-timers": "^8.1.2",
     "@types/uuid": "^9.0.2",
     "@types/ws": "^8.5.5",
-    "@typescript-eslint/eslint-plugin": "^7.1.0",
-    "@typescript-eslint/parser": "^7.1.0",
-    "eslint": "^8.57.0",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-jest": "^27.9.0",
-    "eslint-plugin-prettier": "^5.1.3",
+    "@typescript-eslint/eslint-plugin": "latest",
+    "@typescript-eslint/parser": "latest",
+    "eslint": "latest",
     "get-port": "^5.1.1",
     "jest": "^29.0.3",
     "prettier": "^3.1.1",

diff --git a/packages/genesys-web-messaging-tester/src/testFixtures/WebMessageServerConnectionFixture.ts b/packages/genesys-web-messaging-tester/src/testFixtures/WebMessageServerConnectionFixture.ts
@@ -4,6 +4,7 @@ import { webMessagePayloads } from './webMessagePayloads';
 export class WebMessageServerConnectionFixture {
   constructor(private readonly ws: WebSocket) {}
 
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   public async waitForMessage(): Promise<any> {
     return new Promise((resolve, reject) => {
       this.ws.on('message', function message(data) {

diff --git a/tsconfig.json b/tsconfig.json
@@ -1,8 +1,8 @@
 {
   "compilerOptions": {
     "skipLibCheck": true,
-    "target": "es2019",
-    "module": "commonjs",
+    "target": "ES2021",
+    "module": "CommonJS",
     "declaration": true,
     "strict": true,
     "noImplicitAny": true,
@@ -19,7 +19,7 @@
     "forceConsistentCasingInFileNames": true,
     "esModuleInterop": true,
     "lib": [
-      "es2019"
+      "ES2021"
     ]
   }
 }