1.0.3 • Published 6 years ago
gittie v1.0.3
Description
Gittie allows you to receive lists by your repository by individual selection criteria, based on the programming language, privacy and having no open issues. In a similar scheme, you can receive lists of pull requests, making a selection for example only on repositories, where the main language is javascript.
Documentaion
Initialize
const Gittie = require('gittie');
const gittie = new Gittie('token', 'organization name');You can get token from defined before, or create new token there.
Methods
All method return promise. You can use
.then .catchorasync awaitsyntax..getRepositories
Get repositories from your org.
params
param type description example language StringFilter repositories by language. getRepositories({ language: 'JavaScript' })isPrivate BooleanFilter repositories by private status. getRepositories({ isPrivate: false })isWithIssues BooleanFilter repositories with issues and pull requests. getRepositories({ isWithIssues: true })Return array with repositories.
.getPullRequests
Get pull requests from single repository.
params
| param | type | required | description | example |
|---|---|---|---|---|
| repository | String | true | Name of repository, from get pull requests. | getPullRequests('foo', {}) |
| labels | Array | false | Filter pull requests by labels. Only pull requests with all labels from array is included. | getPullRequests('foo', { labels: ['foo', 'bar', 'baz'] }) |
| author | String | false | Filter pull requests by author. | getPullRequests('foo', {author: 'foo'}) |
| state | String | false | Available values - 'open', 'closed' | getPullRequests('foo', {state: 'open'}) |
.getMultiPullRequests
Get pull requests from multiple repositories.
.getMultiPullRequests(repoParams, prParams)
repoParams Object
| param | type | description | example |
|---|---|---|---|
| repos | Array | List of repositories name, from where you want get pull requests | getMultiPullRequests({repos: ['foo', 'bar', 'baz']}) |
| language | String | Filter repositories by language. | getRepositories({ language: 'JavaScript' }) |
| isPrivate | Boolean | Filter repositories by private status. | getRepositories({ isPrivate: false }) |
| isWithIssues | Boolean | Filter repositories with issues and pull requests. | getRepositories({ isWithIssues: true }) |
prParams Object
| param | type | description | example |
|---|---|---|---|
| labels | Array | Filter pull requests by labels. Only pull requests with all labels from array is included. | getPullRequests('foo', { labels: ['foo', 'bar', 'baz'] }) |
| author | String | Filter pull requests by author. | getPullRequests('foo', {author: 'foo'}) |
| state | String | Available values - 'open', 'closed' | getPullRequests('foo', {state: 'open'}) |
Examples
const Gittie = require('gittie');
const gittie = new Gittie('kjY38fQjsdf1128dA', 'pseudoOrg');
// Get repositories
gittie.getRepositories({
isPrivate: false,
isWithIssues: true,
language: 'Python'
}).then(repos => console.log(repos)).catch(err => console.log(err));
// Get pull requests
gittie.getPullRequest('repo', {
labels: ['help wanted', 'bugfix'],
author: 'foo',
state: 'open'
}).then(prs => console.log(prs)).catch(err => console.log(err));
// Get multi pull requests
gittie.getMultiPullRequests({
language: 'javascript'
}, {
labels: ['help wanter'],
state: 'open'
}).then(prs => console.log(prs)).catch(err => console.log(err));Installation
yarn add gittie