AG-29670: added types checking

Merge in ADGUARD-FILTERS/scriptlets from feature/AG-29670 to master

Squashed commit of the following:

commit e1751f0
Merge: aba5fd8 7446aa3
Author: Dmitriy Seregin <d.seregin@adguard.com>
Date:   Thu Feb 8 17:32:19 2024 +0300

    Merge branch 'master' into feature/AG-29670

commit aba5fd8
Author: Dmitriy Seregin <d.seregin@adguard.com>
Date:   Wed Feb 7 16:20:22 2024 +0300

    use Pick

commit 7bb0a5b
Author: Dmitriy Seregin <d.seregin@adguard.com>
Date:   Wed Feb 7 16:18:41 2024 +0300

    fixes

commit 2c946fe
Author: Slava Leleka <v.leleka@adguard.com>
Date:   Tue Feb 6 17:33:33 2024 +0300

    add types linter cache. AG-29670

    Squashed commit of the following:

    commit e01d28a
    Author: Slava Leleka <v.leleka@adguard.com>
    Date:   Tue Feb 6 15:47:00 2024 +0200

        add types linter cache

commit e495417
Author: Dmitriy Seregin <d.seregin@adguard.com>
Date:   Mon Feb 5 15:36:35 2024 +0300

    changed name

commit 1180c8c
Author: Dmitriy Seregin <d.seregin@adguard.com>
Date:   Thu Feb 1 18:58:12 2024 +0300

    AG-29670: added types checking

Author: 105th

.eslintrc.js

@@ -24,7 +24,7 @@ module.exports = {
         'import/resolver': {
             typescript: {
                 alwaysTryTypes: true,
-                project: 'tsconfig.eslint.json',
+                project: 'tsconfig.json',
             },
         },
     },
