build: switch to ESLint from TSLint (via @hover/javascript)

Author: jrolfs

.eslintrc.js

@@ -0,0 +1,9 @@
+const { overrides, ...config } = require('@hover/javascript/eslint')
+
+module.exports = {
+  ...config,
+  ignorePatterns: ['dom-testing-library.js', 'rollup.input.js'],
+  parserOptions: {
+    project: ['tsconfig.json', 'tsconfig.eslint.json'],
+  },
+}

.travis.yml

@@ -20,8 +20,7 @@ before_script:
   - yarn add -D "playwright@${PLAYWRIGHT_OVERRIDE_VERSION}"
 script:
   - yarn rebuild
-  - yarn test:lint
-  - yarn test:unit --coverage --runInBand --verbose
+  - yarn validate
 after_success:
   - cat coverage/lcov.info | coveralls || echo 'Failed to upload to coveralls...'
 

jest.config.js

@@ -1,8 +1,7 @@
+const config = require('@hover/javascript/jest')
+
 module.exports = {
+  ...config,
   collectCoverageFrom: ['**/*.ts', '!**/*.d.ts'],
-  transform: {
-    '\\.ts$': 'ts-jest',
-  },
-  moduleFileExtensions: ['ts', 'js', 'json'],
-  testMatch: ['**/*.test.ts'],
+  coverageThreshold: {},
 }

test/__snapshots__/extend.test.ts.snap renamed to lib/__tests__/__snapshots__/extend.ts.snap

@@ -7,7 +7,7 @@ describe('lib/extend.ts', () => {
   let document: playwright.ElementHandle
 
   it('should require without error', async () => {
-    await import('../lib/extend')
+    await import('../extend')
   })
 
   it('should launch playwright', async () => {
@@ -54,7 +54,7 @@ describe('lib/extend.ts', () => {
 
     try {
       await scope!.getByTitle('missing')
-      fail()
+      fail() // eslint-disable-line jest/no-jasmine-globals
     } catch (err) {
       err.message = err.message.replace(/(\s*at .*(\n|$))+/gm, '\n    <stack>:X:X')
       expect(err.message).toMatchSnapshot()

test/extend.test.ts renamed to lib/__tests__/extend.ts

@@ -1,6 +1,6 @@
 import * as path from 'path'
 import * as playwright from 'playwright'
-import {getDocument, queries, getQueriesForElement, wait} from '../lib'
+import {getDocument, queries, getQueriesForElement, wait} from '..'
 
 describe('lib/index.ts', () => {
   let browser: playwright.Browser
@@ -37,6 +37,7 @@ describe('lib/index.ts', () => {
 
   it('should use `wait` properly', async () => {
     const {getByText} = getQueriesForElement(await getDocument(page))
+    // eslint-disable-next-line @typescript-eslint/no-misused-promises
     await wait(() => getByText('Loaded!'), {timeout: 7000})
     expect(await getByText('Loaded!')).toBeTruthy()
   }, 9000)

test/fixtures/late-page.html renamed to lib/__tests__/fixtures/late-page.html

@@ -1,13 +1,17 @@
+/* eslint-disable func-names, global-require, import/no-dynamic-require */
+
 import {getDocument, getQueriesForElement} from '.'
 import {ElementHandle, IScopedQueryUtils} from './typedefs'
 
-// tslint:disable-next-line
-let Page, ElementHandle
+let Page
+let ElementHandle // eslint-disable-line no-redeclare
 
 function requireOrUndefined(path: string): any {
   try {
     return require(path)
-  } catch (err) {}
+  } catch (err) {
+    return null
+  }
 }
 
 try {
@@ -18,15 +22,15 @@ try {
   if (ElementHandle && ElementHandle.ElementHandle) ElementHandle = ElementHandle.ElementHandle
 
   Page.prototype.getDocument = getDocument
-  getQueriesForElement(ElementHandle.prototype, function(this: ElementHandle): ElementHandle {
+  getQueriesForElement(ElementHandle.prototype, function (this: ElementHandle): ElementHandle {
     return this
   })
 
-  ElementHandle.prototype.getQueriesForElement = function(this: ElementHandle): ElementHandle {
+  ElementHandle.prototype.getQueriesForElement = function (this: ElementHandle): ElementHandle {
     return getQueriesForElement(this)
   }
 } catch (err) {
-  // tslint:disable-next-line
+  // eslint-disable-next-line no-console
   console.error('Could not augment playwright functions, do you have a conflicting version?')
   throw err
 }

test/fixtures/page.html renamed to lib/__tests__/fixtures/page.html

@@ -31,27 +31,30 @@ type DOMReturnType = ElementHandle | ElementHandle[] | null
 
 type ContextFn = (...args: any[]) => ElementHandle
 
+async function createElementHandle(handle: JSHandle): Promise<ElementHandle | null> {
+  const element = handle.asElement()
+  if (element) return element
+  await handle.dispose()
+  return null
+}
+
 async function createElementHandleArray(handle: JSHandle): Promise<ElementHandle[]> {
   const lengthHandle = await handle.getProperty('length')
   const length = (await lengthHandle.jsonValue()) as number
 
   const elements: ElementHandle[] = []
+
+  /* eslint-disable no-plusplus, no-await-in-loop */
   for (let i = 0; i < length; i++) {
     const jsElement = await handle.getProperty(i.toString())
     const element = await createElementHandle(jsElement)
     if (element) elements.push(element)
   }
+  /* eslint-enable no-plusplus, no-await-in-loop */
 
   return elements
 }
 
-async function createElementHandle(handle: JSHandle): Promise<ElementHandle | null> {
-  const element = handle.asElement()
-  if (element) return element
-  await handle.dispose()
-  return null // tslint:disable-line
-}
-
 async function covertToElementHandle(handle: JSHandle, asArray: boolean): Promise<DOMReturnType> {
   return asArray ? createElementHandleArray(handle) : createElementHandle(handle)
 }
@@ -89,15 +92,17 @@ function createDelegateFor<T = DOMReturnType>(
   processHandleFn?: (handles: IHandleSet) => Promise<T>,
 ): (...args: any[]) => Promise<T> {
   // @ts-ignore
+  // eslint-disable-next-line no-param-reassign
   processHandleFn = processHandleFn || processQuery
 
   const convertRegExp = (regex: RegExp) => ({regex: regex.source, flags: regex.flags})
 
-  return async function(...args: any[]): Promise<T> {
+  return async function (...args: any[]): Promise<T> {
     // @ts-ignore
     const containerHandle: ElementHandle = contextFn ? contextFn.apply(this, args) : this
 
     // @ts-ignore
+    // eslint-disable-next-line no-new-func, @typescript-eslint/no-implied-eval
     const evaluateFn = new Function('container, [fnName, ...args]', delegateFnBodyToExecuteInPage)
 
     // Convert RegExp to a special format since they don't serialize well
@@ -132,6 +137,7 @@ export function getQueriesForElement<T>(
   contextFn?: ContextFn,
 ): T & IQueryUtils & IScopedQueryUtils {
   const o = object as any
+  // eslint-disable-next-line no-param-reassign
   if (!contextFn) contextFn = () => o
 
   const functionNames: Array<keyof IQueryUtils> = [