Added TypeScript type checker + Fixed type errors. #5780

sainthkh · 2019-11-23T08:58:06Z

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 [email protected], 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 · 2019-11-23T08:58:09Z

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 · 2019-11-25T06:54:22Z

Note: electron-5 fail is a flaky test.

jennifer-shehane · 2019-11-27T08:34:59Z

@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 · 2019-11-27T09:17:06Z

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

sainthkh · 2019-11-28T02:56:07Z

Fixed conflicts.
Tests failed by flaky build.

copy of chai is unnecessary.

jennifer-shehane · 2020-01-10T07:31:25Z

@sainthkh There's some failures from our dtslint

Error: Errors in [email protected] 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 · 2020-03-09T02:30:02Z

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

jennifer-shehane · 2020-03-11T04:00:58Z

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

sainthkh · 2020-03-12T23:19:35Z

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 · 2020-03-13T01:59:12Z

@sainthkh changes should be published under 5.34.1

sainthkh · 2020-03-13T04:04:02Z

Now lint-types passes.
2 flaky tests.

CypressJoseph

LGTM! 👍 I love the new type_check script

CypressJoseph · 2020-03-13T16:03:54Z

packages/reporter/src/hooks/hook-model.spec.ts

@@ -1,4 +1,5 @@
 import sinon from 'sinon'
+


nitpick: stray whitespace maybe?

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

# Conflicts: # yarn.lock

sainthkh · 2020-03-16T09:52:40Z

circle.yml

+      - run:
+          command: yarn type-check --ignore-progress


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

CypressJoseph · 2020-03-16T13:42:26Z

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 · 2020-03-16T15:11:06Z

@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.

sainthkh changed the title ~~wip Type check TypeScript codes.~~ Added TypeScript type checker. Nov 25, 2019

sainthkh marked this pull request as ready for review November 25, 2019 06:53

sainthkh changed the title ~~Added TypeScript type checker.~~ Added TypeScript type checker + Fixed type errors. Nov 26, 2019

sainthkh force-pushed the issue-5772 branch from 150c713 to fb713fe Compare November 28, 2019 01:45

sainthkh added 18 commits December 4, 2019 15:00

Added type_check.js

7b22fd9

Now checks cli, too.

6c048a3

Ignored a line that should fail.

7ca7cc8

Removed cli shims and post-install.

cbba9f4

Updated @types/chai to fix type error.

d4bbda9

Fixed keyboard type errors.

62a669f

Updated typescript to 3.7.2 to fix window.Node error in dom/document.

1789497

Removed tsconfig errors that caused type errors in reporter and runner.

b3a3b9e

Ignored error test by dtslint. Becaust it's done by type_check.js

c3611e0

Added npm command.

3014542

Added it to CI.

c7d3bf7

Added skipLibCheck option.

5921006

Removed checking chai folder existence.

7c78434

copy of chai is unnecessary.

Added 'ignore-progress' option for CI.

972a295

Show success message when type check is finished successfully.

7c85c27

Use ignore-progress option on CI.

1d3c0b2

Moved type definitions from devDependencies to dependencies.

64e4beb

Fixed new type errors after rebase.

68cbba8

sainthkh force-pushed the issue-5772 branch from fb713fe to 68cbba8 Compare December 4, 2019 06:08

Merge branch 'develop' into issue-5772

19df9fb

bahmutov and others added 2 commits March 5, 2020 11:19

Merge branch 'develop' into issue-5772

2da2ecc

Merge branch 'develop' into issue-5772

d6be2d1

sainthkh force-pushed the issue-5772 branch from 0ce8eb2 to d6be2d1 Compare March 9, 2020 00:44

sainthkh added 2 commits March 13, 2020 11:22

Fix type error.

0c50c77

Merge remote-tracking branch 'upstream/develop' into issue-5772

a1a6344

sainthkh force-pushed the issue-5772 branch from f6824bb to a1a6344 Compare March 13, 2020 02:33

Fix type failures.

5fc7cb5

sainthkh force-pushed the issue-5772 branch from 18c64b0 to 5fc7cb5 Compare March 13, 2020 03:26

