https://github.com/sandoche/github-contributors-file

A javascript library to get individual file contributors from Github
https://github.com/sandoche/github-contributors-file

contributors github-contributions github-contributors javascript-library npm npm-module

Last synced: 10 days ago
JSON representation

A javascript library to get individual file contributors from Github

• Host: GitHub
• URL: https://github.com/sandoche/github-contributors-file
• Owner: sandoche
• License: mit
• Created: 2019-03-09T15:24:28.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-09T15:58:26.000Z (almost 2 years ago)
• Last Synced: 2024-10-12T14:06:21.517Z (26 days ago)
• Topics: contributors, github-contributions, github-contributors, javascript-library, npm, npm-module
• Language: JavaScript
• Homepage:
• Size: 1.23 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Github contributors file

[![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg)](/LICENSE)

[![Medium Badge](https://badgen.net/badge/icon/medium?icon=medium&label)](https://medium.com/@sandoche)

[![Twitter: sandochee](https://img.shields.io/twitter/follow/sandochee.svg?style=social)](https://twitter.com/sandochee)

A javascript library to get individual file contributors from Github.

## Feature

* Get the list of contributors for a specific file of a Github Repository

* The list contain the name, the id, the url of each contributors

## How to use

### Installation

```

npm install github-contributors-file

```

### Using it

* Import getContributors

* Use the following function `getContributors(owner, repositoryName, filePath, token).then(callbackFunction)`

* The github token is optional (but it will increase the api limitations)

* See examples below

```js

import getContributors from 'github-contributors-file';

getContributors('sandoche', 'Jekyll-webpack-boilerplate', '_i18n/en.yml').then((contributors) => {

  console.log(contributors);

  /*

  This will return

  [

    {

      avatar_url: "https://avatars2.githubusercontent.com/u/3635348?v=4"

      login: "sandoche"

      url: "https://github.com/sandoche"

    }

  ]

  */

});

getContributors('naming-convention', 'naming-convention-design', 'README.md').then((contributors) => {

  console.log(contributors);

  /*

  This will return

  [

    {

      avatar_url: "https://avatars3.githubusercontent.com/u/6988069?v=4"

      login: "patriciamayo"

      url: "https://github.com/patriciamayo"

    },

    {

      avatar_url: "https://avatars2.githubusercontent.com/u/3635348?v=4"

      login: "sandoche"

      url: "https://github.com/sandoche"

    }

  ]

  */

})

```

## Scripts

* `yarn build` or `npm run build` - produces production version of your library under the `lib` folder

* `yarn dev` or `npm run dev` - produces development version of your library and runs a watcher

* `yarn test` or `npm run test` - it runs the tests :)

* `yarn test:watch` or `npm run test:watch` - same as above but in a watch mode

## ⭐️ Show your support

Please ⭐️ this repository if this project helped you!

[![patreon.png](https://c5.patreon.com/external/logo/become_a_patron_button.png)](https://www.patreon.com/sandoche)

## 🍺 Buy me a beer 

If you like this project, feel free to donate:

* PayPal: https://www.paypal.me/kanbanote

* Bitcoin: 19JiNZ1LkMaz57tewqJaTg2hQWH4RgW4Yp

* Ethereum: 0xded81fa4624e05339924355fe3504ba9587d5419

* Monero: 43jqzMquW2q989UKSrB2YbeffhmJhbYb2Yxu289bv7pLRh4xVgMKj5yTd52iL6x1dvCYs9ERg5biHYxMjGkpSTs6S2jMyJn

* Motive: MOTIV-25T5-SD65-V7LJ-BBWRD (Get Motive Now: https://motive.network)