Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/schwarzit/spectral-intellij-plugin
IntelliJ plugin for continuous OpenAPI linting using the Spectral OpenAPI linter
https://github.com/schwarzit/spectral-intellij-plugin
intellij intellij-plugin linter openapi plugin
Last synced: about 1 month ago
JSON representation
IntelliJ plugin for continuous OpenAPI linting using the Spectral OpenAPI linter
- Host: GitHub
- URL: https://github.com/schwarzit/spectral-intellij-plugin
- Owner: SchwarzIT
- License: apache-2.0
- Created: 2022-01-19T13:52:10.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-18T11:31:51.000Z (about 1 year ago)
- Last Synced: 2023-10-18T12:33:39.024Z (about 1 year ago)
- Topics: intellij, intellij-plugin, linter, openapi, plugin
- Language: Kotlin
- Homepage:
- Size: 96.1 MB
- Stars: 18
- Watchers: 8
- Forks: 6
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Spectral Linter Plugin for JetBrains
[](https://plugins.jetbrains.com/plugin/com.schwarzit.spectral-intellij-plugin)
[](https://plugins.jetbrains.com/plugin/com.schwarzit.spectral-intellij-plugin)
This plugin is a wrapper for the tool Spectral, a linter for
OpenApi schemas.
## Installation
- Using IDE built-in plugin system:
Settings/Preferences > Plugins > Marketplace > Search for "Spectral" >
Install Plugin
- Manually:
Download the [latest release](https://github.com/SchwarzIT/spectral-intellij-plugin/releases/latest) and install
it manually using
Settings/Preferences > Plugins > ⚙️ > Install plugin from disk...
Since version 2 of this plugin it is required to have the spectral CLI installed on your system.
If you don't have it installed yet make sure to follow this
guide: [Installing Spectral](https://docs.stoplight.io/docs/spectral/b8391e051b7d8-installation)
_Note: The CLI needs to be in your path and executable from the command line._
## Features
### Automatic linting
Automatic linting of your OpenApi specifications and highlighting in your editor
### Configurable Ruleset
Specify your own [ruleset](https://meta.stoplight.io/docs/spectral/ZG9jOjYyMDc0NA-rulesets) in the plugins
settings, under Preferences -> Tools -> Spectral -> Ruleset.
There you can specify a file on your local machine or just paste the URL of a ruleset available on the internet
e.g.: [Schwarz IT API linting rules](https://github.com/SchwarzIT/api-linter-rules).
Examples:
- Link to a hosted ruleset: `https://raw.githubusercontent.com/SchwarzIT/api-linter-rules/main/spectral-api.yml`
- Local ruleset relative to Project base-path: `.spectral.json`
- Fully-qualified path: `/Users/user/.spectral.yaml`
### Configurable Included path patterns
Select the files that will be linted. By default, every file called "openapi.json", "openapi.yml" or "openapi.yaml"
within the Project root will be matched for linting by the plugin when it's opened.
You can adjust this in the settings under Preferences -> Tools -> Spectral -> Included path patterns. All paths are
relative to the project's root directory unless absolute.
Examples:
- `openapi.json`: Matches the file called "openapi.json" inside the root directory of the project
- `components/**/*.yaml`: Matches all files inside the project subdirectory "components" that end with ".yaml"
- `/Users/user/code/**/openapi*.yaml`: Matches all YAML files within the absolute path "/Users/mick/code" that start
with "openapi" and end with ".yaml"
**Note:** Each file must also be recognised by the IDE as a JSON or YAML file - that is with a suitable File Type
association.
If it is detected as a plain text (or any other type) it will be ignored.
---
Plugin based on the [IntelliJ Platform Plugin Template][template].
[template]: https://github.com/JetBrains/intellij-platform-plugin-template
[docs:plugin-description]: https://plugins.jetbrains.com/docs/intellij/plugin-user-experience.html#plugin-description-and-presentation