https://github.com/kuy/acot-reporter-slack

A Slack reporter for acot.
https://github.com/kuy/acot-reporter-slack

a11y accessibility acot audit

Last synced: 16 days ago
JSON representation

A Slack reporter for acot.

• Host: GitHub
• URL: https://github.com/kuy/acot-reporter-slack
• Owner: kuy
• License: mit
• Created: 2021-04-06T14:33:01.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2023-04-22T13:41:36.000Z (almost 2 years ago)
• Last Synced: 2024-11-11T12:40:28.452Z (3 months ago)
• Topics: a11y, accessibility, acot, audit
• Language: TypeScript
• Homepage:
• Size: 153 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# acot-reporter-slack



[![CI](https://github.com/kuy/acot-reporter-slack/actions/workflows/ci.yml/badge.svg)](https://github.com/kuy/acot-reporter-slack/actions/workflows/ci.yml)

A Slack reporter for [acot](https://github.com/acot-a11y/acot).

## Usage

### Installation

Install via npm:

```bash

$ npm install --save acot-reporter-slack

```

Install via yarn:

```bash

$ yarn add acot-reporter-slack

```

### Configuration

```javascript

module.exports = {

  reporter: {

    use: "slack",

    with: {

      url: "https://hooks.slack.com/services/XXX/XXX/XXX",

    },

  },

};

```

- `url`: URL of Slack's incoming webhook **(Required)**

## Development

### TODOs

- [x] Minimum notification

- [x] Provide option to configure Slack's incoming webhook URL

- [x] Report summary by rules

- [ ] Decorate notification using [Block Kit](https://api.slack.com/block-kit)

- [ ] Options to specify events of notification

### Release

1. Bump version in `package.json`

2. Commit with message `Release x.x.x` and push to `main` branch

3. GitHub Actions publishes new version to NPM automatically