fix: revive type checker (#18172)

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

Author: sainthkh

cli/package.json

@@ -74,7 +74,7 @@
     "@types/jquery": "3.3.31",
     "@types/lodash": "4.14.168",
     "@types/minimatch": "3.0.3",
-    "@types/mocha": "5.2.7",
+    "@types/mocha": "8.0.3",
     "@types/sinon": "7.5.1",
     "@types/sinon-chai": "3.2.5",
     "chai": "3.5.0",

cli/scripts/post-install.js

@@ -5,6 +5,7 @@
 
 const { includeTypes } = require('./utils')
 const shell = require('shelljs')
+const fs = require('fs')
 const { join } = require('path')
 const resolvePkg = require('resolve-pkg')
 
@@ -72,3 +73,23 @@ shell.sed('-i', 'from \'sinon\';', 'from \'../sinon\';', sinonChaiFilename)
 // copy experimental network stubbing type definitions
 // so users can import: `import 'cypress/types/net-stubbing'`
 shell.cp(resolvePkg('@packages/net-stubbing/lib/external-types.ts'), 'types/net-stubbing.ts')
+
+// https://github.com/cypress-io/cypress/issues/18069
+// To avoid type clashes, some files should be commented out entirely by patch-package
+// and uncommented here.
+
+const filesToUncomment = [
+  'mocha/index.d.ts',
+  'jquery/JQuery.d.ts',
+  'jquery/legacy.d.ts',
+  'jquery/misc.d.ts',
+]
+
+filesToUncomment.forEach((file) => {
+  const filePath = join(__dirname, '../types', file)
+  const str = fs.readFileSync(filePath).toString()
+
+  const result = str.split('\n').map((line) => line.substring(3)).join('\n')
+
+  fs.writeFileSync(filePath, result)
+})

cli/types/cy-bluebird.d.ts

@@ -1,11 +1,12 @@
 // Shim definition to export a namespace. Cypress is actually a global module
 // so import/export isn't allowed there. We import here and define a global module
 // so that Cypress can get and use the Blob type
-import BluebirdStatic = require('./bluebird')
+import ImportedBluebird = require('./bluebird')
 
 export = Bluebird
 export as namespace Bluebird
 
 declare namespace Bluebird {
-  type BluebirdStatic = typeof BluebirdStatic
+  type BluebirdStatic = typeof ImportedBluebird
+  interface Promise<T> extends ImportedBluebird<T> {}
 }

cli/types/cypress.d.ts

@@ -170,6 +170,11 @@ declare namespace Cypress {
    */
   interface ApplicationWindow { } // tslint:disable-line
 
+  /**
+   * The configuration for Cypress.
+   */
+  type Config = ResolvedConfigOptions & RuntimeConfigOptions
+
   /**
    * Several libraries are bundled with Cypress by default.
    *
@@ -297,7 +302,7 @@ declare namespace Cypress {
     /**
      * Fire automation:request event for internal use.
      */
-    automation(eventName: string, ...args: any[]): Promise<any>
+    automation(eventName: string, ...args: any[]): Bluebird.Promise<any>
 
     /**
      * Promise wrapper for certain internal tasks.
@@ -313,7 +318,7 @@ declare namespace Cypress {
     // {defaultCommandTimeout: 10000, pageLoadTimeout: 30000, ...}
     ```
      */
-    config(): ResolvedConfigOptions & RuntimeConfigOptions
+    config(): Config
     /**
      * Returns one configuration value.
      * @see https://on.cypress.io/config

npm/create-cypress-tests/src/component-testing/babel/babelTransform.test.ts

@@ -1,3 +1,5 @@
+/// <reference path="../../../../../cli/types/mocha/index.d.ts" />
+
 import * as babel from '@babel/core'
 import { expect } from 'chai'
 import { createTransformPluginsFileBabelPlugin } from './babelTransform'

npm/cypress-schematic/src/schematics/ng-add/index.spec.ts

@@ -1,3 +1,5 @@
+/// <reference path="../../../../../cli/types/mocha/index.d.ts" />
+
 import { SchematicTestRunner, UnitTestTree } from '@angular-devkit/schematics/testing'
 import { join, resolve } from 'path'
 import { expect } from 'chai'

package.json

@@ -90,7 +90,7 @@
     "@types/glob": "7.1.1",
     "@types/lodash": "4.14.168",
     "@types/markdown-it": "0.0.9",
-    "@types/mini-css-extract-plugin": "1.4.2",
+    "@types/mini-css-extract-plugin": "1.2.3",
     "@types/mocha": "8.0.3",
     "@types/node": "14.14.31",
     "@types/prismjs": "1.16.0",
@@ -165,7 +165,7 @@
     "mock-fs": "4.9.0",
     "odiff-bin": "2.1.0",
     "parse-github-repo-url": "1.4.1",
-    "patch-package": "6.2.2",
+    "patch-package": "6.4.7",
     "plist": "3.0.1",
     "pluralize": "8.0.0",
     "postinstall-postinstall": "2.0.0",

packages/desktop-gui/src/main.scss.d.ts

@@ -0,0 +1,7 @@
+// This file is automatically generated.
+// Please do not change this file!
+interface CssExports {
+
+}
+export const cssExports: CssExports;
+export default cssExports;

packages/driver/cypress/integration/dom/visibility_spec.ts

@@ -1,3 +1,4 @@
+// @ts-ignore
 const { $, dom } = Cypress
 
 describe('src/cypress/dom/visibility', () => {

packages/driver/index.d.ts

@@ -1,6 +1,7 @@
 /// <reference path="../../cli/types/index.d.ts" />
-/// <reference path="../ts/index.d.ts" />
+/// <reference path="../../cli/types/jquery/index.d.ts" />
+
 export const $Cypress: Cypress.Cypress
 
-export const $: typeof JQuery
+export const $: JQuery
 export default $Cypress

packages/driver/index.ts

@@ -1,3 +1,15 @@
+/// <reference path="../../cli/types/chai-jquery/index.d.ts" />
+/// <reference path="../../cli/types/sinon-chai/index.d.ts" />
+/// <reference path="../../cli/types/cypress-expect.d.ts" />
+
+/// <reference path="../ts/index.d.ts" />
+
+declare global {
+  interface Window {
+    Cypress: Cypress.Cypress
+  }
+}
+
 import $Cypress from './src/main'
 
 export default $Cypress

packages/driver/package.json

@@ -26,8 +26,10 @@
     "@sinonjs/fake-timers": "7.0.2",
     "@types/chalk": "^2.2.0",
     "@types/common-tags": "^1.8.0",
+    "@types/jquery.scrollto": "1.4.29",
     "@types/lodash": "^4.14.168",
     "@types/mocha": "^8.0.3",
+    "@types/underscore.string": "0.0.38",
     "angular": "1.8.0",
     "basic-auth": "2.0.1",
     "blob-util": "2.0.2",

packages/driver/src/config/jquery.scrollto.ts

@@ -8,6 +8,8 @@
  * @version 2.1.3
  */
 
+/// <reference types="jquery.scrollto" />
+
 /** eslint-disable */
 import $ from 'jquery'
 
@@ -109,7 +111,7 @@ export function scrollTo (target, duration, settings) {
       let max = $scrollTo.max(elem, axis)
 
       if (toff) { // jQuery / DOMElement
-        attr[key] = toff[pos] + (win ? 0 : prev - $elem.offset()[pos])
+        attr[key] = toff[pos] + (win ? 0 : prev - $elem.offset()![pos])
 
         // If it's a dom element, reduce the margin
         if (settings.margin) {
@@ -192,18 +194,25 @@ function both (val) {
   return isFunction(val) || $.isPlainObject(val) ? val : { top: val, left: val }
 }
 
+// TODO: find the type of _last in the JQuery code.
+interface Tween extends JQuery.Tween<JQuery.Node> {
+  _last: any
+}
+
 // Add special hooks so that window scroll properties can be animated
 $.Tween.propHooks.scrollLeft =
 $.Tween.propHooks.scrollTop = {
   get (t) {
     return $(t.elem)[t.prop]()
   },
-  set (t) {
+  set (t: Tween) {
     let curr = this.get(t)
 
     // If interrupt is true and user scrolled, stop animating
     if (t.options.interrupt && t._last && t._last !== curr) {
-      return $(t.elem).stop()
+      $(t.elem).stop()
+
+      return
     }
 
     let next = Math.round(t.now)

packages/driver/src/config/lodash.ts

@@ -10,3 +10,12 @@ _.mixin({
 })
 
 export default _
+
+declare module 'lodash' {
+  interface LoDashStatic {
+    clean: typeof clean
+    count: typeof count
+    isBlank: typeof isBlank
+    toBoolean: typeof toBoolean
+  }
+}

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

@@ -33,10 +33,21 @@ const formatMouseEvents = (events) => {
   })
 }
 
+// TODO: remove any, Function, Record
+type MouseActionOptions = {
+  subject: any
+  positionOrX: string | number
+  y: number
+  userOptions: Record<string, any>
+  onReady: Function
+  onTable: Function
+  defaultOptions?: Record<string, any>
+}
+
 export default (Commands, Cypress, cy, state, config) => {
   const { mouse, keyboard } = cy.devices
 
-  const mouseAction = (eventName, { subject, positionOrX, y, userOptions, onReady, onTable, defaultOptions }) => {
+  const mouseAction = (eventName, { subject, positionOrX, y, userOptions, onReady, onTable, defaultOptions }: MouseActionOptions) => {
     let position
     let x
 

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

@@ -7,7 +7,8 @@ import $elements from '../../../dom/elements'
 
 export default (Commands, Cypress, cy) => {
   return Commands.addAll({ prevSubject: ['element', 'window'] }, {
-    focus (subject, options = {}) {
+    // TODO: any -> Partial<Cypress.Loggable & Cypress.Timeoutable>
+    focus (subject, options: any = {}) {
       const userOptions = options
 
       // we should throw errors by default!
@@ -84,7 +85,8 @@ export default (Commands, Cypress, cy) => {
       return verifyAssertions()
     },
 
-    blur (subject, options = {}) {
+    // TODO: any -> Partial<Cypress.BlurOptions>
+    blur (subject, options: any = {}) {
       const userOptions = options
 
       // we should throw errors by default!

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

@@ -30,7 +30,8 @@ const isNaNOrInfinity = (item) => {
 
 export default (Commands, Cypress, cy, state) => {
   Commands.addAll({ prevSubject: 'element' }, {
-    scrollIntoView (subject, options = {}) {
+    // TODO: any -> Partial<Cypress.ScrollToOptions>
+    scrollIntoView (subject, options: any = {}) {
       const userOptions = options
 
       if (!_.isObject(userOptions)) {
@@ -114,6 +115,9 @@ export default (Commands, Cypress, cy, state) => {
       const scrollIntoView = () => {
         return new Promise((resolve, reject) => {
           // scroll our axes
+          // TODO: done() came from jQuery animate(), specifically, EffectsOptions at misc.d.ts
+          // The type definition should be fixed at @types/jquery.scrollto.
+          // @ts-ignore
           return $(options.$parent).scrollTo(options.$el, {
             axis: options.axis,
             easing: options.easing,
@@ -132,7 +136,7 @@ export default (Commands, Cypress, cy, state) => {
             },
             always () {
               if (parentIsWin) {
-                return delete options.$parent.contentWindow
+                delete options.$parent.contentWindow
               }
             },
           })
@@ -153,7 +157,8 @@ export default (Commands, Cypress, cy, state) => {
   })
 
   Commands.addAll({ prevSubject: ['optional', 'element', 'window'] }, {
-    scrollTo (subject, xOrPosition, yOrOptions, options = {}) {
+    // TODO: any -> Partial<Cypress.ScrollToOptions>
+    scrollTo (subject, xOrPosition, yOrOptions, options: any = {}) {
       let x; let y
       let userOptions = options
 
@@ -168,7 +173,7 @@ export default (Commands, Cypress, cy, state) => {
         y = yOrOptions
       }
 
-      let position = null
+      let position: string | null = null
 
       // we may be '50%' or 'bottomCenter'
       if (_.isString(xOrPosition)) {
@@ -293,7 +298,7 @@ export default (Commands, Cypress, cy, state) => {
           $utils.filterOutOptions(options, { duration: 0, easing: 'swing' }),
         )
 
-        const messageArgs = []
+        const messageArgs: string[] = []
 
         if (position) {
           messageArgs.push(position)
@@ -306,12 +311,12 @@ export default (Commands, Cypress, cy, state) => {
           messageArgs.push(deltaOptions)
         }
 
-        const log = {
+        const log: Record<string, any> = {
           message: messageArgs.join(', '),
           timeout: options.timeout,
           consoleProps () {
             // merge into consoleProps without mutating it
-            const obj = {}
+            const obj: Record<string, any> = {}
 
             if (position) {
               obj.Position = position
@@ -357,10 +362,16 @@ export default (Commands, Cypress, cy, state) => {
       const scrollTo = () => {
         return new Promise((resolve, reject) => {
           // scroll our axis'
+          // TODO: done() came from jQuery animate(), specifically, EffectsOptions at misc.d.ts
+          // The type definition should be fixed at @types/jquery.scrollto.
+          // @ts-ignore
           $(options.$el).scrollTo({ left: x, top: y }, {
             axis: options.axis,
             easing: options.easing,
             duration: options.duration,
+            // TODO: ensureScrollable option does not exist on jQuery or config/jquery.scrollto.ts.
+            // It can be removed.
+            // @ts-ignore
             ensureScrollable: options.ensureScrollable,
             done () {
               return resolve(options.$el)
@@ -376,7 +387,7 @@ export default (Commands, Cypress, cy, state) => {
           })
 
           if (isWin) {
-            return delete options.$el.contentWindow
+            delete options.$el.contentWindow
           }
         })
       }