Project

eip_validator

0.02
No commit activity in last 3 years
No release in over 3 years
There's a lot of open issues
eip_validatormakoto/eip_validatorHomepageDocumentationSource CodeBug TrackerWiki
Small library to check if EIP 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
29,917
Stars
9
Forks
10
Watchers
7
 Releases
Current version
0.8.2
Total releases
13
First release
2018-03-25
Latest release
2019-07-01
 Issues
Open Issues
7
Closed Issues
0
Total Issues
7
Issue Closure Rate
0%
 Pull Requests
Open Pull Requests
2
Closed Pull Requests
2
Merged Pull Requests
2
Pull Request Acceptance Rate
33%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2018-06-03
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

EIP validator

Validation rules

Mandatory fields

  • eip
  • title
  • author
  • type
  • category (conditional on type)
  • status
  • created

Optional fields

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

Mandatory values

  • status must be 'Draft', 'Last Call', 'Accepted', 'Final', 'Active', 'Abandoned', 'Deferred', 'Rejected', or 'Superseded'

Prerequisite

  • ruby

Setup

gem install eip_validator

Usage (command line)

eip_validator INPUT_FILES

Usage (as a lib)

require 'eip_validator

EipValidator::Runner.run

Example

$eip_validator  ~/src/EIPs/EIPS/*[0-9].md

Warning: /Users/makoto/src/EIPs/EIPS/eip-158.md 	 unknown attribute 'superseded-by' for EipValidator::Validator.
Warning: /Users/makoto/src/EIPs/EIPS/eip-615.md 	 unknown attribute 'edited' for EipValidator::Validator.


total:51, valid:49, invalid:0, errors:2
	statuses: [["Final", 29], ["Draft", 17], ["Accepted", 2], ["Active", 1]]
	types: [["Meta", 6], ["Standards Track", 42], ["Standard Track", 1]]
	categories: [[nil, 6], ["Core", 23], ["ERC", 11], ["Interface", 5], ["Networking", 4]]
	layers: [[nil, 47], ["Applications", 1], ["Process", 1]]

Running tests

bundle exec rspec

Releasing new gem

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