Added TypeScript type checker + Fixed type errors.

[sainthkh]

• Closes CI needs TypeScript type checker. #5772

What has been changed?

1. Added type checker done by tsc.

npm run type-check command iterates folders in packages and check if it has tsconfig.json file and runs tsc command to check if there is a type error in files. It ignores cli folder because dtslint checks the types.

It doesn't completely remove dtslint for now because it cannot check the parameter or return type of a variable.

This command is added to CI.

Command Options

• -p, --project: To list projects separated by commas (like reporter,runner).
• --skip-lib-check: --skipLibCheck of tsc.
• --ignore-progress: Ignores progress for CI. Without this, CI result looks like this.

2. Other code changes.

• Removed copying @types from cli. It causes duplicate types and creates a lot of errors. Fixed a new feature introduced in TypeScript 2.9, import('npm-module').
• Moved @types dependencies of cli from devDependencies to dependencies. Because they are used in types/index.d.ts.
• Updated packages to fix type errors.
  • @types/chai: 4.1.7 -> 4.2.5 => We're using chai@4.2, but types weren't updated.
  • typescript: 3.5.3 -> 3.7.2 => To use window.NODE definition.
  • Removed typeRoots in reporter, runner tsconfig.json files.

Additional details

• Why was this change necessary?

Currently, CI doesn't check type errors.

• What is affected by this change?

When there is a type error, CI will fail.

• Any implementation details to explain?

It uses tsc --noEmit to check errors.

How has the user experience changed?

N/A

PR Tasks

• [NA] Have tests been added/updated?
• Has the original issue been tagged with a release in ZenHub?
• [NA] Has a PR for user-facing changes been opened in cypress-documentation?
• [NA] Have API changes been updated in the type definitions?
• [NA] Have new configuration options been added to the cypress.schema.json?

[cypress-bot]

Thanks for the contribution! Below are some guidelines Cypress uses when doing PR reviews.

• Please write [WIP] in the title of your Pull Request if your PR is not ready for review - someone will review your PR as soon as the [WIP] is removed.
• Please familiarize yourself with the PR Review Checklist and feel free to make updates on your PR based on these guidelines.

PR Review Checklist

If any of the following requirements can't be met, leave a comment in the review selecting 'Request changes', otherwise 'Approve'.

User Experience

• The feature/bugfix is self-documenting from within the product.
• The change provides the end user with a way to fix their problem (no dead ends).

Functionality

• The code works and performs its intended function with the correct logic.
• Performance has been factored in (for example, the code cleans up after itself to not cause memory leaks).
• The code guards against edge cases and invalid input and has tests to cover it.

Maintainability

• The code is readable (too many nested 'if's are a bad sign).
• Names used for variables, methods, etc, clearly describe their function.
• The code is easy to understood and there are relevant comments explaining.
• New algorithms are documented in the code with link(s) to external docs (flowcharts, w3c, chrome, firefox).
• There are comments containing link(s) to the addressed issue (in tests and code).

Quality

• The change does not reimplement code.
• There's not a module from the ecosystem that should be used instead.
• There is no redundant or duplicate code.
• There are no irrelevant comments left in the code.
• Tests are testing the code’s intended functionality in the best way possible.

Internal

• The original issue has been tagged with a release in ZenHub.

[sainthkh]

Note: electron-5 fail is a flaky test.

[jennifer-shehane]

@sainthkh Some failures in the type checks

> node scripts/type_check "--ignore-progress"


