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

feat: add warning about v8 snapshots to troubleshooting guide #4825

Merged
merged 6 commits into from
Nov 2, 2022
Merged
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 0 additions & 39 deletions content/guides/references/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -630,42 +630,3 @@ workaround to the relevant Cypress GitHub issue. It will help us release an
official fix faster.

</Alert>

### Edit the installed Cypress code

The installed application comes with the fully transpiled, unobfuscated
JavaScript source code that you can hack on. You might want to directly modify
the installed app code to:

- investigate a hard to recreate bug that happens on your machine
- change the run-time behavior of Cypress before opening a pull request
- have fun 🎉

First, print where the binary is installed using the
[cypress cache path](/guides/guides/command-line#cypress-cache-path) command.

For example, on a Mac:

```shell
npx cypress cache path
/Users/jane/Library/Caches/Cypress
```

Second, open the source code at the following path in any code editor. Make sure
to substitute `3.3.1` for the desired version of Cypress you want to edit.

```text
/Users/jane/Library/Caches/Cypress/3.3.1/Cypress.app/Contents/Resources/app/packages/
```

You can change anything in the JavaScript code:

<DocsImage src="/img/guides/troubleshooting/source-code.png" alt="Source code of Cypress in a text editor" ></DocsImage>
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we can remove this image as well. It doesn't seem to be referenced anywhere else.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good catch.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removed: 92e4ed8 (#4825)


When finished, if necessary, remove the edited Cypress version and reinstall the
Cypress official version to get back to the official released code.

```shell
rm -rf /Users/jane/Library/Caches/Cypress/3.3.1
npm install [email protected]
```