Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: typescript migration guide #31243

Merged
merged 12 commits into from
Mar 26, 2025
Merged

docs: typescript migration guide #31243

merged 12 commits into from
Mar 26, 2025

Conversation

cacieprins
Copy link
Contributor

  • Closes

Additional details

Adds a guide for writing TypeScript and migrating JS to TS

Steps to test

How has the user experience changed?

PR Tasks

@cacieprins cacieprins marked this pull request as ready for review March 10, 2025 14:35
Copy link

cypress bot commented Mar 10, 2025

cypress    Run #61174

Run Properties:  status check failed Failed #61174  •  git commit 310f77eb1d: Merge branch 'develop' into docs/ts-upgrade-guide
Project cypress
Branch Review docs/ts-upgrade-guide
Run status status check failed Failed #61174
Run duration 18m 06s
Commit git commit 310f77eb1d: Merge branch 'develop' into docs/ts-upgrade-guide
Committer Cacie Prins
View all properties for this run ↗︎

Test results
Tests that failed  Failures 15
Tests that were flaky  Flaky 7
Tests that did not run due to a developer annotating a test with .skip  Pending 1208
Tests that did not run due to a failure in a mocha hook  Skipped 0
Tests that passed  Passing 31274
View all changes introduced in this branch ↗︎

Warning

Partial Report: The results for the Application Quality reports may be incomplete.

UI Coverage  45.87%
  Untested elements 185  
  Tested elements 161  
Accessibility  92.63%
  Failed rules  3 critical   8 serious   2 moderate   2 minor
  Failed elements 875  

Tests for review

Failed  cypress/script_utils.cy.js • 0 failed tests • 5x-driver-electron

View Output

Test Artifacts
Failed  issues/3890.cy.js • 0 failed tests • 5x-driver-electron

View Output

Test Artifacts
Failed  commands/sessions/origins.cy.ts • 0 failed tests • 5x-driver-electron

View Output

Test Artifacts
Failed  e2e/cancelation.cy.js • 0 failed tests • 5x-driver-electron

View Output

Test Artifacts
Failed  cy/skipping_sync.cy.js • 0 failed tests • 5x-driver-electron

View Output

Test Artifacts

The first 5 failed specs are shown, see all 238 specs in Cypress Cloud.

Flakiness  issues/28527.cy.ts • 1 flaky test • 5x-driver-electron

View Output

Test Artifacts
issue 28527 > fails and then retries and verifies about:blank is not displayed Test Replay Screenshots
Flakiness  commands/net_stubbing.cy.ts • 1 flaky test • 5x-driver-firefox

View Output

Test Artifacts
... > stops waiting when an xhr request is canceled
    </td>
  </tr></table>
Flakiness  issues/28527.cy.ts • 1 flaky test • 5x-driver-firefox

View Output

Test Artifacts
issue 28527 > fails and then retries and verifies about:blank is not displayed Screenshots
Flakiness  e2e/origin/cookie_login.cy.ts • 1 flaky test • 5x-driver-chrome:beta

View Output

Test Artifacts
cy.origin - cookie login > Max-Age > past max-age -> not logged in Test Replay
Flakiness  commands/waiting.cy.js • 1 flaky test • 5x-driver-chrome:beta

View Output

Test Artifacts
... > errors > does not throw again when 2nd alias doesn't reference a route Test Replay

The first 5 flaky specs are shown, see all 7 specs in Cypress Cloud.


- No unnecessary `.js` in the repository
- The repository passes linting based on the `@typescript-eslint/recommended-type-checked` rule set
- The repository uses `@eslint/stylistic` to format
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@eslint/stylistic isn't an npm module

There is a website https://eslint.style/ which refers to plugins @stylistic/eslint-plugin

A link either to the website or to an existing npm module would be clearer here

cacieprins and others added 2 commits March 14, 2025 10:34
Co-authored-by: Mike McCready <[email protected]>
Co-authored-by: Mike McCready <[email protected]>
@cacieprins cacieprins merged commit 4b140b7 into develop Mar 26, 2025
5 of 6 checks passed
@cacieprins cacieprins deleted the docs/ts-upgrade-guide branch March 26, 2025 15:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants