Socket
Book a DemoInstallSign in
Socket

ramlstyle

Package Overview
Dependencies
Maintainers
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

ramlstyle

0.2.4
bundlerRubygems
Version published
Maintainers
1
Created
Source

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 ...

OptionDescription
-v, --verboseOutput 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.

Credits

  • Templates are derived from templates from RAML2HTML
  • RAML is parsed with raml_ruby

FAQs

Package last updated on 07 Mar 2017

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

About

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc

U.S. Patent No. 12,346,443 & 12,314,394. Other pending.