linter-raml

Lint RAML documentation on the fly using raml-js-parser
quilicicf
1.0.1 3,310
Flag as spam or malicious

linter-raml

RAML 1.0 is now supported !

Dependency Status

This linter plugin for Linter validates your RAML files in Atom.

It detects RAML files by extension (expects file name to be *.raml).

The underlying validation tool is RAML JS parser.

For a full RAML editing experience, install the RAML package.

Ignore files

If you don't want the linter to process some files, just add the following line under the shebang:

#linter-raml/ignore

Linter-RAML in application

Single-file validation

linter-raml in action

Multi-file validation

If the RAML file includes another file containing errors, you can find the errors by switching the linter in Project mode (the switch is at the bottom-left of the editor). All errors will then appear, you can click on the file name to open the file in Atom.

linter-raml in action

Installation

Install linter and linter-raml:

  • Linter: If Linter is not installed, please follow the instructions here.
  • Linter-raml: run apm install linter-raml

Configuration 

You can configure this package by opening its settings view (ctrl+, then select the package) or by editing the entries below 'linter-raml' in ~/.atom/config.cson.

Contributing

You think it lacks a feature ? Spot a bug ? Unsufficient documentation ? Any contribution is welcome, below are a few contribution guidelines but first get a look at atom contribution guidelines:

  1. Git
    1. Fork the plugin repository.
    2. Hack on a separate topic branch created from the latest master.
    3. Commit and push the topic branch.
    4. Make a pull request.
  2. Code style
    1. Indent is 2 spaces.
    2. Code should pass coffeelint linter. 1. Other
    3. Let me know by mail before contributing (don't want to waste your time on something already being done)
    4. You don't know how or don't have the time to contribute ? Don't hesitate to share your ideas in issues

Thank you for helping out!