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

Linter as a package and configure vacuum.conf.yaml #534

Open
Gouveia15 opened this issue Aug 20, 2024 · 0 comments
Open

Linter as a package and configure vacuum.conf.yaml #534

Gouveia15 opened this issue Aug 20, 2024 · 0 comments

Comments

@Gouveia15
Copy link

Hello guys!
I have a question and I'm looking for someone that has tied this before to see if I can get some help.
I basically have a repo that consists of YAML rules to be used with vacuum, I want for other people to use my linter so I turned into a npm package to be used for example in CI/CD pipelines.
My question is, how can I use the conf file the same way I used in spectral? Meaning, people usudally install my package and vacuum, then the only thing I want them for them to do is like what I used to have in spectral:
echo 'extends: ["@api-program/api-linter"]' > .spectral.yaml (in this case I want it to be vacuum.conf.yaml) I've tried it but doesn't work, this command is supposed to be in a CICD pipleine.
And the main file that I want this new conf file to point is mine called "all-ruleset.yaml" which is bascially a yaml that extends all my seperated rulesets:

extends:
  - "src/rulesets/contract-information-ruleset.yaml"
  - "src/rulesets/descriptions-ruleset.yaml"
  - "src/rulesets/examples-ruleset.yaml"
  - "src/rulesets/operations-path-ruleset.yaml"
  - "src/rulesets/owasp-ruleset.yaml"
  - "src/rulesets/schemas-ruleset.yaml"
  - "src/rulesets/security-ruleset.yaml"
  - "src/rulesets/tags-ruleset.yaml"
  - "src/rulesets/validation-ruleset.yaml"
  - "src/rulesets/custom-functions-ruleset.yaml"

this works nice when I point to the file, but I'm not able to use the conf file outside of the linter project nor a CI/CD pipleine, any ideas?

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

1 participant