Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@bevry/github-contributors

bevry238Artistic-2.04.2.0TypeScript support: included

Fetch all the contributors from a github repository, github organization, or github search

browser, contributors, es2022, github, maintainers, module, node, organisation, organization, owners, package.json, typed, types, typescript, users

readme

GitHub Contributors

Status of the GitHub Workflow: bevry NPM version NPM downloads
GitHub Sponsors donate button ThanksDev donate button Patreon donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button
Discord server badge Twitch community badge

Fetch all the contributors from a github repository, github organization, or github search

Usage

Complete API Documentation.

import {
    getContributorsFromRepo,
    getContributorsFromRepos,
    getContributorsFromOrgs,
    getContributorsFromSearch,
} from '@bevry/github-contributors'

getContributorsFromRepo('bevry/github-contributors')
    .then(console.log)
    .catch(console.error)
getContributorsFromRepos(['bevry/github-contributors'])
    .then(console.log)
    .catch(console.error)

// https://developer.github.com/v3/search/#search-repositories
getContributorsFromSearch('@bevry language:typescript', { pages: 0 })
    .then(console.log)
    .catch(console.error)
getContributorsFromOrgs(['bevry'], { pages: 0 })
    .then(console.log)
    .catch(console.error)

Install

npm

  • Install: npm install --save @bevry/github-contributors
  • Import: import * as pkg from ('@bevry/github-contributors')
  • Require: const pkg = require('@bevry/github-contributors')

Skypack

<script type="module">
    import * as pkg from '//cdn.skypack.dev/@bevry/github-contributors@^4.2.0'
</script>

unpkg

<script type="module">
    import * as pkg from '//unpkg.com/@bevry/github-contributors@^4.2.0'
</script>

jspm

<script type="module">
    import * as pkg from '//dev.jspm.io/@bevry/github-contributors@4.2.0'
</script>

Editions

This package is published with the following editions:

  • @bevry/github-contributors/source/index.ts is TypeScript source code with Import for modules
  • @bevry/github-contributors/edition-browsers/index.js is TypeScript compiled against ES2022 for web browsers with Import for modules
  • @bevry/github-contributors aliases @bevry/github-contributors/edition-es2022/index.js
  • @bevry/github-contributors/edition-es2022/index.js is TypeScript compiled against ES2022 for Node.js 18 || 20 || 21 with Require for modules
  • @bevry/github-contributors/edition-es2022-esm/index.js is TypeScript compiled against ES2022 for Node.js 18 || 20 || 21 with Import for modules

History

Discover the release history by heading on over to the HISTORY.md file.

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers

Maintainers

These amazing people are maintaining this project:

Sponsors

No sponsors yet! Will you be the first?

GitHub Sponsors donate button ThanksDev donate button Patreon donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button

Contributors

These amazing people have contributed code to this project:

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

License

Unless stated otherwise all works are:

and licensed under:

changelog

History

v4.2.0 2023 November 20

v4.1.0 2023 November 1

v4.0.0 2023 November 1

v3.0.0 2021 August 5

  • Iterate/support pages
  • Renamed to @bevry/github-contributors
  • Renamed getContributorsFromCommits to getContributorsFromRepoContributorData
  • Renamed getContributorsFromPackage to getContributorsFromRepoPackageData
  • Updated for @bevry/github-api
  • Updated dependencies, base files, and editions using boundation

v2.23.0 2020 October 29

v2.22.0 2020 September 4

v2.21.0 2020 August 18

v2.20.0 2020 August 4

v2.19.0 2020 July 22

v2.18.0 2020 July 22

v2.17.0 2020 June 25

v2.16.0 2020 June 21

v2.15.0 2020 June 21

v2.14.0 2020 June 20

v2.13.0 2020 June 10

v2.12.0 2020 June 10

v2.11.0 2020 May 22

v2.10.0 2020 May 21

v2.9.0 2020 May 20

v2.8.0 2020 May 11

v2.7.0 2020 May 8

v2.6.0 2020 May 6

v2.5.2 2020 April 27

v2.5.1 2020 March 30

v2.5.0 2020 March 30

  • getContributorsFromRepo no longer hard fails
    • enables compat with new repos

v2.4.0 2020 March 27

  • Fix for multiple authors inside package.json:author

v2.3.0 2020 March 27

v2.2.0 2020 March 27

  • Export the Fellow import we are using to ensure singelton compatability

v2.1.0 2020 March 27

  • Fetch the contributor's profile information (such that we have their names), instead of just their contributor data (their usernames)

v2.0.0 2020 March 27

  • Rewrote in TypeScript with breaking API changes for simplicity as new native abilities allows us to do more with less
  • Updated dependencies, base files, and editions using boundation
  • Minimum required node version changed from node: >=8 to node: >=10 to keep up with mandatory ecosystem changes

v1.10.0 2019 December 9

  • Implemented support for GITHUB_API environment variable to access the GitHub API via a proxy
  • Updated dependencies, base files, and editions using boundation

v1.9.0 2019 November 18

v1.8.0 2019 November 13

v1.7.0 2019 November 10

v1.6.0 2019 November 9

v1.5.0 2019 September 10

v1.4.5 2017 February 28

  • Updated dependencies

v1.4.4 2017 February 28

  • Internal: explicit use of GitHub API version
  • Updated dependencies

v1.4.3 2017 February 28

  • Pass configuration over to getrepos instance like how we do with the feedr instance

v1.4.2 2017 February 27

  • Updated dependencies

v1.4.1 2017 February 24

  • Fixed rate limit errors not being caught

v1.4.0 2017 February 24

  • Converted from CoffeeScript to JavaScript
  • Fixed fetchContributorsFromPackage possibly not calling the completion callback under certain circumstances
  • Added technical API documentation
  • Updated dependencies

v1.3.7 2014 December 11

  • Updated dependencies

v1.3.6 2014 December 11

  • Updated dependencies

v1.3.5 2014 December 11

  • Updated dependencies

v1.3.4 2013 December 16

  • Added markdown field to contributor objects

v1.3.3 2013 November 27

  • Updated dependencies

v1.3.2 2013 November 25

  • Updated dependencies
  • Repackaged

v1.3.1 2013 October 3

  • Updated dependencies

v1.3.0 2013 October 2

  • Even more powerful
  • Updated dependencies

v1.2.0 2013 September 20

  • Rewrote to expose more powerful API
  • Updated dependencies

v1.1.1 2013 May 7

  • Better merging of contributor data between sources

v1.1.0 2013 May 7

  • Also fetch contributors from the GitHub API
  • Ignore repos that are forks
  • We pass our configuration onto feedr instances

v1.0.2 2013 April 11

  • Fix Cannot find module 'typeChecker'

v1.0.1 2013 April 10

  • Updated dependencies

v1.0.0 2013 March 14

  • Initial working version