Description

Heart Slack is a listener module of Heart, which reacts to the end of an analysis by sending the results to a Slack channel.

Note that you must install an analysis module too, to have a minimum viable installation of Heart.

Usage

Install the package and an analysis module, for example Heart GreenIT
```
npm install @fabernovel/heart-greenit @fabernovel/heart-slack
```
If you are using Yarn, npm < 7 or PNPM < 8, you also have to install Heart CLI (which is automatically installed in more recent versions of these packages managers):
```
npm install @fabernovel/heart-cli
```
In the project root folder, create a .env file with the Slack Access token
```
HEART_SLACK_ACCESS_TOKEN=My_Slack_Access_Token
```
[Optional] Customize the Slack channel

By default the heart channel is used, but you can customize it by adding the HEART_SLACK_CHANNEL_ID variable to your .env file:
```
HEART_SLACK_CHANNEL_ID=my-custom-channel
```
Note that the channel identifier must follows the format and rules indicated in the Slack API documentation.

Start an analysis

npx heart greenit --config '{"url":"https://www.fabernovel.com"}'

npx heart greenit --config config.json

Once the analysis is done, a notification is sent to your Slack channel.

If you're using Github, you can simplify the integration of Heart in your CI scripts by using the Github Action.