desktop-gui failed
node_modules/@cypress/schema-tools/src/api.ts:449:9 - error TS2769: No overload matches this call.
  Overload 1 of 6, '(fn: (x: BindOptions) => CustomFormats | undefined, list: readonly BindOptions[]): (CustomFormats | undefined)[]', gave the following error.
    Argument of type '<T>(obj: Record<"formats", T>) => T' is not assignable to parameter of type '(x: BindOptions) => CustomFormats | undefined'.
      Types of parameters 'obj' and 'x' are incompatible.
        Type 'BindOptions' is not assignable to type 'Record<"formats", CustomFormats | undefined>'.
          Property 'formats' is optional in type 'BindOptions' but required in type 'Record<"formats", CustomFormats | undefined>'.
  Overload 2 of 6, '(fn: (x: number | BindOptions | (() => string) | { (...items: ConcatArray<BindOptions>[]): BindOptions[]; (...items: (BindOptions | ConcatArray<BindOptions>)[]): BindOptions[]; } | ... 17 more ... | (() => IterableIterator<...>)) => any, list: BindOptions[]): readonly any[]', gave the following error.
    Argument of type '<T>(obj: Record<"formats", T>) => T' is not assignable to parameter of type '(x: number | BindOptions | (() => string) | { (...items: ConcatArray<BindOptions>[]): BindOptions[]; (...items: (BindOptions | ConcatArray<BindOptions>)[]): BindOptions[]; } | ((searchElement: BindOptions, fromIndex?: number | undefined) => number) | ((searchElement: BindOptions, fromIndex?: number | undefined) => number) | ((start?: number | undefined, end?: number | undefined) => BindOptions[]) | ((searchElement: BindOptions, fromIndex?: number | undefined) => boolean) | (() => string) | (<U>(callbackfn: (value: BindOptions, index: number, array: BindOptions[]) => U, thisArg?: any) => U[]) | { <S extends BindOptions>(callbackfn: (value: BindOptions, index: number, array: BindOptions[]) => value is S, thisArg?: any): S[]; (callbackfn: (value: BindOptions, index: number, array: BindOptions[]) => unknown, thisArg?: any): BindOptions[]; } | ((callbackfn: (value: BindOptions, index: number, array: BindOptions[]) => unknown, thisArg?: any) => boolean) | ((separator?: string | undefined) => string) | ((callbackfn: (value: BindOptions, index: number, array: BindOptions[]) => unknown, thisArg?: any) => boolean) | ((callbackfn: (value: BindOptions, index: number, array: BindOptions[]) => void, thisArg?: any) => void) | { (callbackfn: (previousValue: BindOptions, currentValue: BindOptions, currentIndex: number, array: BindOptions[]) => BindOptions): BindOptions; (callbackfn: (previousValue: BindOptions, currentValue: BindOptions, currentIndex: number, array: BindOptions[]) => BindOptions, initialValue: BindOptions): BindOptions; <U>(callbackfn: (previousValue: U, currentValue: BindOptions, currentIndex: number, array: BindOptions[]) => U, initialValue: U): U; } | { (callbackfn: (previousValue: BindOptions, currentValue: BindOptions, currentIndex: number, array: BindOptions[]) => BindOptions): BindOptions; (callbackfn: (previousValue: BindOptions, currentValue: BindOptions, currentIndex: number, array: BindOptions[]) => BindOptions, initialValue: BindOptions): BindOptions; <U>(callbackfn: (previousValue: U, currentValue: BindOptions, currentIndex: number, array: BindOptions[]) => U, initialValue: U): U; } | { <S extends BindOptions>(predicate: (this: void, value: BindOptions, index: number, obj: BindOptions[]) => value is S, thisArg?: any): S | undefined; (predicate: (value: BindOptions, index: number, obj: BindOptions[]) => unknown, thisArg?: any): BindOptions | undefined; } | ((predicate: (value: BindOptions, index: number, obj: BindOptions[]) => unknown, thisArg?: any) => number) | (() => IterableIterator<[number, BindOptions]>) | (() => IterableIterator<number>) | (() => IterableIterator<BindOptions>)) => any'.
      Types of parameters 'obj' and 'x' are incompatible.
        Type 'number | BindOptions | (() => string) | { (...items: ConcatArray<BindOptions>[]): BindOptions[]; (...items: (BindOptions | ConcatArray<BindOptions>)[]): BindOptions[]; } | ((searchElement: BindOptions, fromIndex?: number | undefined) => number) | ((searchElement: BindOptions, fromIndex?: number | undefined) => number) | ((start?: number | undefined, end?: number | undefined) => BindOptions[]) | ((searchElement: BindOptions, fromIndex?: number | undefined) => boolean) | (() => string) | (<U>(callbackfn: (value: BindOptions, index: number, array: BindOptions[]) => U, thisArg?: any) => U[]) | { <S extends BindOptions>(callbackfn: (value: BindOptions, index: number, array: BindOptions[]) => value is S, thisArg?: any): S[]; (callbackfn: (value: BindOptions, index: number, array: BindOptions[]) => unknown, thisArg?: any): BindOptions[]; } | ((callbackfn: (value: BindOptions, index: number, array: BindOptions[]) => unknown, thisArg?: any) => boolean) | ((separator?: string | undefined) => string) | ((callbackfn: (value: BindOptions, index: number, array: BindOptions[]) => unknown, thisArg?: any) => boolean) | ((callbackfn: (value: BindOptions, index: number, array: BindOptions[]) => void, thisArg?: any) => void) | { (callbackfn: (previousValue: BindOptions, currentValue: BindOptions, currentIndex: number, array: BindOptions[]) => BindOptions): BindOptions; (callbackfn: (previousValue: BindOptions, currentValue: BindOptions, currentIndex: number, array: BindOptions[]) => BindOptions, initialValue: BindOptions): BindOptions; <U>(callbackfn: (previousValue: U, currentValue: BindOptions, currentIndex: number, array: BindOptions[]) => U, initialValue: U): U; } | { (callbackfn: (previousValue: BindOptions, currentValue: BindOptions, currentIndex: number, array: BindOptions[]) => BindOptions): BindOptions; (callbackfn: (previousValue: BindOptions, currentValue: BindOptions, currentIndex: number, array: BindOptions[]) => BindOptions, initialValue: BindOptions): BindOptions; <U>(callbackfn: (previousValue: U, currentValue: BindOptions, currentIndex: number, array: BindOptions[]) => U, initialValue: U): U; } | { <S extends BindOptions>(predicate: (this: void, value: BindOptions, index: number, obj: BindOptions[]) => value is S, thisArg?: any): S | undefined; (predicate: (value: BindOptions, index: number, obj: BindOptions[]) => unknown, thisArg?: any): BindOptions | undefined; } | ((predicate: (value: BindOptions, index: number, obj: BindOptions[]) => unknown, thisArg?: any) => number) | (() => IterableIterator<[number, BindOptions]>) | (() => IterableIterator<number>) | (() => IterableIterator<BindOptions>)' is not assignable to type 'Record<"formats", CustomFormats | undefined>'.
          Type 'number' is not assignable to type 'Record<"formats", CustomFormats | undefined>'.
  Overload 3 of 6, '(fn: (x: BindOptions) => CustomFormats | undefined, obj: Functor<BindOptions>): Functor<CustomFormats | undefined>', gave the following error.
    Argument of type '<T>(obj: Record<"formats", T>) => T' is not assignable to parameter of type '(x: BindOptions) => CustomFormats | undefined'.
      Types of parameters 'obj' and 'x' are incompatible.
        Type 'BindOptions' is not assignable to type 'Record<"formats", CustomFormats | undefined>'.

