https://github.com/santima10/jest-chat-reporter

🃏 A jest reporter for chats like: Twitch, Discord, etc.
https://github.com/santima10/jest-chat-reporter

jest-reporter twitch-chat

Last synced: 1 day ago
JSON representation

🃏 A jest reporter for chats like: Twitch, Discord, etc.

• Host: GitHub
• URL: https://github.com/santima10/jest-chat-reporter
• Owner: SantiMA10
• License: cc-by-4.0
• Created: 2022-03-23T17:10:14.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-04-08T09:51:03.000Z (over 2 years ago)
• Last Synced: 2024-08-08T17:30:45.215Z (3 months ago)
• Topics: jest-reporter, twitch-chat
• Language: TypeScript
• Homepage:
• Size: 216 KB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# 🃏 @santima10/jest-chat-reporter [![node](https://github.com/SantiMA10/jest-chat-reporter/actions/workflows/node.yml/badge.svg)](https://github.com/SantiMA10/jest-chat-reporter/actions/workflows/node.yml) [![Publish](https://github.com/SantiMA10/jest-chat-reporter/actions/workflows/publish.yml/badge.svg)](https://github.com/SantiMA10/jest-chat-reporter/actions/workflows/publish.yml)

⚠️⚠️ This package is still under development ⚠️⚠️

> A jest reporter for chats like: Twitch, Discord, etc.

## 🛠 Configuration

### 🟣 Twitch



1. Install the package in your project with your favorite package manager.

2. In your `jest.config.js` file:

  ```js

  {

    //...

    reporters: [

        'default',

        [

          '@santima10/jest-chat-reporter',

          {

            channels: [], // an array with the twitch channels names the report is going to send messages

            username: '', // an string with the username for the twitch chat

            password: '', // an string with the oauth2 token for the twitch chat

            messagesOnWatchMode: false, // report or not test results to twitch in watch mode (default false)

            onlyCI: false // report or not test results to twitch only on CI environments (default false)

            useAnnounce: false // uses the /announce command in the Twitch Chat (default false) (needs moderator role)

          },

        ],

      ],

    //...

  }

  ```

  

## ✨ Inspiration

- [jest-plugin-yeelight](https://github.com/heedrox/jest-plugin-yeelight)

- [Slack jest reporter](https://github.com/BrunoScheufler/blog-code-examples/tree/master/custom-jest-reporter)

## 👀 How has this project been built?

Great question, we have a [playlist](https://www.youtube.com/watch?v=qe7IE8qdo6U&list=PLokEg24KkXH06UsAYxBZkOJ1YJsBKLRlk) with all the videos of how the project was build (in spanish)

## 🐛 Known issues

Sometimes jest cannot finish the process correctly ([more info in the issue](https://github.com/SantiMA10/jest-chat-reporter/issues/4)), until we solve the problem you can use the flag `--forceExit`.