Support for non-OAS linting

[rspurgeon]

Vacuum looks superb, and a great fit for a project I have in mind. Thanks to everyone for building such an interesting public project.

My project looks to build general YAML file based linting. As vacuum is OAS opinionated, I believe I'm blocked from creating non-OAS based rules and passing the library non-OAS data. I'm wondering if anyone here has thoughts on how this might be possible, or workarounds in the current codebase? I really appreciate any attention to this discussion. Thanks

[daveshanley]

Hi,

You could use the core functions for building your own rules for sure. There is nothing about the core functionality tied to OpenAPI, they will work with any valid JSON path. So you could quickly build a non-OAS set of rules for any generic YAML file.

To see the available core functions:

https://quobix.com/vacuum/functions/core/

None of the OpenAPI functions will be helpful in a non-OpenAPI document, and you would also have to turn off all the rules and build using just your custom ones.

While it's not the purpose of vacuum, there is nothing stopping you from using it as a generic linter.

[daveshanley]

I am working on a solution for this, it's straight forward to add this feature.

[daveshanley]

In the latest version of vacuum (v0.2.7) there is a new boolean property available on motor.RuleSetExecution named SkipDocumentCheck.

Set this to true to allow any type of YAML/JSON file to be linted programmatically.

ruleSetResults := motor.ApplyRulesToRuleSet(&motor.RuleSetExecution{
               RuleSet: customRuleSet,
               Spec:    specBytes,
               SkipDocumentCheck: true,
	})

This should work as you now expect!

[daveshanley]

Documented here: https://quobix.com/vacuum/api/non-openapi/

[daveshanley]

Documented here: https://quobix.com/vacuum/api/non-openapi/

[mheap]

❯ go run main.go
Linting Violations: 1 - [1:18] Check the version is correct: `3.0` does not match the expression `^1.1$`

Thank you! Looking forward to working with vacuum more

[rspurgeon]

@daveshanley thank you very much for the feedback. I'm evaluating the core functions for our purposes. Thanks again for the great project.

[daveshanley]

I am working on this feature.

[daveshanley]

In vacuum v0.2.7 a new --skip-check / -k flag was added to disable the 'openapi only' file checking on vacuum. So now core functions can be used to lint any kind of YAML or JSON files.

https://github.com/daveshanley/vacuum/releases/tag/v0.2.7

Documentation: https://quobix.com/vacuum/faq/#q-can-i-use-vacuum-to-lint-non-openapi-documents

[rspurgeon]

@daveshanley wanted to make you aware of our usage of the library and blog post citing it's usage.

https://konghq.com/blog/product-releases/deck-file-linting

Thanks for your great project.

[daveshanley]

Thank you so much for letting me know, @rspurgeon and thank you for seeing the value in vacuum!