# spr

> Utility with some goodies to create Github pull requests

Latest version **0.1.0** (published 2015-03-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install spr
pnpm add spr
yarn add spr
bun add spr
```

Provides the command `spr`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2015-03-29 |
| First published | 2015-03-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 17 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Farruco Sanjurjo |
| Maintainers | farruco.sanjurjo |

## Links

- npm: https://www.npmjs.com/package/spr
- npm.io page: https://npm.io/package/spr

## Dependencies (17)

- [gh](https://npm.io/package/gh.md) ^1.10.1
- [temp](https://npm.io/package/temp.md) ^0.8.1
- [gitty](https://npm.io/package/gitty.md) ^3.1.4
- [yargs](https://npm.io/package/yargs.md) ^3.6.0
- [editor](https://npm.io/package/editor.md) ^0.1.0
- [extend](https://npm.io/package/extend.md) ^2.0.0
- [github](https://npm.io/package/github.md) ^0.2.3
- [tracer](https://npm.io/package/tracer.md) ^0.7.3
- [bluebird](https://npm.io/package/bluebird.md) ^2.9.12
- [home-dir](https://npm.io/package/home-dir.md) ^1.0.0
- [revalidator](https://npm.io/package/revalidator.md) ^0.3.1
- [es6-iterator](https://npm.io/package/es6-iterator.md) ^0.1.3
- [lodash.compact](https://npm.io/package/lodash.compact.md) ^3.0.0
- [lodash.flatten](https://npm.io/package/lodash.flatten.md) ^3.0.1
- [lodash.partial](https://npm.io/package/lodash.partial.md) ^3.0.0
- [lodash.isobject](https://npm.io/package/lodash.isobject.md) ^3.0.0
- [lodash.isfunction](https://npm.io/package/lodash.isfunction.md) ^3.0.1

## Recent versions

- 0.1.0 (latest) — 2015-03-29
- 0.0.2 — 2015-03-16
- 0.0.1 — 2015-03-16

## README

# SPR

`spr` is a small command line utility that includes some goodies to streamline the creation of pull requests in Github.


## Installation

```
npm install -g spr
```

## Usage

```bash
$spr -h

Options:
  -b, --base      Specify the base branch to merge the pull request into
  -h, --help      This help
  -v, --verbose   Be verbose
  -t, --template  Path to template to be used in pull request description
```

### Configuration

`spr` needs some configuration properties to run. It'll look for a file in `$HOME/.spr` which the following structure:

```json
$cat $HOME/.spr

{
  "credentials": {
    "github": {
      "type": "oauth",
      "token": ""
    }
  }
}
```

You can read [this article](https://help.github.com/articles/creating-an-access-token-for-command-line-use/) about how to create Github oauth tokens for command line use.

### Plugins
Extend `spr`'s functionallity including some of the available plugins. To include a plugin add it to the list on its configuration file. A plugin can be included using its name or an object in case yo need to pass some configuration values to it. Below there's an example:

```
$ cat $HOME/.spr
{
  ...
  "plugins": [
    "spr-changelog",
    "spr-assign",
    {
      "package": "spr-target-process",
      "config": {
          "domain": "",
          "username": "",
          "password": ""
        }
    }
  ]
}

```
#### Existing plugins

* [spr-target-process](https://github.com/madtrick/spr-target-process). Include the id of a TP ticket in the PR description and comment on TP entities
* [spr-assign](https://github.com/madtrick/spr-assign). Assign the pull request to someone
* [spr-changelog](https://github.com/madtrick/spr-changelo). Include the upcoming changes in the pull request description

---
_Source: https://npm.io/package/spr · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._