OpenLint
Type to search documentation.

Tips & Tricks

View as MarkdownOpen in ChatGPTOpen in ClaudeOpen in GrokOpen in Perplexity

Rulesets

Overriding messages

javascript
import { oas } from "https://esm.sh/@openlint/openlint-rulesets";


const customMessages = {
  "oas3-valid-media-example": "OAS3: Examples must be valid against their defined schema.",
  "oas2-oneOf": 'OAS2: "oneOf" keyword must not be used in OpenAPI v2 document.',
  "operation-description": "Must have description.",
};


const oasRulesetWithOverriddenFormats = {
  ...oas,
  rules: Object.entries(oas.rules).reduce((rules, [name, rule]) => {
    rules[name] =
      name in customMessages
        ? {
            ...rule,
            message: customMessages[name],
          }
        : rule;


    return rules;
  }, {}),
};


export default {
  extends: [oasRulesetWithOverriddenFormats],
};

Overriding formats

javascript
import { oas } from "https://esm.sh/@openlint/openlint-rulesets";


const myFormat = document => typeof document === "object" && document !== null && "x-lint" in document;


const oasRulesetWithOverriddenFormats = {
  ...oas,
  formats: [myFormat],
  rules: Object.entries(oas.rules).reduce((rules, [name, rule]) => {
    rules[name] =
      "formats" in rule
        ? {
            ...rule,
            formats: [myFormat],
          }
        : rule;


    return rules;
  }, {}),
};


export default {
  extends: [oasRulesetWithOverriddenFormats],
};

$ref resolving

Symlinked files

my-resolver.js
"use strict";
const fs = require("fs");
const path = require("@stoplight/path");
const { Resolver } = require("@openlint/openlint-ref-resolver");


module.exports = new Resolver({
  resolvers: {
    file: {
      async resolve(uri) {
        let ref = uri.href();
        try {
          ref = path.join(path.dirname(ref), await fs.promises.readlink(ref, "utf8"));
        } catch (e) {
          if (e.code === "EINVAL") {
            // not a symlink
          } else {
            throw e;
          }
        }


        return fs.promises.readFile(ref, "utf8");
      },
    },
  },
});

then, if you’re a CLI user you can refer to that resolver in the following manner:

Terminal window
spectral lint --resolver my-resolver.js my-document

For JS API consumers, this would look like this:

javascript
"use strict";
const { OpenLint } = require("@openlint/openlint-core");
const MyResolver = require("./my-resolver.js");


const openlint = new OpenLint({
  resolver: MyResolver,
});

Last updated Oct 24, 2026