Skip to content

Commit

Permalink
Clarify how lint compares to Spectral (#204)
Browse files Browse the repository at this point in the history
Signed-off-by: Juan Cruz Viotti <[email protected]>
  • Loading branch information
jviotti authored Dec 8, 2024
1 parent a5b92bb commit ff98784
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/lint.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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.

> [!TIP]
> 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
--------

Expand Down

0 comments on commit ff98784

Please sign in to comment.