lint

Author: dskloetc

src/util/testing-utils.ts

@@ -536,25 +536,27 @@ export const mockWebSocketProvider = (provider: typeof WebSocketClassProvider):
 //
 // Throws (and logs, in case the error is caught by the code under test):
 // Error: Property 'obj.foo.baz' does not exist
-export function makeStub<T>(name: string, target: T): T {
-  if (target === null || typeof target !== 'object') {
-    return target
+export function makeStub<T>(name: string, obj: T): T {
+  if (obj === null || typeof obj !== 'object') {
+    return obj
   }
-  return new Proxy(target, {
+  return new Proxy(obj, {
     get: (target, prop) => {
       const propName = `${name}.${String(prop)}`
       if (!(prop in target) && !isStubPropAllowedUndefined(prop)) {
         const message = `Property '${propName}' does not exist`
+        // eslint-disable-next-line no-console
         console.error(message)
         throw new Error(message)
       }
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
       return makeStub(propName, (target as any)[prop])
     },
   }) as T
 }
 
 // Properties checked by jest which don't need to be defined:
-export let allowedUndefinedStubProps = [
+export const allowedUndefinedStubProps = [
   '$$typeof',
   'nodeType',
   'tagName',
@@ -566,7 +568,7 @@ export let allowedUndefinedStubProps = [
   'then',
 ]
 
-const isStubPropAllowedUndefined = (prop: string | Symbol) => {
+const isStubPropAllowedUndefined = (prop: string | symbol) => {
   if (typeof prop === 'symbol') {
     return true
   }

test/util/testing-utils.test.ts

@@ -33,8 +33,8 @@ test('accessing an absent field should throw an error', async (t) => {
 
   t.throws(
     () => {
-      // @ts-ignore
-      stub.count
+      // @ts-expect-error intended
+      t.is(stub.count, undefined)
     },
     {
       message: "Property 'stub.count' does not exist",
@@ -52,8 +52,8 @@ test('accessing a nested absent field should throw an error', async (t) => {
 
   t.throws(
     () => {
-      // @ts-ignore
-      stub.nested.name
+      // @ts-expect-error intended
+      t.is(stub.nested.name, undefined)
     },
     {
       message: "Property 'stub.nested.name' does not exist",
@@ -67,9 +67,9 @@ test('fields used by jest are allowed to be undefined', async (t) => {
     count: 5,
   })
 
-  // @ts-ignore
+  // @ts-expect-error intended
   t.is(stub.nodeType, undefined)
-  // @ts-ignore
+  // @ts-expect-error intended
   t.is(stub.tagName, undefined)
 })
 
@@ -79,7 +79,7 @@ test('Symbol props are allowed to be undefined', async (t) => {
     count: 5,
   })
 
-  // @ts-ignore
+  // @ts-expect-error intended
   t.is(stub[Symbol('my symbol')], undefined)
 })
 
@@ -93,8 +93,8 @@ test('allowedUndefinedStubProps can be extended and restored', async (t) => {
 
   t.throws(
     () => {
-      // @ts-ignore
-      stub[customProp]
+      // @ts-expect-error intended
+      t.is(stub[customProp], undefined)
     },
     {
       message: "Property 'stub.myCustomProp' does not exist",
@@ -103,15 +103,15 @@ test('allowedUndefinedStubProps can be extended and restored', async (t) => {
 
   allowedUndefinedStubProps.push('myCustomProp')
 
-  // @ts-ignore
+  // @ts-expect-error intended
   t.is(stub[customProp], undefined)
 
   allowedUndefinedStubProps.pop()
 
   t.throws(
     () => {
-      // @ts-ignore
-      stub[customProp]
+      // @ts-expect-error intended
+      t.is(stub[customProp], undefined)
     },
     {
       message: "Property 'stub.myCustomProp' does not exist",