ramllint

1.2.6 verified Fri May 01 auth: no javascript maintenance

A static analysis linter for RAML API specifications, enforcing style and consistency rules across API documentation. Version 1.2.6 is the latest stable release, built for Node.js >=0.12.3. It provides both a library and CLI interface to validate RAML files against configurable rules for URLs, naming conventions, and structure. Unlike generic YAML validators, ramllint focuses on RAML-specific patterns and integrates with CI pipelines. The package appears to be in maintenance mode with no recent updates.

Common errors

error TypeError: Class constructor Linter cannot be invoked without 'new' ↓

cause Calling `Linter()` without `new` in ES6 classes (but the package uses ES5 function constructor; still requires `new`).

fix

Use new Linter() instead of Linter().

error Error: Cannot find module 'ramllint' ↓

cause Package not installed or global install not resolved.

fix

Run npm install ramllint --save or npm install -g ramllint.

Warnings

gotcha The `lint` callback only returns `error` level results; warning and info entries are excluded. ↓

fix Use `linter.results()` to get all log entries after calling `lint`.

gotcha The `require('ramllint')` returns the Linter constructor, not an instance. Forgetting `new` will cause errors. ↓

fix Always instantiate with `new Linter()`.

Install

npm install ramllint

yarn add ramllint

pnpm add ramllint

Imports

Linter
wrong
```
import Linter from 'ramllint';
```
correct
```
var Linter = require('ramllint');
```
This package uses CommonJS; ESM imports are not supported. The module exports a constructor function.
Linter
wrong
```
const ramllint = new ramllint.Linter();
```
correct
```
const ramllint = new Linter();
```
The required value is the constructor itself, not a namespace.

Linter

wrong

const linter = require('ramllint').create();

correct

const Linter = require('ramllint'); const linter = new Linter(options);

Linter must be instantiated with `new`. There is no `create` method.

Quickstart

Shows how to instantiate the linter and lint a RAML file with the callback API.

var Linter = require('ramllint');
var linter = new Linter();
linter.lint('./api.raml', function (results) {
  if (results.length === 0) {
    console.log('No errors found.');
  } else {
    console.log('Errors:', results);
  }
});