feat: add acot-reporter-github

README.md

@@ -142,10 +142,11 @@ acot has a feature which is divided into several packages.
 
 ### Reporters
 
-| Package                                                        | Description                                      |
-| :------------------------------------------------------------- | :----------------------------------------------- |
-| [@acot/acot-reporter-pretty](./packages/acot-reporter-pretty/) | An acot default reporter.                        |
-| [@acot/acot-reporter-dot](./packages/acot-reporter-dot/)       | A dot reporter for [@acot/cli](./packages/cli/). |
+| Package                                                        | Description                                       |
+| :------------------------------------------------------------- | :------------------------------------------------ |
+| [@acot/acot-reporter-pretty](./packages/acot-reporter-pretty/) | An acot default reporter.                         |
+| [@acot/acot-reporter-dot](./packages/acot-reporter-dot/)       | A dot reporter for [@acot/cli](./packages/cli/).  |
+| [@acot/acot-reporter-github](./packages/acot-reporter-github/) | GitHub reporter for [@acot/cli](./packages/cli/). |
 
 ### Utilities
 

packages/acot-reporter-github/.gitignore

@@ -0,0 +1 @@
+/lib

packages/acot-reporter-github/README.md

@@ -0,0 +1,41 @@
+# @acot/acot-reporter-github
+
+GitHub reporter for `@acot/cli`.
+
+## Installation
+
+Install via npm:
+
+```bash
+$ npm install --save @acot/acot-reporter-github
+```
+
+## Prerequisites
+
+There are a few necessary setups for integrating acot with GitHub.
+
+1. Install the [acot-a11y GitHub App](https://github.com/apps/acot-a11y) in the repository where you want to use GitHub integration.
+1. Generate a token for GitHub integration from the [token manager application](https://gh-app.acot.dev).
+
+## Usage
+
+```javascript
+module.exports = {
+  reporter: {
+    use: '@acot/github',
+    with: {
+      token: '...',
+    },
+  },
+};
+```
+
+### Pass the token as an environment variable
+
+If you pass a token to the `ACOT_GITHUB_APP_TOKEN` environment variable, the GitHub reporter will automatically resolve the token for you. It is one technique to avoid writing the token directly into the configuration file.
+
+```javascript
+module.exports = {
+  reporter: '@acot/github',
+};
+```

packages/acot-reporter-github/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@acot/acot-reporter-github",
+  "version": "0.0.1",
+  "description": "GitHub reporter for @acot/cli.",
+  "homepage": "https://github.com/acot-a11y/acot/tree/main/packages/acot-reporter-github",
+  "bugs": {
+    "url": "https://github.com/acot-a11y/acot/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/acot-a11y/acot.git",
+    "directory": "packages/acot-reporter-github"
+  },
+  "license": "MIT",
+  "author": "wadackel <wadackel@gmail.com>",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "files": [
+    "lib",
+    "!__mocks__",
+    "!__tests__"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "test": "jest"
+  },
+  "jest": {
+    "preset": "ts-jest",
+    "rootDir": "src",
+    "testEnvironment": "node",
+    "testMatch": [
+      "**/__tests__/**/*.test.ts?(x)"
+    ]
+  },
+  "dependencies": {
+    "@acot/reporter": "0.0.13",
+    "@acot/schema-validator": "0.0.13",
+    "@sinclair/typebox": "^0.23.2",
+    "chalk": "^4.0.0",
+    "debug": "^4.3.1",
+    "env-ci": "6.0.0",
+    "got": "11.8.3"
+  },
+  "devDependencies": {
+    "@acot/factory": "0.0.13",
+    "@acot/mock": "0.0.13",
+    "@acot/types": "0.0.13",
+    "@types/env-ci": "^3.1.1",
+    "nock": "^13.2.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}