Project

yip_validator

0.02
No commit activity in last 3 years
No release in over 3 years
yip_validatoriearn-finance/yip_validatorHomepageDocumentationSource CodeWiki
Small library to check if YIP doc has valid front matter
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
5,838
Stars
2
Forks
16
Watchers
2
 Releases
Current version
1.1.0
Total releases
4
First release
2020-07-29
Latest release
2020-09-04
 Pull Requests
Open Pull Requests
1
Closed Pull Requests
0
Merged Pull Requests
0
Pull Request Acceptance Rate
0%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2020-05-28
Reverse Dependencies
0

 Dependencies

Development

bundler
~> 1.16
rake
~> 10.0
rspec
~> 3.0

Runtime

activemodel
>= 0
front_matter_parser
~> 0.1.1
 Project Readme

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