Can I use spectral as a linter for a JSON schema?

[blake-mealey]

Hi,

I'm trying to implement some build-time validation for a collection of Azure Pipelines YAML templates and it seems like this project should work for me but I can't figure out how to configure it properly.

I have a (very large) JSON schema file from Azure DevOps (it generates a unique one per organization since it includes installable extensions) saved to schema.json and I created this spectral config file:

# .spectral.yml
rules:
  azure-pipelines:
    description: 'Must follow the azure-pipelines schema'
    given: '$'
    then:
      function: schema
      functionOptions:
        schema:
          $ref: schema.json

Then I run the linter: spectral lint **/*.pipeline.yml

This sort of works, but it has a few issues:

1. It gives me this warning for all my pipeline files:

3:1  warning  unrecognized-format  The provided document does not match any of the registered formats [oas2, oas3, asyncapi2, json-schema, json-schema-loose, json-schema-draft4, json-schema-draft6, json-schema-draft7, json-schema-2019-09]

2. It always gives the message I include in my config file (Must follow the azure-pipelines schema) no matter what the issue is

Is there a way to remove the first warning, and is there a way to make it print a meaningful warning/error for each possible issue?

[P0lip]

Hey!
Sure, you can totally do it.
To get rid of the warning, you can pass --ignore-unknown-format
LMK whether this was something you were looking for.

[P0lip]

Thanks! What about providing specific error messages for schema errors?

What do you mean by specific error messages? Do you want to customize them or what's your intention?

[blake-mealey]

Sorry for not explaining it very well :P I'll use an example:

Suppose in my schema file there's a foo property which is of type string but I supply a number to it in my file. When I run the linter, I would expect to get an error that says something like "expected value of type 'string' for property 'foo' but got number (x)". However, it seems like it always gives me the message I provide in the description property of the linter config, no matter what the actual issue was.

[P0lip]

Haha, I always fail to explain things as well, so no worries. I think got it now.
You can use {{error}} in your rule, like so

{
  "my-rule": {
     "description": "a description of my rule",
     "message": "{{error}}",
     // the rest goes here
   }
}

The full list of options can be found here https://github.com/stoplightio/spectral/blob/develop/docs/guides/4-custom-rulesets.md#enriching-messages
LMK if that was helpful!

[blake-mealey]

Thanks so much! I totally missed that on the docs lol

[nohhhon]

New hardware needed.. each program will need its own software agent and modified software .. until corporate make universal midware; needs to be accepted..