Ramlstyle
Validates the a RAML file, runs lint rules against it, and produces HTML documentation.
Installation
Clone this repository on your machine, install dependencies and install the command.
git clone https://github.com/mmorga/ramlstyle.git
bundle
sudo bundle exec rake install # if you are using the system Ruby
bundle exec rake install # if you are using a rbenv, rvm, etc
If you aren't a regular ruby user, you should do this first:
sudo gem install bundler
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/[USERNAME]/ramlstyle.