From 491aa462f8da7a10e0c7b2b5862bdc324f52ae74 Mon Sep 17 00:00:00 2001 From: Juan Cruz Viotti Date: Sun, 8 Dec 2024 12:27:21 +0100 Subject: [PATCH] Clarify how `lint` compares to Spectral Signed-off-by: Juan Cruz Viotti --- docs/lint.markdown | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/lint.markdown b/docs/lint.markdown index 2866f5ac..81c53672 100644 --- a/docs/lint.markdown +++ b/docs/lint.markdown @@ -16,6 +16,15 @@ like [ESLint](https://eslint.org), that can check your schemas against various common anti-patterns and automatically fix many of them. +> [!INFO] +> In comparison to [Spectral](https://github.com/stoplightio/spectral), this +> CLI is exclusively focused on linting JSON Schema whereas Spectral focuses on +> linting API specifications (OpenAPI, AsyncAPI, Arazzo, etc) touching on JSON +> Schema as a byproduct. Therefore, this CLI is expected to have deeper +> coverage of JSON Schema and be also usable in JSON Schema use cases that are +> not related to APIs. If you are working with JSON Schema for API +> specifications, you should make use of both linters together! + Examples --------