chore(tsc+lint): Enhancing project tsc and linting (#1873)

* Reapply "chore(tsc+lint): Enhancing project tsc and linting (#1867)"

This reverts commit 4b9bedb.

* Separate build vs normal tsc check since it broke the release

* Add warning to be verbose on the exclude behavior

* Ensure no test folder in the lib folder

Author: dprevost-LMI

eslint.config.mjs

@@ -4,7 +4,7 @@ export default wdioEslint.config([
     {
         ignores: [
             'lib',
-            'types'
+            '**/*/dist'
         ]
     },
     /**

package.json

@@ -48,6 +48,7 @@
     "compile": "tsc --build tsconfig.build.json",
     "tsc:root-types": "tsc jasmine.d.ts jest.d.ts",
     "test": "run-s test:*",
+    "test:tsc": "tsc --project tsconfig.json --noEmit",
     "test:lint": "eslint .",
     "test:unit": "vitest --run",
     "test:types": "node test-types/copy && npm run ts && npm run clean:tests && npm run tsc:root-types",

src/utils.ts

@@ -53,7 +53,6 @@ const waitUntil = async (
     // wait for condition to be truthy
     try {
         const start = Date.now()
-        // eslint-disable-next-line no-constant-condition
         while (true) {
             if (Date.now() - start > wait) {
                 throw new Error('timeout')

test/matchers/mock/toBeRequested.test.ts

@@ -1,4 +1,5 @@
 import { vi, test, describe, expect } from 'vitest'
+// @ts-ignore TODO fix me
 import type { Matches, Mock } from 'webdriverio'
 
 import { toBeRequested } from '../../../src/matchers/mock/toBeRequested.js'

test/matchers/mock/toBeRequestedTimes.test.ts

@@ -1,4 +1,5 @@
 import { vi, test, describe, expect } from 'vitest'
+// @ts-ignore TODO fix me
 import type { Matches, Mock } from 'webdriverio'
 
 import { toBeRequestedTimes } from '../../../src/matchers/mock/toBeRequestedTimes.js'

test/util/elementsUtil.test.ts

@@ -8,13 +8,13 @@ vi.mock('@wdio/globals')
 describe('elementsUtil', () => {
     describe('wrapExpectedWithArray', () => {
         test('is not array ', async () => {
-            const el = await $('sel')
+            const el = (await $('sel')) as unknown as WebdriverIO.Element
             const actual = wrapExpectedWithArray(el, 'Test Actual', 'Test Expected')
             expect(actual).toEqual('Test Expected')
         })
 
         test('is array ', async () => {
-            const els = await $$('sel')
+            const els = (await $$('sel')) as unknown as WebdriverIO.ElementArray
             const actual = wrapExpectedWithArray(els, ['Test Actual', 'Test Actual'], 'Test Expected')
             expect(actual).toEqual(['Test Expected'])
         })

test/util/refetchElements.test.ts

@@ -9,7 +9,7 @@ describe('refetchElements', () => {
     let els: WebdriverIO.ElementArray
 
     beforeEach(async () => {
-        els = await $$('parent')
+        els = (await $$('parent')) as unknown as WebdriverIO.ElementArray
         // @ts-ignore
         els.parent._length = 5
     })

tsconfig.build.json

@@ -1,6 +1,7 @@
 {
   "extends": "./tsconfig.json",
   "exclude": [
+    // Warning: not excluding test folder change the release folder root structure
     "./test/**/*.ts"
   ]
-}
+}

types/expect-webdriverio.d.ts

