https://github.com/bahmutov/cypress-failed-email

A beautifully formatted and helpful email when Cypress test fails
https://github.com/bahmutov/cypress-failed-email

cypress email

Last synced: 6 days ago
JSON representation

A beautifully formatted and helpful email when Cypress test fails

• Host: GitHub
• URL: https://github.com/bahmutov/cypress-failed-email
• Owner: bahmutov
• Created: 2017-01-30T21:52:22.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-01-30T22:33:19.000Z (almost 8 years ago)
• Last Synced: 2024-12-27T20:52:15.412Z (28 days ago)
• Topics: cypress, email
• Language: JavaScript
• Size: 4.88 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# cypress-failed-email

> A beautifully formatted and helpful email when Cypress test fails

[![NPM][npm-icon] ][npm-url]

[![Build status][ci-image] ][ci-url]

[![semantic-release][semantic-image] ][semantic-url]

[![js-standard-style][standard-image]][standard-url]

If you run [Cypress.io](https://www.cypress.io/) to check your front end,

and collect failing test information using

[cypress-failed-log](https://github.com/bahmutov/cypress-failed-log), you can

send beautiful and helpful emails on individual test failures.

## Use

```sh

npm i -D cypress-failed-email

```

Then from your test failure code

```js

const {formEmail} = require('cypress-failed-email')

const filename = process.argv[2]

//> failed-test.json for example

const failed = require(filename)

const email = formEmail(failed)

//> email is object with text fields {subject, plainText}

```

### Small print

Author: Gleb Bahmutov <[email protected]> © 2017

* [@bahmutov](https://twitter.com/bahmutov)

* [glebbahmutov.com](http://glebbahmutov.com)

* [blog](http://glebbahmutov.com/blog)

License: MIT - do anything with the code, but don't blame me if it does not work.

Support: if you find any problems with this module, email / tweet /

[open issue](https://github.com/bahmutov/cypress-failed-email/issues) on Github

## MIT License

Copyright (c) 2017 Gleb Bahmutov <[email protected]>

Permission is hereby granted, free of charge, to any person

obtaining a copy of this software and associated documentation

files (the "Software"), to deal in the Software without

restriction, including without limitation the rights to use,

copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the

Software is furnished to do so, subject to the following

conditions:

The above copyright notice and this permission notice shall be

included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES

OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT

HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,

WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR

OTHER DEALINGS IN THE SOFTWARE.

[npm-icon]: https://nodei.co/npm/cypress-failed-email.svg?downloads=true

[npm-url]: https://npmjs.org/package/cypress-failed-email

[ci-image]: https://travis-ci.org/bahmutov/cypress-failed-email.svg?branch=master

[ci-url]: https://travis-ci.org/bahmutov/cypress-failed-email

[semantic-image]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg

[semantic-url]: https://github.com/semantic-release/semantic-release

[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

[standard-url]: http://standardjs.com/