getcontributors

Get Contributors

Fetch all the contributors of all the specified github users repositories

Install

npm

• Install: npm install --save getcontributors
• Require: require('getcontributors')

Editions

This package is published with the following editions:

• getcontributors aliases getcontributors/source/index.js
• getcontributors/source/index.js is esnext source code with require for modules

Environments older than Node.js v8 may need Babel's Polyfill or something similar.

TypeScript

This project provides its type information via inline JSDoc Comments. To make use of this in TypeScript, set your maxNodeModuleJsDepth compiler option to 5 or thereabouts. You can accomlish this via your tsconfig.json file like so:

{
  "compilerOptions": {
    "maxNodeModuleJsDepth": 5
  }
}

Usage

API Documentation.

// Create our getcontributors instance
var getter = require('getcontributors').create({
    log: console.log // optional, arguments: level, message...
})

// Fetch all the contributors on these github repositories
getter.fetchContributorsFromRepos(['bevry/getcontributors'], function(
    err,
    contributors
) {
    console.log(err, contributors)

    // Fetch all the contributors on these github users/organisations
    getter.fetchContributorsFromUsers(['bevry'], function(err, contributors) {
        console.log(err, contributors)

        // Get the combined listing
        console.log(getter.getContributors())
    })
})

Contributors are returned as an array of contributor objects, here is an example contributor object:

{
	name: "Benjamin Lupton",
	email: "[e-mail]",
	url: "https://github.com/balupton",
	username: "balupton",
	text: "Benjamin Lupton <[e-mail]> (https://github.com/balupton)",
	repos: {
		"bevry/docpad": "https://github.com/bevry/docpad",
		"bevry/getcontributors": "https://github.com/bevry/getcontributors"
		// ...
	}
}

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:

• Benjamin Lupton — view contributions

Sponsors

No sponsors yet! Will you be the first?

Contributors

These amazing people have contributed code to this project:

• Benjamin Lupton — view contributions

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

License

Unless stated otherwise all works are:

• Copyright © 2013+ Bevry Pty Ltd

and licensed under:

• MIT License