@@ -1,14 +1,16 @@
-type ServiceInstance =  import('@wdio/types').Services.ServiceInstance;
-type Test = import('@wdio/types').Frameworks.Test;
-type TestResult = import('@wdio/types').Frameworks.TestResult;
-type PickleStep = import('@wdio/types').Frameworks.PickleStep;
-type Scenario = import('@wdio/types').Frameworks.Scenario;
-type SnapshotResult = import('@vitest/snapshot').SnapshotResult;
-type SnapshotUpdateState = import('@vitest/snapshot').SnapshotUpdateState;
+/* eslint-disable @typescript-eslint/consistent-type-imports*/
+type ServiceInstance =  import('@wdio/types').Services.ServiceInstance
+type Test = import('@wdio/types').Frameworks.Test
+type TestResult = import('@wdio/types').Frameworks.TestResult
+type PickleStep = import('@wdio/types').Frameworks.PickleStep
+type Scenario = import('@wdio/types').Frameworks.Scenario
+type SnapshotResult = import('@vitest/snapshot').SnapshotResult
+type SnapshotUpdateState = import('@vitest/snapshot').SnapshotUpdateState
 
 declare namespace ExpectWebdriverIO {
     const expect: ExpectWebdriverIO.Expect
     function setOptions(options: DefaultOptions): void
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     function getConfig(): any
 
     interface SnapshotServiceArgs {
@@ -23,32 +25,34 @@ declare namespace ExpectWebdriverIO {
     }
 
     interface SoftFailure {
-        error: Error;
-        matcherName: string;
-        location?: string;
+        error: Error
+        matcherName: string
+        location?: string
     }
 
     class SoftAssertService {
-        static getInstance(): SoftAssertService;
-        setCurrentTest(testId: string, testName?: string, testFile?: string): void;
-        clearCurrentTest(): void;
-        getCurrentTestId(): string | null;
-        addFailure(error: Error, matcherName: string): void;
-        getFailures(testId?: string): SoftFailure[];
-        clearFailures(testId?: string): void;
-        assertNoFailures(testId?: string): void;
+        static getInstance(): SoftAssertService
+        setCurrentTest(testId: string, testName?: string, testFile?: string): void
+        clearCurrentTest(): void
+        getCurrentTestId(): string | null
+        addFailure(error: Error, matcherName: string): void
+        getFailures(testId?: string): SoftFailure[]
+        clearFailures(testId?: string): void
+        assertNoFailures(testId?: string): void
     }
 
     interface SoftAssertionServiceOptions {
-        autoAssertOnTestEnd?: boolean;
+        autoAssertOnTestEnd?: boolean
     }
 
     class SoftAssertionService implements ServiceInstance {
-        constructor(serviceOptions?: SoftAssertionServiceOptions, capabilities?: any, config?: any);
-        beforeTest(test: Test): void;
-        beforeStep(step: PickleStep, scenario: Scenario): void;
-        afterTest(test: Test, context: any, result: TestResult): void;
-        afterStep(step: PickleStep, scenario: Scenario, result: { passed: boolean, error?: Error }): void;
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        constructor(serviceOptions?: SoftAssertionServiceOptions, capabilities?: any, config?: any)
+        beforeTest(test: Test): void
+        beforeStep(step: PickleStep, scenario: Scenario): void
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        afterTest(test: Test, context: any, result: TestResult): void
+        afterStep(step: PickleStep, scenario: Scenario, result: { passed: boolean, error?: Error }): void
     }
 
     interface AssertionResult {
@@ -59,7 +63,9 @@ declare namespace ExpectWebdriverIO {
     const matchers: Map<
         string,
         (
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
             actual: any,
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
             ...expected: any[]
         ) => Promise<AssertionResult>
     >
@@ -79,6 +85,7 @@ declare namespace ExpectWebdriverIO {
          * expect(el).toHaveAttribute('attr', 'value', { ... }) // expectedValue is `['attr', 'value]`
          * ```
          */
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         expectedValue?: any,
         /**
          * Options that the user has passed in, e.g. `expect(el).toHaveText('foo', { ignoreCase: true })` -> `{ ignoreCase: true }`
@@ -238,10 +245,10 @@ declare namespace ExpectWebdriverIO {
          * **Usage**
          * ```js
          * // Check if an element has the class 'btn'
-         * await expect(element).toHaveElementClass('btn');
+         * await expect(element).toHaveElementClass('btn')
          *
          * // Check if an element has any of the specified classes
-         * await expect(element).toHaveElementClass(['btn', 'btn-large']);
+         * await expect(element).toHaveElementClass(['btn', 'btn-large'])
          * ```
          */
         toHaveElementClass(className: string | RegExp | Array<string | RegExp> | ExpectWebdriverIO.PartialMatcher, options?: ExpectWebdriverIO.StringOptions): R
@@ -251,6 +258,7 @@ declare namespace ExpectWebdriverIO {
          */
         toHaveElementProperty(
             property: string | RegExp | ExpectWebdriverIO.PartialMatcher,
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
             value?: any,
             options?: ExpectWebdriverIO.StringOptions
         ): R
@@ -418,7 +426,7 @@ declare namespace ExpectWebdriverIO {
         toBeElementsArrayOfSize(
             size: number | ExpectWebdriverIO.NumberOptions,
             options?: ExpectWebdriverIO.NumberOptions
-        ): R & Promise<WebdriverIO.ElementArray>;
+        ): R & Promise<WebdriverIO.ElementArray>
 
         // ==== network mock ====
         /**
@@ -479,8 +487,10 @@ declare namespace ExpectWebdriverIO {
     type JsonCompatible = jsonObject | jsonArray
 
     interface PartialMatcher {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         sample?: any
         $$typeof: symbol
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         asymmetricMatch(...args: any[]): boolean
         toString(): string
     }
@@ -527,6 +537,7 @@ declare namespace ExpectWebdriverIO {
     }
 
     interface AsymmetricMatchers {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         any(expectedObject: any): PartialMatcher
         anything(): PartialMatcher
         arrayContaining(sample: Array<unknown>): PartialMatcher

types/standalone.d.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/consistent-type-imports*/
 /// <reference types="./expect-webdriverio.js"/>
 
 type ChainablePromiseElement = import('webdriverio').ChainablePromiseElement
@@ -21,6 +22,7 @@ declare namespace ExpectWebdriverIO {
     } & AsymmetricMatchers
 
     interface AsymmetricMatchers {
+        // eslint-disable-next-line  @typescript-eslint/no-explicit-any
         any(expectedObject: any): PartialMatcher
         anything(): PartialMatcher
         arrayContaining(sample: Array<unknown>): PartialMatcher