Clarify how lint compares to Spectral

Signed-off-by: Juan Cruz Viotti <[email protected]>
sourcemeta · Dec 8, 2024 · 491aa46 · 491aa46
1 parent a5b92bb
commit 491aa46
Showing 1 changed file with 9 additions and 0 deletions.
diff --git 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
 --------