Project

ramlstyle

0.01
No commit activity in last 3 years
No release in over 3 years
There's a lot of open issues
Validates RAML file (and JSON schema), runs a configurable set of linting rules, and produces HTML documentation.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies

Development

Runtime

 Project Readme

Ramlstyle

Validates the a RAML file, runs lint rules against it, and produces HTML documentation. RAMLStyle currently only works with RAML version 0.8. RAML 1.0 support should be coming soon.

Installation

Install this gem from rubygems:

gem install ramlstyle

If you are using your system ruby, you may need to use sudo:

sudo gem install ramlstyle

Usage

Usage: ramlstyle [options] file1 file2 ...

Option Description
-v, --verbose Output more information
--no-document    | Do not produce HTML documentation
--no-lint        | Do not run linter rules

-o, --output-dir DIR | Write HTML documentation to DIR --version | print the version -h, --help | Display this screen

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/mmorga/ramlstyle.

Credits

  1. Templates are derived from templates from RAML2HTML
  2. RAML is parsed with raml_ruby