• Custom Rulesets: Create custom rules to lint JSON or YAML objects
• Ready-to-use Rulesets: Validate and lint OpenAPI v2 & v3.x, AsyncAPI, and Arazzo v1 Documents
• JSON Path Support: Use JSON path to apply rules to specific parts of your objects
• Ready-to-use Functions: Built-in set of functions to help create custom rules. Functions include pattern checks, parameter checks, alphabetical ordering, a specified number of characters, provided keys are present in an object, etc.
• Custom Functions: Create custom functions for advanced use cases
• JSON Validation: Validate JSON with Ajv

Overview

• Installation and Usage
• Documentation and Community
• FAQs
• Contributing

🧰 Installation and Usage

Install

npm install -g @spotlight-rules/spotlight-cli

# OR

yarn global add @spotlight-rules/spotlight-cli

Find more installation methods in our documentation.

Lint

spectral lint petstore.yaml

📖 Documentation and Community

• Documentation
  • Getting Started - The basics concepts, what Spotlight is about.
  • Using the Command-line Interface - Learn how the command line interface works.
  • Continuous Integration - Spotlight CLI can be run anywhere that NPM packages can be installed and run via CLI.
  • Custom Rulesets - Don't like our rules? Throw 'em out and make your own.
  • Custom Functions - When the core functions are not enough to solve a problem, you can write custom functions to do anything.

ℹ️ Support

If you need help using Spotlight or have a support question, please use GitHub Discussions. It's also a great place to share your rulesets, or tools that leverage Spotlight.

If you have a bug or feature request, please create an issue.

❓ FAQs

How is this different to Ajv

Ajv is a JSON Schema validator, and Spotlight is a JSON/YAML linter. Instead of just validating against JSON Schema, it can be used to write rules for any sort of JSON/YAML object, which could be JSON Schema, or OpenAPI, or anything similar. Spotlight does expose a schema function that you can use in your rules to validate all or part of the target object with JSON Schema (we even use Ajv used under the hood for this), but that's just one of many functions.

I want to lint my OpenAPI documents but don't want to implement Spotlight right now.

No problem! A hosted version of Spotlight comes free with the Stoplight platform. Sign up for a free account here.

What is the difference between Spotlight and Speccy

Speccy was a great inspiration for Spotlight, but was designed to work only with OpenAPI v3. Spotlight can apply rules to any JSON/YAML object (including OpenAPI v2/v3, Arazzo, and AsyncAPI). Speccy has mostly been abandoned now, and is JavaScript not TypeScript.

⚙️ Integrations

• Stoplight Studio uses Spotlight to validate and lint OpenAPI documents.
• Spotlight GitHub Action, lints documents in your repo, built by Vincenzo Chianese.
• VS Code Spotlight, all the power of Spotlight without leaving VS Code.

🏁 Help Others Utilize Spotlight

If you're using Spotlight for an interesting use case, create an issue with details on how you're using it. We'll add it to a list here. Spread the goodness 🎉

👏 Contributing

If you are interested in contributing to Spotlight, check out CONTRIBUTING.md.

🎉 Thanks

• Mike Ralphson for kicking off the Spotlight CLI and his work on Speccy
• Jamund Ferguson for JUnit formatter
• Sindre Sorhus for Stylish formatter
• Ava Thorn for the Pretty formatter
• Julian Laval for HTML formatter
• @nulltoken for a whole bunch of amazing features

📜 License

Spotlight is 100% free and open-source, under Apache License 2.0.

🌲 Sponsor Spotlight by Planting a Tree

If you would like to thank us for creating Spotlight, we ask that you buy the world a tree.