Skip to content

Commit

Permalink
docs: replace debug log source cypress:server:specs
Browse files Browse the repository at this point in the history
  • Loading branch information
@MikeMcC399
MikeMcC399 committed Sep 8, 2024
1 parent dcdac07 commit 77185ae
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 25 deletions.
4 changes: 2 additions & 2 deletions docs/guides/core-concepts/writing-and-organizing-tests.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -380,9 +380,9 @@ its logic by opening or running Cypress with
[debug logs](/guides/references/troubleshooting#Print-DEBUG-logs) enabled:

```shell
DEBUG=cypress:server:specs npx cypress open
DEBUG=cypress:cli,cypress:data-context:sources:FileDataSource,cypress:data-context:sources:ProjectDataSource npx cypress open
## or
DEBUG=cypress:server:specs npx cypress run
DEBUG=cypress:cli,cypress:data-context:sources:FileDataSource,cypress:data-context:sources:ProjectDataSource npx cypress run
```

## Writing tests
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/references/configuration.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -707,7 +707,7 @@ project's folder. If the specs are still missing, run Cypress with
following setting to see how Cypress is looking for spec files:

```shell
DEBUG=cypress:cli,cypress:server:specs
DEBUG=cypress:cli,cypress:data-context:sources:FileDataSource,cypress:data-context:sources:ProjectDataSource
```

## History
Expand Down
44 changes: 22 additions & 22 deletions docs/guides/references/troubleshooting.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -285,8 +285,8 @@ There are several levels of `DEBUG` messages
DEBUG=cypress:server ...
## prints ALL messages from server package
DEBUG=cypress:server* ...
## prints messages only from config parsing
DEBUG=cypress:server:config ...
## prints messages only from project base operations
DEBUG=cypress:server:project ...
```

This allows you to isolate the problem a little better
Expand All @@ -298,33 +298,33 @@ server, reporter, driver, command line, etc. Each package writes debug logs
under a different source. Here are a few common log sources and when you might
want to enable them

| Set `DEBUG` to value | To enable debugging |
| ------------------------------- | ------------------------------------------------------------- |
| `cypress:cli` | The top-level command line parsing problems |
| `cypress:server:args` | Incorrect parsed command line arguments |
| `cypress:server:specs` | Not finding the expected specs |
| `cypress:server:project` | Opening the project |
| `cypress:server:browsers` | Finding installed browsers |
| `cypress:launcher` | Launching the found browser |
| `cypress:server:video` | Video recording |
| `cypress:network:*` | Adding network interceptors |
| `cypress:net-stubbing*` | Network interception in the proxy layer |
| `cypress:server:reporter` | Problems with test reporters |
| `cypress:server:preprocessor` | Processing specs |
| `cypress:server:socket-e2e` | Watching spec files |
| `cypress:server:task` | Invoking the `cy.task()` command |
| `cypress:server:socket-base` | Debugging `cy.request()` command |
| `cypress:webpack` | Bundling specs using webpack |
| `cypress:server:fixture` | Loading fixture files |
| `cypress:server:record:ci-info` | Git commit and CI information when recording to Cypress Cloud |
| Set `DEBUG` to value | To enable debugging |
| -------------------------------- | ------------------------------------------------------------- |
| `cypress:cli` | The top-level command line parsing problems |
| `cypress:server:args` | Incorrect parsed command line arguments |
| `cypress:data-context:sources:*` | Not finding the expected project data |
| `cypress:server:project` | Opening the project |
| `cypress:server:browsers` | Finding installed browsers |
| `cypress:launcher` | Launching the found browser |
| `cypress:server:video` | Video recording |
| `cypress:network:*` | Adding network interceptors |
| `cypress:net-stubbing*` | Network interception in the proxy layer |
| `cypress:server:reporter` | Problems with test reporters |
| `cypress:server:preprocessor` | Processing specs |
| `cypress:server:socket-e2e` | Watching spec files |
| `cypress:server:task` | Invoking the `cy.task()` command |
| `cypress:server:socket-base` | Debugging `cy.request()` command |
| `cypress:webpack` | Bundling specs using webpack |
| `cypress:server:fixture` | Loading fixture files |
| `cypress:server:record:ci-info` | Git commit and CI information when recording to Cypress Cloud |

You can combine several areas together using the comma character. For example,
to debug specs not being found, use:

```shell
## see how CLI arguments were parsed
## and how Cypress tried to locate spec files
DEBUG=cypress:cli,cypress:server:specs npx cypress run --spec ...
DEBUG=cypress:cli,cypress:data-context:sources:FileDataSource,cypress:data-context:sources:ProjectDataSource npx cypress run --spec ...
```

You can also exclude a log source using `-` character. For example, to see all
Expand Down

0 comments on commit 77185ae

Please sign in to comment.