chore: Remove pkg/driver //@ts-nocheck part 3 (#19837)

Co-authored-by: Emily Rohrbough <[email protected]>
Co-authored-by: Zach Bloomquist <[email protected]>

Author: 3 people

packages/driver/src/config/jquery.ts

@@ -1,11 +1,17 @@
-// @ts-nocheck
-
-import $ from 'jquery'
+import JQuery from 'jquery'
 import _ from 'lodash'
 
 import { scrollTo } from './jquery.scrollto'
 import $dom from '../dom'
 
+// Add missing types.
+interface ExtendedJQueryStatic extends JQueryStatic {
+  find: any
+  expr: JQuery.Selectors & { filters: any }
+}
+
+const $: ExtendedJQueryStatic = JQuery as any
+
 // force jquery to have the same visible
 // and hidden logic as cypress
 

packages/driver/src/cy/commands/actions/check.ts

@@ -1,4 +1,3 @@
-// @ts-nocheck
 import _ from 'lodash'
 import Promise from 'bluebird'
 
@@ -7,7 +6,7 @@ import $utils from '../../../cypress/utils'
 import $errUtils from '../../../cypress/error_utils'
 import $elements from '../../../dom/elements'
 
-const checkOrUncheck = (Cypress, cy, type, subject, values = [], userOptions = {}) => {
+const checkOrUncheck = (Cypress, cy, type, subject, values: any[] = [], userOptions = {}) => {
   // we're not handling conversion of values to strings
   // in case we've received numbers
 
@@ -18,15 +17,15 @@ const checkOrUncheck = (Cypress, cy, type, subject, values = [], userOptions = {
     values = []
   } else {
     // make sure we're an array of values
-    values = [].concat(values)
+    values = ([] as any[]).concat(values)
   }
 
   // keep an array of subjects which
   // are potentially reduced down
   // to new filtered subjects
-  const matchingElements = []
+  const matchingElements: HTMLElement[] = []
 
-  const options = _.defaults({}, userOptions, {
+  const options: Record<string, any> = _.defaults({}, userOptions, {
     $el: subject,
     log: true,
     force: false,
@@ -75,7 +74,7 @@ const checkOrUncheck = (Cypress, cy, type, subject, values = [], userOptions = {
       matchingElements.push(el)
     }
 
-    const consoleProps = {
+    const consoleProps: Record<string, any> = {
       'Applied To': $dom.getElements($el),
       'Elements': $el.length,
     }

packages/driver/src/cy/commands/actions/trigger.ts

@@ -1,5 +1,3 @@
-// @ts-nocheck
-
 import _ from 'lodash'
 import Promise from 'bluebird'
 
@@ -59,7 +57,7 @@ export default (Commands, Cypress, cy, state, config) => {
 
       ({ options: userOptions, position, x, y } = $actionability.getPositionFromArguments(positionOrX, y, userOptions))
 
-      const options = _.defaults({}, userOptions, {
+      const options: Record<string, any> = _.defaults({}, userOptions, {
         log: true,
         $el: subject,
         bubbles: true,

packages/driver/src/cy/commands/actions/type.ts

@@ -1,4 +1,3 @@
-// @ts-nocheck
 import _ from 'lodash'
 import Promise from 'bluebird'
 
@@ -15,7 +14,11 @@ const debug = debugFn('cypress:driver:command:type')
 export default function (Commands, Cypress, cy, state, config) {
   const { keyboard } = cy.devices
 
-  function type (subject, chars, options = {}) {
+  // Note: These "change type of `any` to X" comments are written instead of changing them directly
+  //       because Cypress extends user-given options with Cypress internal options.
+  //       These comments will be removed after removing `// @ts-nocheck` comments in `packages/driver`.
+  // TODO: change the type of `any` to `Partial<Cypress.TypeOptions>`
+  function type (subject, chars, options: any = {}) {
     const userOptions = options
     let updateTable
 
@@ -366,7 +369,7 @@ export default function (Commands, Cypress, cy, state, config) {
             // Firefox sends a click event automatically.
             if (!Cypress.isBrowser('firefox')) {
               const ctor = $dom.getDocumentFromElement(el).defaultView?.PointerEvent
-              const event = new ctor('click')
+              const event = new ctor!('click')
 
               el.dispatchEvent(event)
             }
@@ -510,7 +513,8 @@ export default function (Commands, Cypress, cy, state, config) {
     })
   }
 
-  function clear (subject, options = {}) {
+  // TODO: change the type of `any` to `Partial<ClearOptions>`
+  function clear (subject, options: any = {}) {
     const userOptions = options
 
     options = _.defaults({}, userOptions, {

packages/driver/src/cy/commands/connectors.ts

@@ -1,13 +1,11 @@
-// @ts-nocheck
-
 import _ from 'lodash'
 import Promise from 'bluebird'
 
 import $dom from '../../dom'
 import $utils from '../../cypress/utils'
-import $errUtils from '../../cypress/error_utils'
+import $errUtils, { CypressError } from '../../cypress/error_utils'
 
-const returnFalseIfThenable = (key, ...args) => {
+const returnFalseIfThenable = (key, ...args): boolean => {
   if ((key === 'then') && _.isFunction(args[0]) && _.isFunction(args[1])) {
     // https://github.com/cypress-io/cypress/issues/111
     // if we're inside of a promise then the promise lib will naturally
@@ -22,6 +20,8 @@ const returnFalseIfThenable = (key, ...args) => {
 
     return false
   }
+
+  return true
 }
 
 const primitiveToObject = (memo) => {
@@ -181,7 +181,7 @@ export default function (Commands, Cypress, cy, state) {
 
   const invokeFn = (subject, userOptionsOrStr, ...args) => {
     const userOptionsPassed = _.isObject(userOptionsOrStr) && !_.isFunction(userOptionsOrStr)
-    let userOptions = null
+    let userOptions: Record<string, any> | null = null
     let str = null
 
     if (!userOptionsPassed) {
@@ -219,7 +219,7 @@ export default function (Commands, Cypress, cy, state) {
 
     const message = getMessage()
 
-    let traversalErr = null
+    let traversalErr: CypressError | null = null
 
     // copy userOptions because _log is added below.
     const options = _.extend({}, userOptions)
@@ -568,7 +568,7 @@ export default function (Commands, Cypress, cy, state) {
           return ret
         }
 
-        return thenFn(el, userOptions, callback, state)
+        return thenFn(el, userOptions, callback)
       }
 
       // generate a real array since bluebird is finicky and
@@ -586,9 +586,9 @@ export default function (Commands, Cypress, cy, state) {
   // cy.resolve + cy.wrap are upgraded to handle
   // promises
   Commands.addAll({ prevSubject: 'optional' }, {
-    then () {
+    then (subject, userOptions, fn) {
       // eslint-disable-next-line prefer-rest-params
-      return thenFn.apply(this, arguments)
+      return thenFn.apply(this, [subject, userOptions, fn])
     },
   })
 

packages/driver/src/cy/commands/cookies.ts

@@ -1,5 +1,3 @@
-// @ts-nocheck
-
 import _ from 'lodash'
 import Promise from 'bluebird'
 
@@ -110,7 +108,7 @@ export default function (Commands, Cypress, cy, state, config) {
     })
   }
 
-  const getAndClear = (log, timeout, options = {}) => {
+  const getAndClear = (log?, timeout?, options = {}) => {
     return automateCookies('get:cookies', options, log, timeout)
     .then((resp) => {
     // bail early if we got no cookies!
@@ -166,7 +164,8 @@ export default function (Commands, Cypress, cy, state, config) {
   })
 
   return Commands.addAll({
-    getCookie (name, options = {}) {
+    // TODO: change the type of `any` to `Partial<Cypress.Loggable & Cypress.Timeoutable>`
+    getCookie (name, options: any = {}) {
       const userOptions = options
 
       options = _.defaults({}, userOptions, {
@@ -212,7 +211,8 @@ export default function (Commands, Cypress, cy, state, config) {
       .catch(handleBackendError('getCookie', 'reading the requested cookie from', onFail))
     },
 
-    getCookies (options = {}) {
+    // TODO: change the type of `any` to `Partial<Cypress.Loggable & Cypress.Timeoutable>`
+    getCookies (options: any = {}) {
       const userOptions = options
 
       options = _.defaults({}, userOptions, {
@@ -250,7 +250,8 @@ export default function (Commands, Cypress, cy, state, config) {
       .catch(handleBackendError('getCookies', 'reading cookies from', options._log))
     },
 
-    setCookie (name, value, options = {}) {
+    // TODO: change the type of `any` to `Partial<Cypress.SetCookieOptions>`
+    setCookie (name, value, options: any = {}) {
       const userOptions = options
 
       options = _.defaults({}, userOptions, {
@@ -331,7 +332,8 @@ export default function (Commands, Cypress, cy, state, config) {
       }).catch(handleBackendError('setCookie', 'setting the requested cookie in', onFail))
     },
 
-    clearCookie (name, options = {}) {
+    // TODO: change the type of `any` to `Partial<Cypress.Loggable & Cypress.Timeoutable>`
+    clearCookie (name, options: any = {}) {
       const userOptions = options
 
       options = _.defaults({}, userOptions, {
@@ -380,7 +382,8 @@ export default function (Commands, Cypress, cy, state, config) {
       .catch(handleBackendError('clearCookie', 'clearing the requested cookie in', onFail))
     },
 
-    clearCookies (options = {}) {
+    // TODO: change the type of `any` to `Partial<Cypress.Loggable & Cypress.Timeoutable>`
+    clearCookies (options: any = {}) {
       const userOptions = options
 
       options = _.defaults({}, userOptions, {

packages/driver/src/cy/commands/exec.ts

@@ -1,13 +1,12 @@
-// @ts-nocheck
-
 import _ from 'lodash'
 import Promise from 'bluebird'
 
 import $errUtils from '../../cypress/error_utils'
 
 export default (Commands, Cypress, cy) => {
   Commands.addAll({
-    exec (cmd, options = {}) {
+    // TODO: change the type of `any` to `Partical<Cypress.ExecOptions>`
+    exec (cmd, options: any = {}) {
       const userOptions = options
 
       options = _.defaults({}, userOptions, {

packages/driver/src/cy/commands/files.ts

@@ -1,12 +1,12 @@
-// @ts-nocheck
 import _ from 'lodash'
 import { basename } from 'path'
 
 import $errUtils from '../../cypress/error_utils'
 
 export default (Commands, Cypress, cy, state) => {
   Commands.addAll({
-    readFile (file, encoding, options = {}) {
+    // TODO: change the type of `any` to `Partial<Cypress.Loggable & Cypress.Timeoutable>`
+    readFile (file, encoding, options: any = {}) {
       let userOptions = options
 
       if (_.isObject(encoding)) {
@@ -109,7 +109,8 @@ export default (Commands, Cypress, cy, state) => {
       return verifyAssertions()
     },
 
-    writeFile (fileName, contents, encoding, options = {}) {
+    // TODO: change the type of `any` to `Partial<Cypress.WriteFileOPtions & Cypress.Timeoutable>`
+    writeFile (fileName, contents, encoding, options: any = {}) {
       let userOptions = options
 
       if (_.isObject(encoding)) {

packages/driver/src/cy/commands/fixtures.ts

@@ -1,5 +1,3 @@
-// @ts-nocheck
-
 import _ from 'lodash'
 import Promise from 'bluebird'
 import { basename } from 'path'
@@ -44,7 +42,7 @@ export default (Commands, Cypress, cy, state, config) => {
         return Promise.resolve(clone(resp))
       }
 
-      let options = {}
+      let options: Record<string, any> = {}
 
       if (_.isObject(args[0])) {
         options = args[0]

packages/driver/src/cy/commands/location.ts

@@ -1,5 +1,3 @@
-// @ts-nocheck
-
 import _ from 'lodash'
 import Promise from 'bluebird'
 
@@ -8,7 +6,8 @@ const { throwErrByPath } = $errUtils
 
 export default (Commands, Cypress, cy) => {
   Commands.addAll({
-    url (options = {}) {
+    // TODO: change the type of `any` to `Partial<Cypress.UrlOptions>`
+    url (options: any = {}) {
       const userOptions = options
 
       options = _.defaults({}, userOptions, { log: true })
@@ -39,7 +38,8 @@ export default (Commands, Cypress, cy) => {
       return resolveHref()
     },
 
-    hash (options = {}) {
+    // TODO: change the type of `any` to `Partial<Cypress.Loggable & Cypress.Timeoutable>`
+    hash (options: any = {}) {
       const userOptions = options
 
       options = _.defaults({}, userOptions, { log: true })

packages/driver/src/cy/commands/misc.ts

@@ -1,4 +1,3 @@
-// @ts-nocheck
 import _ from 'lodash'
 import Promise from 'bluebird'
 
@@ -50,7 +49,8 @@ export default (Commands, Cypress, cy, state) => {
       return null
     },
 
-    wrap (arg, options = {}) {
+    // TODO: change the type of `any` to `Partial<Cypress.Loggable & Cypress.Timeoutable>`
+    wrap (arg, options: any = {}) {
       const userOptions = options
 
       options = _.defaults({}, userOptions, {