449     map(prop('formats'), options),
            ~~~~~~~~~~~~~~~


node_modules/@cypress/schema-tools/src/trim.ts:25:13 - error TS2322: Type 'PlainObject' is not assignable to type 'never'.

25             trimmedObj[prop] = trimBySchema(schema[prop], object[prop])
               ~~~~~~~~~~~~~~~~

node_modules/@cypress/schema-tools/src/trim.ts:27:13 - error TS2322: Type 'PlainObject[]' is not assignable to type 'never'.

27             trimmedObj[prop] = map(trimBySchema(schema[prop]), object[prop])
               ~~~~~~~~~~~~~~~~


Found 3 errors.

[sainthkh]

@jennifer-shehane They're from schema-tools. I wrote PR for that. Please check PR comment above.

[sainthkh]

1. Fixed conflicts.
2. Tests failed by flaky build.

[jennifer-shehane]

@sainthkh There's some failures from our dtslint

Error: Errors in typescript@2.9 for external dependencies:
../node_modules/@types/chai/index.d.ts(122,9): error TS8020: JSDoc types can only be used inside documentation comments.
../node_modules/@types/chai/index.d.ts(123,9): error TS8020: JSDoc types can only be used inside documentation comments.
../node_modules/@types/chai/index.d.ts(127,16): error TS2370: A rest parameter must be of an array type.

    at /root/cypress/cli/node_modules/dtslint/bin/index.js:190:19
    at Generator.next (<anonymous>)
    at fulfilled (/root/cypress/cli/node_modules/dtslint/bin/index.js:5:58)

[sainthkh]

• Merged.
• lint error is caused by @cypress-io/json-schemas
• Other failures are flaky.

[jennifer-shehane]

@sainthkh Sent an invite to give you permission to @cypress/json-schemas

[sainthkh]

Opened a PR in cypress-io/json-schemas#526.

Things to do:

• The PR merged
• json-schemas new version published
• update it in desktop-gui

[tgriesser]

@sainthkh changes should be published under 5.34.1

[sainthkh]

• Now lint-types passes.
• 2 flaky tests.

[CypressJoseph]

LGTM! 👍 I love the new type_check script

[CypressJoseph]

nitpick: stray whitespace maybe?

[sainthkh]

I might have added it to separate external dependencies and internal ones. But I think it doesn't matter to remove it.

still failing specs?

[CypressJoseph]

I needed to update dependencies, things are passing for me now! Please do fix any conflicts etc but this looks awesome 👍I will try to investigate getting the new command added to the CI flow for test-runner

specs passing now :D

[sainthkh]

@CypressJoseph I added this to CI. Or is there anything more to do?

[CypressJoseph]

That’s great! 👍 This should be good to go I think.

…

On Mon, Mar 16, 2020 at 5:52 AM Kukhyeon Heo ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In circle.yml <#5780 (comment)>: > + - run: + command: yarn type-check --ignore-progress @CypressJoseph <https://github.com/CypressJoseph> I added this to CI. Or is there anything more to do? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#5780 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AOVVUCT7CMWMSWSVKIBFZ2TRHXZHRANCNFSM4JQZIRKQ> .

[CypressJoseph]

Lgtm!! 🥂

[jennifer-shehane]

@sainthkh We're planning to merge this into develop directly after the 4.2.0 release (which is today), so we can try it out in develop without potentially blocking our release.