https://github.com/codebender828/file-contributors
🦑 Just a function that gets individual contributors for a specific file on github.
https://github.com/codebender828/file-contributors
Last synced: about 1 year ago
JSON representation
🦑 Just a function that gets individual contributors for a specific file on github.
- Host: GitHub
- URL: https://github.com/codebender828/file-contributors
- Owner: codebender828
- Created: 2020-03-21T01:56:20.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-03-26T08:46:03.000Z (about 4 years ago)
- Last Synced: 2025-02-28T21:07:03.252Z (over 1 year ago)
- Language: TypeScript
- Homepage: https://uyl6l.csb.app/
- Size: 121 KB
- Stars: 5
- Watchers: 0
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
👩🏽💻 file-contributors 👨🏻💻
Ever wonder who's contributed to a specific file on github? `file-contributors` gives you simple way to get all contributors to a specific file on Github.
🤖 See over-engineered demo on codesandbox
### ⚡️ Installation
Install `file-contributors` from npm
```bash
npm install file-contributors --save
```
### Usage
`file-contributors` exports function that accepts 3 arguments.
- `owner` Owner of the github repository. This could be your username or organization name
- type: `String`
- `repo` Name of the repository
- type: `String`
- `path` Location of the file relative to the repository root.
- type: `String`
```js
import getFileContributors from 'file-contributors'
const file = {
owner: 'codebender828',
repo: 'file-contributors',
path: 'README.md'
}
const contributors = getFileContributors(file.owner, file.repo, file.path)
.then(contributors => {
console.log(contributors) // Logs array of contributors to file.
})
```
## ❤️ Support this project
If you like this project, please consider supporting it by buying my a coffee!
Made with ❤️ by Jonathan Bakebwa 🇺🇬