Replace tslint with eslint (#3450)

* Replace tslint with eslint * Eslint handles prettier * Lint adblocker/tools
ghostery · Sep 19, 2023 · db472b9 · db472b9
1 parent a619b37
commit db472b9
Show file tree

Hide file tree

Showing 39 changed files with 936 additions and 252 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -0,0 +1,34 @@
+/* eslint-env node */
+module.exports = {
+  extends: [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:@typescript-eslint/recommended-type-checked",
+    "prettier",
+  ],
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    tsconfigRootDir: __dirname,
+    project: ["./packages/*/tsconfig.json"],
+  },
+  plugins: [
+    "@typescript-eslint",
+    "prettier",
+  ],
+  root: true,
+  rules: {
+    "prettier/prettier": 2, // Means error
+    "@typescript-eslint/no-explicit-any": "off",
+    "@typescript-eslint/ban-types": "off",
+    "@typescript-eslint/unbound-method": "off",
+    "@typescript-eslint/no-unsafe-assignment": "off",
+    "@typescript-eslint/ban-ts-comment": "off",
+    "@typescript-eslint/no-redundant-type-constituents": "off",
+    "@typescript-eslint/no-duplicate-type-constituents": "off",
+    "@typescript-eslint/no-unsafe-argument": "off",
+    "@typescript-eslint/no-floating-promises": "off",
+    "@typescript-eslint/no-unsafe-return": "off",
+    "@typescript-eslint/no-misused-promises": "off",
+    "@typescript-eslint/require-await": "off",
+  },
+};
diff --git a/package.json b/package.json
@@ -72,13 +72,17 @@
     "@remusao/auto-config": "^1.1.2",
     "@types/benchmark": "^2.1.3",
     "@types/node": "^20.6.2",
+    "@typescript-eslint/eslint-plugin": "^6.7.0",
+    "@typescript-eslint/parser": "^6.7.0",
     "auto": "^11.0.4",
     "benchmark": "^2.1.4",
     "chalk": "^5.3.0",
+    "eslint": "^8.49.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-prettier": "^5.0.0",
     "lerna": "^7.3.0",
     "patch-package": "^8.0.0",
     "prettier": "^3.0.3",
-    "tslint-no-unused-expression-chai": "^0.1.4",
     "typescript": "^5.2.2"
   },
   "auto": {

diff --git a/packages/adblocker-content/package.json b/packages/adblocker-content/package.json
@@ -24,7 +24,7 @@
   },
   "scripts": {
     "clean": "rimraf dist coverage",
-    "lint": "tslint --config ../../tslint.json --project ./tsconfig.json",
+    "lint": "eslint adblocker.ts",
     "build": "tsc --build ./tsconfig.json",
     "bundle": "tsc --build ./tsconfig.bundle.json && rollup --config ./rollup.config.ts --configPlugin typescript",
     "prepack": "yarn run bundle"
@@ -39,13 +39,11 @@
     "@rollup/plugin-node-resolve": "^15.2.1",
     "@rollup/plugin-typescript": "^11.1.3",
     "@types/node": "^20.6.2",
+    "eslint": "^8.49.0",
     "rimraf": "^5.0.1",
     "rollup": "^3.29.2",
     "rollup-plugin-sourcemaps": "^0.6.3",
     "rollup-plugin-terser": "^7.0.2",
-    "tslint": "^6.1.3",
-    "tslint-config-prettier": "^1.18.0",
-    "tslint-no-unused-expression-chai": "^0.1.4",
     "typescript": "^5.2.2"
   },
   "contributors": [

diff --git a/packages/adblocker-electron-example/package.json b/packages/adblocker-electron-example/package.json
@@ -20,7 +20,7 @@
   },
   "scripts": {
     "start": "electron index.js",
-    "lint": "tslint --config ../../tslint.json --project ./tsconfig.json"
+    "lint": "eslint index.ts"
   },
   "bugs": {
     "url": "https://github.com/cliqz-oss/adblocker/issues"
@@ -67,8 +67,7 @@
   },
   "devDependencies": {
     "@types/node-fetch": "^3.0.3",
-    "tslint": "^6.1.3",
-    "tslint-config-prettier": "^1.18.0",
+    "eslint": "^8.49.0",
     "typescript": "^5.2.2"
   }
 }
