All Contributors For Repository
Generates an allcontributors list for an existing repository.
๐ค
## Usage
```shell
npm i all-contributors-for-repository
```
```ts
import { getAllContributorsForRepository } from "all-contributors-for-repository";
const contributors = await getAllContributorsForRepository({
owner: "JoshuaKGoldberg",
repo: "create-typescript-app",
});
/*
{
john_reilly: [ 'bug', 'code' ],
joshuakgoldberg: [ 'maintenance', 'tool' ],
}
*/
console.log(contributors);
```
> **Warning**
> This tool only sees contributions that can be detected from the last 500 events in GitHub's API.
> Don't forget to manually add in other forms of contributions!
The types of contributions detected from the GitHub API are:
- ๐ `bug`: anybody who filed an issue labeled as accepting PRs and a bug _(see [Options](#options))_
- ๐ `doc`: authors of merged PRs that address issues labeled as accepting PRs and docs _(see [Options](#options))_
- ๐ง `maintenance`: adding labels to issues and PRs, and merging PRs
- ๐ `review`: submitting a review for a PR
- ๐ง `tool`: authors of merged PRs that address issues labeled as accepting PRs and tooling _(see [Options](#options))_
Additionally, based on PR [conventional commit titles](https://www.conventionalcommits.org/en/v1.0.0/#summary) in the [Angular convention](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#type), for all PR authors and co-authors:
- `build` and `ci`: will be treated as an `:infra:` contribution
- `docs`: will be treated as an `:doc:` contribution
- `test`: will be treated as an `:test:` contribution
- All other PRs -including those without a conventional title- will be treated as `:code:` contributions
> ๐ก Given that list of contributors, you might want to run `all-contributors add` on each contributor & contribution type.
>
> ```ts
> import { $ } from "execa";
>
> for (const [contributor, contributions] of Object.entries(contributors)) {
> const contributionTypes = Object.keys(contributions).join(",");
> await $`npx all-contributors add ${contributor} ${contributionTypes}`;
> }
> ```
>
> See [populate-all-contributors-for-repository](https://github.com/JoshuaKGoldberg/populate-all-contributors-for-repository) for a project that does just that.
> ๐
### Options
The exported `getAllContributorsForRepository` function takes in an object with two required properties:
- `owner` _(`string`)_: The owner of the repository to query, such as `"JoshuaKGoldberg"`.
- `repository` _(`string`)_: The name of the repository to query, such as `"all-contributors-for-repository"`.
It additionally allows for the following optional options.
- `auth` _(`string`)_: GitHub auth token to query the API with, if necessary for private repositories and/or to avoid rate limiting.
- `ignoredLogins` _(`RegExp[]`)_: Regular expressions for usernames to ignore commits from, such as bot users.
- Default: `[/\[bot\]$/i, /^allcontributors$/i, /^copilot$/i, /^dependabot$/i, /^renovate$/i]`
- `labelAcceptingPrs` _(`string`)_: Label to indicate an issue is accepting pull requests.
- `labelTypeBug` _(`string`)_: Label to indicate an issue is for a bug.
- `labelTypeDocs` _(`string`)_: Label to indicate an issue is for documentation.
- `labelTypeIdeas` _(`string`)_: Label to indicate an issue is for a feature.
- `labelTypeTool` _(`string`)_: Label to indicate an issue is for tooling.
```ts
import { getAllContributorsForRepository } from "all-contributors-for-repository";
getAllContributorsForRepository({
auth: "abc123",
ignoredLogins: [/-it$/i],
labelAcceptingPrs: "help wanted",
labelTypeBug: "bug",
labelTypeDocs: "docs",
labelTypeIdeas: "feature",
labelTypeTool: "tool",
});
```
## Development
See [`.github/CONTRIBUTING.md`](./.github/CONTRIBUTING.md), then [`.github/DEVELOPMENT.md`](./.github/DEVELOPMENT.md).
Thanks! ๐ค
## Contributors
> ๐ This package was templated with [`create-typescript-app`](https://github.com/JoshuaKGoldberg/create-typescript-app) using the [Bingo framework](https://create.bingo).
