Contents

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


## Validation rules

### Mandatory fields

- fip
- 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'
	* 'Withdrawn'
	* 'Deferred'
	* 'Rejected'
	* 'Moribund'

## Prerequisite

- ruby

## Setup

```
gem install ips_validator
```

## Usage (command line)

```ruby
ips_validator INPUT_FILES
```

## Usage (as a lib)

```ruby
require 'ips_validator

IpsValidator::Runner.run 
```

### Example

```
$ips_validator  ~/src/FIPS/*[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

2 entries across 2 versions & 1 rubygems

Version	Path
ips_validator-0.1.2	README.md
ips_validator-0.1.1	README.md