diff --git a/packages/adblocker-electron-preload/package.json b/packages/adblocker-electron-preload/package.json
@@ -27,7 +27,7 @@
   },
   "scripts": {
     "clean": "rimraf dist coverage",
-    "lint": "tslint --config ../../tslint.json --project ./tsconfig.json",
+    "lint": "eslint preload.ts",
     "build": "tsc --build ./tsconfig.json && rollup --config ./rollup.config.ts --configPlugin typescript",
     "bundle": "yarn build",
     "prepack": "yarn run bundle"
@@ -44,12 +44,10 @@
     "@rollup/plugin-typescript": "^11.1.3",
     "@types/chrome": "^0.0.246",
     "electron": "^26.2.1",
+    "eslint": "^8.49.0",
     "rimraf": "^5.0.1",
     "rollup": "^3.29.2",
     "rollup-plugin-sourcemaps": "^0.6.3",
-    "tslint": "^6.1.3",
-    "tslint-config-prettier": "^1.18.0",
-    "tslint-no-unused-expression-chai": "^0.1.4",
     "typescript": "^5.2.2"
   },
   "contributors": [

diff --git a/packages/adblocker-electron/package.json b/packages/adblocker-electron/package.json
@@ -27,7 +27,7 @@
   },
   "scripts": {
     "clean": "rimraf dist coverage",
-    "lint": "tslint --config ../../tslint.json --project ./tsconfig.json",
+    "lint": "eslint adblocker.ts",
     "build": "tsc --build ./tsconfig.json",
     "bundle": "tsc --build ./tsconfig.bundle.json",
     "prepack": "yarn run bundle",
@@ -46,13 +46,11 @@
     "@types/mocha": "^10.0.1",
     "chai": "^4.3.8",
     "electron": "^26.2.1",
+    "eslint": "^8.49.0",
     "mocha": "^10.2.0",
     "nyc": "^15.1.0",
     "rimraf": "^5.0.1",
     "ts-node": "^10.9.1",
-    "tslint": "^6.1.3",
-    "tslint-config-prettier": "^1.18.0",
-    "tslint-no-unused-expression-chai": "^0.1.4",
     "typescript": "^5.2.2"
   },
   "contributors": [

diff --git a/packages/adblocker-extended-selectors/package.json b/packages/adblocker-extended-selectors/package.json
@@ -24,7 +24,7 @@
   },
   "scripts": {
     "clean": "rimraf dist coverage",
-    "lint": "tslint --config ../../tslint.json --project ./tsconfig.json",
+    "lint": "eslint src adblocker.ts",
     "build": "tsc --build ./tsconfig.json",
     "bundle": "tsc --build ./tsconfig.bundle.json",
     "prepack": "yarn run bundle",
@@ -41,14 +41,12 @@
     "@types/node": "^20.6.2",
     "chai": "^4.3.8",
     "chai-as-promised": "^7.1.1",
+    "eslint": "^8.49.0",
     "jsdom": "^22.1.0",
     "mocha": "^10.2.0",
     "nyc": "^15.1.0",
     "rimraf": "^5.0.1",
     "ts-node": "^10.9.1",
-    "tslint": "^6.1.3",
-    "tslint-config-prettier": "^1.18.0",
-    "tslint-no-unused-expression-chai": "^0.1.4",
     "typescript": "^5.2.2"
   },
   "contributors": [

diff --git a/packages/adblocker-extended-selectors/src/parse.ts b/packages/adblocker-extended-selectors/src/parse.ts
@@ -57,7 +57,8 @@ export const RECURSIVE_PSEUDO_CLASSES = new Set([
 ]);
 
 const TOKENS: { [T in TokenType]: RegExp } = {
-  attribute: /\[\s*(?:(?<namespace>\*|[-\w]*)\|)?(?<name>[-\w\u{0080}-\u{FFFF}]+)\s*(?:(?<operator>\W?=)\s*(?<value>.+?)\s*(?<caseSensitive>[iIsS])?\s*)?\]/gu,
+  attribute:
+    /\[\s*(?:(?<namespace>\*|[-\w]*)\|)?(?<name>[-\w\u{0080}-\u{FFFF}]+)\s*(?:(?<operator>\W?=)\s*(?<value>.+?)\s*(?<caseSensitive>[iIsS])?\s*)?\]/gu,
   id: /#(?<name>(?:[-\w\u{0080}-\u{FFFF}]|\\.)+)/gu,
   class: /\.(?<name>(?:[-\w\u{0080}-\u{FFFF}]|\\.)+)/gu,
   comma: /\s*,\s*/g, // must be before combinator

diff --git a/packages/adblocker-extended-selectors/src/types.ts b/packages/adblocker-extended-selectors/src/types.ts
@@ -17,7 +17,7 @@ const tokenTypes = [
   'type',
 ] as const;
 
-export type TokenType = typeof tokenTypes[number];
+export type TokenType = (typeof tokenTypes)[number];
 
 export type Base = {
   length: number;

diff --git a/packages/adblocker-playwright-example/package.json b/packages/adblocker-playwright-example/package.json
@@ -19,7 +19,7 @@
   },
   "scripts": {
     "start": "ts-node --project ./tsconfig.json index.ts",
-    "lint": "tslint --config ../../tslint.json --project ./tsconfig.json"
+    "lint": "eslint index.ts"
   },
   "bugs": {
     "url": "https://github.com/cliqz-oss/adblocker/issues"
@@ -32,8 +32,7 @@
   },
   "devDependencies": {
     "@types/node-fetch": "^3.0.3",
-    "tslint": "^6.1.3",
-    "tslint-config-prettier": "^1.18.0",
+    "eslint": "^8.49.0",
     "typescript": "^5.2.2"
   },
   "contributors": [

diff --git a/packages/adblocker-playwright/adblocker.ts b/packages/adblocker-playwright/adblocker.ts
@@ -54,7 +54,10 @@ export class BlockingContext {
   private readonly onFrameNavigated: (frame: pw.Frame) => Promise<void>;
   private readonly onRequest: (route: pw.Route) => void;
 
-  constructor(private readonly page: pw.Page, private readonly blocker: PlaywrightBlocker) {
+  constructor(
+    private readonly page: pw.Page,
+    private readonly blocker: PlaywrightBlocker,
+  ) {
     this.onFrameNavigated = (frame) => blocker.onFrameNavigated(frame);
     this.onRequest = (route: pw.Route) => blocker.onRequest(route);
   }
@@ -266,6 +269,7 @@ export class PlaywrightBlocker extends FiltersEngine {
       }
 
       await sleep(500);
+      // eslint-disable-next-line no-constant-condition
     } while (true);
   };
 

diff --git a/packages/adblocker-playwright/package.json b/packages/adblocker-playwright/package.json
@@ -24,7 +24,7 @@
   },
   "scripts": {
     "clean": "rimraf dist coverage",
-    "lint": "tslint --config ../../tslint.json --project ./tsconfig.json",
+    "lint": "eslint adblocker.ts",
     "build": "tsc --build ./tsconfig.json",
     "bundle": "tsc --build ./tsconfig.bundle.json",
     "prepack": "yarn run bundle",
@@ -45,12 +45,11 @@
     "@types/chai": "^4.3.6",
     "@types/mocha": "^10.0.1",
     "chai": "^4.3.8",
+    "eslint": "^8.49.0",
     "mocha": "^10.2.0",
     "nyc": "^15.1.0",
     "playwright": "^1.38.0",
     "rimraf": "^5.0.1",
-    "tslint": "^6.1.3",
-    "tslint-config-prettier": "^1.18.0",
     "typescript": "^5.2.2"
   },
   "contributors": [

diff --git a/packages/adblocker-puppeteer-example/package.json b/packages/adblocker-puppeteer-example/package.json
@@ -19,7 +19,7 @@
   },
   "scripts": {
     "start": "ts-node --project ./tsconfig.json index.ts",
-    "lint": "tslint --config ../../tslint.json --project ./tsconfig.json"
+    "lint": "eslint index.ts"
   },
   "bugs": {
     "url": "https://github.com/cliqz-oss/adblocker/issues"
@@ -32,8 +32,7 @@
   },
   "devDependencies": {
     "@types/node-fetch": "^3.0.3",
-    "tslint": "^6.1.3",
-    "tslint-config-prettier": "^1.18.0",
+    "eslint": "^8.49.0",
     "typescript": "^5.2.2"
   },
   "contributors": [

diff --git a/packages/adblocker-puppeteer/adblocker.ts b/packages/adblocker-puppeteer/adblocker.ts
@@ -58,7 +58,10 @@ export class BlockingContext {
   private readonly onDomContentLoaded: () => Promise<void>;
   private readonly onRequest: (details: puppeteer.HTTPRequest) => void;
 
-  constructor(private readonly page: puppeteer.Page, private readonly blocker: PuppeteerBlocker) {
+  constructor(
+    private readonly page: puppeteer.Page,
+    private readonly blocker: PuppeteerBlocker,
+  ) {
     this.onFrameNavigated = (frame) => blocker.onFrameNavigated(frame);
     this.onDomContentLoaded = () => blocker.onFrameNavigated(this.page.mainFrame());
     this.onRequest = (request) => blocker.onRequest(request);
@@ -276,6 +279,7 @@ export class PuppeteerBlocker extends FiltersEngine {
       }
 
       await sleep(500);
+      // eslint-disable-next-line no-constant-condition
     } while (true);
   };
 

diff --git a/packages/adblocker-puppeteer/package.json b/packages/adblocker-puppeteer/package.json
@@ -24,7 +24,7 @@
   },
   "scripts": {
     "clean": "rimraf dist coverage",
-    "lint": "tslint --config ../../tslint.json --project ./tsconfig.json",
+    "lint": "eslint adblocker.ts",
     "build": "tsc --build ./tsconfig.json",
     "bundle": "tsc --build ./tsconfig.bundle.json",
     "prepack": "yarn run bundle",
@@ -45,14 +45,12 @@
     "@types/chai": "^4.3.6",
     "@types/mocha": "^10.0.1",
     "chai": "^4.3.8",
+    "eslint": "^8.49.0",
     "mocha": "^10.2.0",
     "nyc": "^15.1.0",
     "puppeteer": "21.2.1",
     "rimraf": "^5.0.1",
     "ts-node": "^10.9.1",
-    "tslint": "^6.1.3",
-    "tslint-config-prettier": "^1.18.0",
-    "tslint-no-unused-expression-chai": "^0.1.4",
     "typescript": "^5.2.2"
   },
   "contributors": [

diff --git a/packages/adblocker-webextension-cosmetics/package.json b/packages/adblocker-webextension-cosmetics/package.json
@@ -24,7 +24,7 @@
   },
   "scripts": {
     "clean": "rimraf dist coverage",
-    "lint": "tslint --config ../../tslint.json --project ./tsconfig.json",
+    "lint": "eslint adblocker.ts",
     "build": "tsc --build ./tsconfig.json",
     "bundle": "tsc --build ./tsconfig.bundle.json && rollup --config ./rollup.config.ts --configPlugin typescript",
     "prepack": "yarn run bundle",
@@ -77,6 +77,7 @@
     "@types/sinon": "^10.0.16",
     "@types/sinon-chai": "^3.2.9",
     "chai": "^4.3.8",
+    "eslint": "^8.49.0",
     "jsdom": "^22.1.0",
     "mocha": "^10.2.0",
     "nyc": "^15.1.0",
@@ -87,9 +88,6 @@
     "sinon": "^16.0.0",
     "sinon-chai": "^3.7.0",
     "ts-node": "^10.9.1",
-    "tslint": "^6.1.3",
-    "tslint-config-prettier": "^1.18.0",
-    "tslint-no-unused-expression-chai": "^0.1.4",
     "typescript": "^5.2.2"
   },
   "dependencies": {

diff --git a/packages/adblocker-webextension-example/package.json b/packages/adblocker-webextension-example/package.json
@@ -20,7 +20,7 @@
   },
   "scripts": {
     "clean": "rimraf dist coverage",
-    "lint": "tslint --config ../../tslint.json --project ./tsconfig.json",
+    "lint": "eslint background.ts content-script.ts",
     "build": "tsc --build ./tsconfig.json",
     "bundle": "rollup --config ./rollup.config.ts --configPlugin typescript",
     "watch": "rollup --config ./rollup.config.ts --configPlugin typescript --watch",
@@ -41,11 +41,10 @@
     "@rollup/plugin-node-resolve": "^15.2.1",
     "@rollup/plugin-typescript": "^11.1.3",
     "@types/chrome": "^0.0.246",
+    "eslint": "^8.49.0",
     "rimraf": "^5.0.1",
     "rollup": "^3.29.2",
     "rollup-plugin-sourcemaps": "^0.6.3",
-    "tslint": "^6.1.3",
-    "tslint-config-prettier": "^1.18.0",
     "typescript": "^5.2.2"
   },
   "contributors": [