@@ -67,7 +67,7 @@ module.exports = {
             parser: '@typescript-eslint/parser',
             parserOptions: {
                 tsconfigRootDir: path.join(__dirname),
-                project: 'tsconfig.eslint.json',
+                project: 'tsconfig.json',
             },
             extends: [
                 'airbnb-typescript/base',

.gitignore

@@ -11,4 +11,7 @@ output.md
 tests/dist
 browserstack.err
 local.log
+
+# linters cache
 .eslintcache
+tsconfig.tsbuildinfo

package.json

@@ -8,7 +8,8 @@
         "browserstack": "yarn test --build && node browserstack.js",
         "test:qunit": "babel-node -x .js,.ts scripts/test.js",
         "test:jest": "jest",
-        "lint": "eslint --cache . && yarn lint:md",
+        "lint": "eslint --cache . && yarn lint:types && yarn lint:md",
+        "lint:types": "tsc --noEmit",
         "lint:md": "markdownlint .",
         "lint-staged": "lint-staged",
         "prepare": "husky install",

src/helpers/converter.ts

@@ -13,7 +13,9 @@ import validator from './validator';
 
 import { ADG_SCRIPTLET_MASK, parseRule } from './parse-rule';
 
-import * as scriptletList from '../scriptlets/scriptlets-list';
+import * as scriptletListRaw from '../scriptlets/scriptlets-list';
+
+const scriptletList: ScriptletsList = scriptletListRaw;
 
 type AdgScriptletObject = {
     name: string;
@@ -420,7 +422,7 @@ export const convertAdgScriptletToUbo = (rule: string): string | undefined => {
         // object of name and aliases for the Adg-scriptlet
         const scriptletNames = Object.keys(scriptletList);
         const adgScriptletObject = scriptletNames
-            .map((name) => (scriptletList as ScriptletstList)[name])
+            .map((name) => scriptletList[name])
             .map((scriptlet) => {
                 const [name, ...aliases] = scriptlet.names;
                 return { name, aliases };

src/helpers/observer.ts

@@ -1,7 +1,7 @@
 import { throttle } from './throttle';
 
 /**
- * DOM tree changes observer. Used for 'remove-attr' and 'remove-class' scriptlets
+ * DOM tree changes observer.
  *
  * @param callback function to call on each mutation
  * @param observeAttrs if observer should observe attributes changes

src/helpers/string-utils.ts

@@ -312,19 +312,21 @@ export const objectToString = (obj: ArbitraryObject): string => {
         return String(obj);
     }
 
-    return isEmptyObject(obj)
-        ? '{}'
-        : Object.entries(obj)
-            .map((pair) => {
-                const key = pair[0];
-                const value = pair[1];
-                let recordValueStr = value;
-                if (value instanceof Object) {
-                    recordValueStr = `{ ${objectToString(value as ArbitraryObject)} }`;
-                }
-                return `${key}:"${recordValueStr}"`;
-            })
-            .join(' ');
+    if (isEmptyObject(obj)) {
+        return '{}';
+    }
+
+    return Object.entries(obj)
+        .map((pair) => {
+            const key = pair[0];
+            const value = pair[1];
+            let recordValueStr = value;
+            if (value instanceof Object) {
+                recordValueStr = `{ ${objectToString(value as ArbitraryObject)} }`;
+            }
+            return `${key}:"${recordValueStr}"`;
+        })
+        .join(' ');
 };
 
 /**
@@ -334,20 +336,18 @@ export const objectToString = (obj: ArbitraryObject): string => {
  * @returns type's string representation
  */
 export const convertTypeToString = (value: unknown): string => {
-    let output;
     if (typeof value === 'undefined') {
-        output = 'undefined';
-    } else if (typeof value === 'object') {
+        return 'undefined';
+    }
+    if (typeof value === 'object') {
         if (value === null) {
-            output = 'null';
-        } else {
-            output = objectToString(value as Record<string, unknown>);
+            return 'null';
         }
-    } else {
-        output = value.toString();
+
+        return objectToString(value as ArbitraryObject);
     }
 
-    return output;
+    return (value as Pick<Object, 'toString'>).toString();
 };
 
 /**
@@ -403,11 +403,11 @@ export function generateRandomResponse(customResponseText: string): string | nul
     }
 
     const LENGTH_RANGE_LIMIT = 500 * 1000;
-    if ((rangeMax as number) > LENGTH_RANGE_LIMIT) {
+    if ((rangeMax) > LENGTH_RANGE_LIMIT) {
         return null;
     }
 
-    const length = getRandomIntInclusive((rangeMin as number), (rangeMax as number));
+    const length = getRandomIntInclusive((rangeMin), (rangeMax));
     customResponse = getRandomStrByLength(length);
     return customResponse;
 }

src/helpers/validator.ts

@@ -3,7 +3,7 @@ import {
     toRegExp,
 } from './string-utils';
 import { ADG_SCRIPTLET_MASK } from './parse-rule';
-import * as scriptletsList from '../scriptlets/scriptlets-list';
+import * as scriptletListRaw from '../scriptlets/scriptlets-list';
 import redirects from './compatibility-redirects';
 
 interface UboToAdgCompatibilityObject extends RedirectCompatibilityMap {
@@ -99,7 +99,7 @@ const isAbpSnippetRule = (rule: string): boolean => {
  * @returns Array of all scriptlet objects.
  */
 const getScriptletsObjList = () => {
-    return Object.values(scriptletsList as ScriptletstList);
+    return Object.values(scriptletListRaw);
 };
 
 /**
@@ -110,18 +110,16 @@ const getScriptletsObjList = () => {
  * @returns {Function} Scriptlet function.
  */
 const getScriptletByName = (name: string, scriptlets: Scriptlet[]): Scriptlet | undefined => {
-    if (!scriptlets) {
-        scriptlets = getScriptletsObjList();
-    }
-    return scriptlets
-        .find((s) => {
-            return s.names
-                // full match name checking
-                && (s.names.includes(name)
-                    // or check ubo alias name without '.js' at the end
-                    || (!name.endsWith('.js') && s.names.includes(`${name}.js`))
-                );
-        });
+    const allScriptletsFns = scriptlets || getScriptletsObjList();
+
+    return allScriptletsFns.find((s) => {
+        return s.names
+            // full match name checking
+            && (s.names.includes(name)
+                // or check ubo alias name without '.js' at the end
+                || (!name.endsWith('.js') && s.names.includes(`${name}.js`))
+            );
+    });
 };
 
 const scriptletObjects = getScriptletsObjList();

tsconfig.eslint.json

@@ -3,9 +3,15 @@
         "target": "esnext",
         "moduleResolution": "node",
         "allowJs": true,
+        "skipLibCheck": true,
         "noEmit": true,
         "strict": true,
         "lib":["DOM"],
+        "incremental": true,
         "esModuleInterop": true,
-    }
+    },
+    "exclude": [
+        "node_modules",
+        "dist",
+    ],
 }

tsconfig.json

@@ -9,7 +9,7 @@ interface Source {
 }
 
 type ArbitraryObject = { [key: string | symbol | number]: unknown };
-type ArbitraryFunction = (...args: unknown[]) => unknown;
+type ArbitraryFunction = (...args: any[]) => unknown;
 type NoopFunc = () => void;
 type TrueFunc = () => true;
 type Helper = ArbitraryFunction;
@@ -20,14 +20,14 @@ interface PageFunction {
 }
 
 interface Scriptlet extends PageFunction {
-    (source: Source, ...args: Array<string | number>): void;
+    (source: Source, ...args: any[]): void;
 }
 
 interface Redirect extends PageFunction {
     (source: Source): void;
 }
 
-type ScriptletstList = Record<string, Scriptlet>;
+type ScriptletsList = Record<string, Scriptlet>;
 
 type ChainBase = {
     [key: string]: ChainBase;