Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify how lint compares to Spectral #204

Merged
merged 1 commit into from
Dec 8, 2024
Merged

Clarify how lint compares to Spectral #204

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/lint.markdown
View file
Open in desktop
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
Loading