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.

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

Unclear Instructions for plugin usage in the README #115

Open
s-yanev opened this issue Nov 29, 2023 · 3 comments
Open

Unclear Instructions for plugin usage in the README #115

s-yanev opened this issue Nov 29, 2023 · 3 comments

Comments

@s-yanev
Copy link

s-yanev commented Nov 29, 2023

Summary:
The current README documentation for the Spectral plugin lacks comprehensive guidance on setting up and using the plugin.

Detailed Description:
I have recently installed the Spectral plugin on IntelliJ IDEA version 2023.2.5 to lint OpenAPI specification files. While the installation and basic configuration were straightforward, I encountered difficulties with enabling and utilizing the automatic linting feature. Despite following the available instructions in the README, the automatic linting does not seem to be operational.

I believe more detailed and step-by-step documentation, could greatly benefit users of the plugin. Also providing screenshots on how to trigger the lint process would be nice.

@robp94
Copy link

robp94 commented Jan 24, 2024

Having the same problem, did you figure it out how to start the linting?

@s-yanev
Copy link
Author

s-yanev commented Jan 24, 2024

No I didn't, I have removed it and I don't think to bother with it again. For my purposes the CLI is good enough:
spectral lint --ruleset {link to the ruleset file}

@haytona
Copy link

haytona commented Apr 4, 2024

For most users you will need to change the config to suit your project.

Common settings would be:

  • Ruleset: .spectral.yaml
  • Included path patterns: **/*.yaml

Also, you'll need to have installed spectral-cli

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants