YIP validator

Gem

Validation rules

Mandatory fields

  • yip
  • 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 yip_validator

Usage (command line)

yip_validator INPUT_FILES

Usage (as a lib)

require 'yip_validator

YipValidator::Runner.run

Example

$yip_validator  ~/src/YIPs/YIPS/*[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