prune-github-notifications

Prunes GitHub notifications you don't care about, such as automated dependency bumps. 🧹

CLI

prune-github-notifications can be run on the CLI with an auth token for _notifications_ access:

``shell
npx prune-github-notifications
`

$3

| Option | Type | Default | Description |
| ------------- | ---------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| --auth | string | process.env.GH_TOKEN or executing gh auth token | Auth token for GitHub from octokit-from-auth. |
| --bandwidth | number | 6 | Maximum parallel requests to start at once. |
| --reason | string[] | ["subscribed"] | Notification reason(s) to filter to. |
| --title | string[] | ["^chore\(deps\): update .+ to", /^build\(deps-dev\): bump .+ to"] | Notification title regular expressions to filter to. |
| --watch | number | 0 | A seconds interval to continuously re-run this on, if truthy. |
| --author | string[] | - | Usernames to ignore notifications from when reason is "author". |
| --botAuthor | boolean | false | Ignore notifications from any authors with "[bot]" in their name |
| --verbose | boolean | false | Print information while processing notifications |

For example, providing all functional options on the CLI:

`shell
npx prune-github-notifications --bandwidth 10 --reason subscribed --title "^chore.+ update .+ to"
`

Running in watch mode to clear notifications every ten seconds:

`shell
npx prune-github-notifications --watch 10
`

Node.js API

`shell
npm i prune-github-notifications
`

`ts
import { pruneGitHubNotifications } from "prune-github-notifications";

await pruneGitHubNotifications({ auth: "gho_..." });
`

If a process.env.GH_TOKEN is set, then the auth parameter will default to it:

`ts
await pruneGitHubNotifications();
`

$3

Only auth is required, and only if a GH_TOKEN isn't available.

| Option | Type | Default | Description |
| ----------- | ------------- | -------------------------------------------------------------------- | -------------------------------------------------------- |
| auth | string | process.env.GH_TOKEN | GitHub authentication token with _notifications_ access. |
| bandwidth | number | 6 | Maximum parallel requests to start at once. |
| reason | Set | Set {"subscribed"} | Notification reason(s) to filter to. |
| title | RegExp[] | [/^chore\(deps\): update .+ to/, /^build\(deps-dev\): bump .+ to/] | Notification title regular expressions to filter to. |

For example, providing all options to the Node.js API:

`ts
await pruneGitHubNotifications({
auth: "gho_...",
bandwidth: 10,
reason: subscribed,
title: ["^chore.+ update .+ to"],
});
`

Development

See .github/CONTRIBUTING.md, then .github/DEVELOPMENT.md.
Thanks! 💖

Contributors

Josh Goldberg 🔧 🚧 🤔 💻 🐛

> 💙 This package was templated with create-typescript-app`.