Contents

# SIP validator
[![Gem](https://img.shields.io/gem/v/sip_validator.svg?style=flat)](http://rubygems.org/gems/sip_validator "View this project in Rubygems")


## Validation rules

### Mandatory fields

- sip or sccp
- title
- author
- status
- created

### Optional fields

- discussions-to
- layer
- replaces
- requires
- resolution
- review-period-end
- superseded-by
- updated

### Mandatory values

- `status` must be 'WIP', 'Proposed', 'Approved', 'Implemented', or 'Rejected'
## Prerequisite

- ruby

## Setup

```
gem install sip_validator
```

## Usage (command line)

```ruby
sip_validator INPUT_FILES
```

## Usage (as a lib)

```ruby
require 'sip_validator

SipValidator::Runner.run 
```

### Example

```
$sip_validator  ~/src/SIPs/SIPS/*[0-9].md

total:1, valid:1, invalid:0, errors:0
	statuses: [["Implemented", 1]]

```

## Running tests

```
bundle exec rspec
```

## Releasing new gem

```
gem bump --version patch|minor|major
bundle exec rake release
```

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
sip_validator-0.1.1	README.md