https://github.com/flotwig/cypress-log-to-output

A Cypress plugin that sends all logs that occur in the browser to stdout in the terminal.
https://github.com/flotwig/cypress-log-to-output

Last synced: about 1 month ago
JSON representation

A Cypress plugin that sends all logs that occur in the browser to stdout in the terminal.

• Host: GitHub
• URL: https://github.com/flotwig/cypress-log-to-output
• Owner: flotwig
• Created: 2019-05-09T18:01:40.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-05-08T09:06:49.000Z (about 1 year ago)
• Last Synced: 2024-05-02T01:04:39.378Z (about 2 months ago)
• Language: JavaScript
• Homepage:
• Size: 32.2 KB
• Stars: 143
• Watchers: 8
• Forks: 19
• Open Issues: 8
• Metadata Files:
  • Readme: README.md

Lists

• awesome-cypress - Cypress log to output

README

        
cypress-log-to-output

===

This is a [Cypress](https://github.com/cypress-io/cypress) plugin that sends all console logs that occur in the browser to stdout in the terminal. This means that you can see any kind of `console.log`, `console.info` or `console.error` that occurs in the browser, even if your tests are running in the terminal.

# Installation

```

npm install --save-dev cypress-log-to-output

```

# Usage

In your `cypress/plugins/index.js`, add this to your `module.exports`:

```js

module.exports = (on, config) => {

  /** the rest of your plugins... **/

  require('cypress-log-to-output').install(on)

  // or, if there is already a before:browser:launch handler, use .browserLaunchHandler inside of it

  // @see https://github.com/flotwig/cypress-log-to-output/issues/5

}

```

You'll now see all browser console logs in your terminal output.

```shell

cypress run --browser=chrome

```



Works in Chrome, Chromium, or Canary browsers during `cypress run` and `cypress open`.

**Electron is not currently supported.** I can't find a way to attach the Chrome Debugging Protocol to the Electron browser spawned by Cypress.

## Filtering Events

If you want to filter events, you can use a custom filtering callback:

```js

module.exports = (on, config) => {

  /** the rest of your plugins... **/

  require('cypress-log-to-output').install(on, (type, event) => {

    // return true or false from this plugin to control if the event is logged

    // `type` is either `console` or `browser`

    // if `type` is `browser`, `event` is an object of the type `LogEntry`:

    //  https://chromedevtools.github.io/devtools-protocol/tot/Log#type-LogEntry

    // if `type` is `console`, `event` is an object of the type passed to `Runtime.consoleAPICalled`:

    //  https://chromedevtools.github.io/devtools-protocol/tot/Runtime#event-consoleAPICalled

    // for example, to only show error events:

    if (event.level === 'error' || event.type === 'error') {

      return true

    }

    return false

  })

}

```

## Recording Logs

If you want to record the logs internally, you can use the `recordLogs` option:

```js

module.exports = (on, config) => {

  /** the rest of your plugins... **/

  const options = { recordLogs: true };

  require('cypress-log-to-output').install(on, filterCallback, options)

}

```

The logs will be stored in an internal buffer. They can be accessed using the `getLogs` exported function. 

The buffer can be cleared using the `clearLogs` exported function.

## Disabling debug info

You can remove the lines beginning with `[cypress-log-to-output]` by passing `-cypress-log-to-output` in the `DEBUG` environment variable.