jennifer-shehane requested a review from CypressJoseph March 13, 2020 10:23

CypressJoseph previously approved these changes Mar 13, 2020

View reviewed changes

CypressJoseph self-requested a review March 13, 2020 19:57

CypressJoseph previously approved these changes Mar 13, 2020

View reviewed changes

Merge branch 'develop' into issue-5772-ts-checks

9faec67

# Conflicts: # yarn.lock

jennifer-shehane dismissed CypressJoseph’s stale review via 9faec67 March 16, 2020 09:29

sainthkh commented Mar 16, 2020

View reviewed changes

Merge branch 'develop' into issue-5772

a6dae5f

CypressJoseph approved these changes Mar 16, 2020

View reviewed changes

jennifer-shehane merged commit ee494d0 into cypress-io:develop Mar 17, 2020

cypress-bot bot mentioned this pull request Mar 17, 2020

CI needs TypeScript type checker. #5772

Closed

jennifer-shehane mentioned this pull request Mar 23, 2020

Failing in develop Cypress pre-release bahmutov/cypress-hyperapp-unit-test#250

Closed

jennifer-shehane mentioned this pull request Apr 20, 2020

Upgrading Cypress from 4.0.1 to 4.3.0 results in conflicting jquery typedefs #7063

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added TypeScript type checker + Fixed type errors. #5780

Added TypeScript type checker + Fixed type errors. #5780

sainthkh commented Nov 23, 2019 •

edited

Loading

cypress-bot bot commented Nov 23, 2019

sainthkh commented Nov 25, 2019

jennifer-shehane commented Nov 27, 2019

sainthkh commented Nov 27, 2019 •

edited

Loading

sainthkh commented Nov 28, 2019

jennifer-shehane commented Jan 10, 2020

sainthkh commented Mar 9, 2020

jennifer-shehane commented Mar 11, 2020

sainthkh commented Mar 12, 2020 •

edited

Loading

tgriesser commented Mar 13, 2020

sainthkh commented Mar 13, 2020

CypressJoseph left a comment

CypressJoseph Mar 13, 2020

sainthkh Mar 14, 2020

CypressJoseph left a comment

sainthkh Mar 16, 2020

CypressJoseph commented Mar 16, 2020 via email

CypressJoseph left a comment

jennifer-shehane commented Mar 16, 2020

Added TypeScript type checker + Fixed type errors. #5780

Added TypeScript type checker + Fixed type errors. #5780

Conversation

sainthkh commented Nov 23, 2019 • edited Loading

What has been changed?

1. Added type checker done by tsc.

2. Other code changes.

Additional details

How has the user experience changed?

PR Tasks

cypress-bot bot commented Nov 23, 2019

PR Review Checklist

User Experience

Functionality

Maintainability

Quality

Internal

sainthkh commented Nov 25, 2019

jennifer-shehane commented Nov 27, 2019

sainthkh commented Nov 27, 2019 • edited Loading

sainthkh commented Nov 28, 2019

jennifer-shehane commented Jan 10, 2020

sainthkh commented Mar 9, 2020

jennifer-shehane commented Mar 11, 2020

sainthkh commented Mar 12, 2020 • edited Loading

tgriesser commented Mar 13, 2020

sainthkh commented Mar 13, 2020

CypressJoseph left a comment

Choose a reason for hiding this comment

CypressJoseph Mar 13, 2020

Choose a reason for hiding this comment

sainthkh Mar 14, 2020

Choose a reason for hiding this comment

CypressJoseph left a comment

Choose a reason for hiding this comment

sainthkh Mar 16, 2020

Choose a reason for hiding this comment

CypressJoseph commented Mar 16, 2020 via email

CypressJoseph left a comment

Choose a reason for hiding this comment

jennifer-shehane commented Mar 16, 2020

sainthkh commented Nov 23, 2019 •

edited

Loading

1. Added type checker done by `tsc`.

sainthkh commented Nov 27, 2019 •

edited

Loading

sainthkh commented Mar 12, 2020 •

edited

Loading