From 77185aee2623ee040af46d3c42b6a74a73fe5d4b Mon Sep 17 00:00:00 2001 From: Mike McCready <66998419+MikeMcC399@users.noreply.github.com> Date: Sun, 8 Sep 2024 15:03:03 +0200 Subject: [PATCH] docs: replace debug log source cypress:server:specs --- .../writing-and-organizing-tests.mdx | 4 +- docs/guides/references/configuration.mdx | 2 +- docs/guides/references/troubleshooting.mdx | 44 +++++++++---------- 3 files changed, 25 insertions(+), 25 deletions(-) diff --git a/docs/guides/core-concepts/writing-and-organizing-tests.mdx b/docs/guides/core-concepts/writing-and-organizing-tests.mdx index 736f7253e6..807b309049 100644 --- a/docs/guides/core-concepts/writing-and-organizing-tests.mdx +++ b/docs/guides/core-concepts/writing-and-organizing-tests.mdx @@ -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 diff --git a/docs/guides/references/configuration.mdx b/docs/guides/references/configuration.mdx index cc4ddd5a7b..1125cec12e 100644 --- a/docs/guides/references/configuration.mdx +++ b/docs/guides/references/configuration.mdx @@ -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 diff --git a/docs/guides/references/troubleshooting.mdx b/docs/guides/references/troubleshooting.mdx index cc9cbdabaa..eecc90f96d 100644 --- a/docs/guides/references/troubleshooting.mdx +++ b/docs/guides/references/troubleshooting.mdx @@ -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 @@ -298,25 +298,25 @@ 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: @@ -324,7 +324,7 @@ 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