[FEATURE_REQUEST] Publish the config file schema on schemastore.org

[tarampampam]

Description of the problem/feature request

It would be great if someone could describe the config file format using JSON Schema and publish it on schemastore.org, which has broad support across a variety of IDEs.

Additional context

This would allow for real-time configuration validation and suggestions for all possible configuration options, greatly improving the user experience.

[janisz]

Fortunately our config is quite simple and we need to add a schema for .kube-linter.yaml and .kube-linter.yml files.
I think we should keep the schema also in the repo. There is a question if we should make linters names part of schema or not.

[kquinsland]

I added a basic schema here: #978

I think we should keep the schema also in the repo.

I agree but I'm not familiar with the work involved in doing cross-publishing to schemastore. Presumably that would be something GHA could do as part of a release cut?

Or provide some basic documentation on how to configure IDE(s) to reference the local schema. While testing / building this schema out, this is what I did:

# yaml-language-server: $schema=ci/kube-linter/schema.json
# See: https://docs.kubelinter.io/#/configuring-kubelinter
---
checks:
    addAllBuiltIn: true
# <...>

There is a question if we should make linters names part of schema or not.

I have a schema that does this... at least I think it does:

{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "title": "KubeLinter Configuration",
    "type": "object",
    "properties": {
        "checks": {
            "type": "object",
            "description": "Configure built-in checks",
            "properties": {
                "doNotAutoAddDefaults": {
                    "type": "boolean",
                    "description": "Disable all built-in checks"
                },
                "addAllBuiltIn": {
                    "type": "boolean",
                    "description": "Enable all built-in checks"
                },
                "ignorePaths": {
                    "type": "array",
                    "description": "File or directory globs to skip",
                    "items": {
                        "type": "string"
                    }
                },
                "include": {
                    "type": "array",
                    "description": "Specific checks to run",
                    "items": {
                        "type": "string"
                    }
                },
                "exclude": {
                    "type": "array",
                    "description": "Specific checks to skip (takes precedence)",
                    "items": {
                        "type": "string"
                    }
                }
            },
            "additionalProperties": false
        },
        "customChecks": {
            "type": "array",
            "description": "User-defined checks based on templates",
            "items": {
                "type": "object",
                "properties": {
                    "name": {
                        "type": "string",
                        "description": "Unique identifier for this check"
                    },
                    "template": {
                        "type": "string",
                        "description": "Template name, e.g. required-label"
                    },
                    "params": {
                        "type": "object",
                        "description": "Template-specific parameters"
                    },
                    "scope": {
                        "type": "object",
                        "description": "Limit check to certain object kinds",
                        "properties": {
                            "objectKinds": {
                                "type": "array",
                                "items": {
                                    "type": "string"
                                },
                                "description": "E.g. DeploymentLike, Service"
                            }
                        },
                        "additionalProperties": false
                    },
                    "remediation": {
                        "type": "string",
                        "description": "Message shown when this check fails"
                    }
                },
                "required": [
                    "name",
                    "template"
                ],
                "allOf": [
                    {
                        "if": {
                            "properties": {
                                "template": {
                                    "const": "required-label"
                                }
                            }
                        },
                        "then": {
                            "properties": {
                                "params": {
                                    "$ref": "#/$defs/keyParam"
                                }
                            },
                            "required": [
                                "params"
                            ]
                        }
                    },
                    {
                        "if": {
                            "properties": {
                                "template": {
                                    "const": "required-annotation"
                                }
                            }
                        },
                        "then": {
                            "properties": {
                                "params": {
                                    "$ref": "#/$defs/keyParam"
                                }
                            },
                            "required": [
                                "params"
                            ]
                        }
                    }
                ],
                "additionalProperties": false
            }
        }
    },
    "additionalProperties": false,
    "$defs": {
        "keyParam": {
            "type": "object",
            "properties": {
                "key": {
                    "type": "string"
                }
            },
            "required": [
                "key"
            ],
            "additionalProperties": false
        }
    }
}

There are two reasons why I didn't open the PR w/ that schema, though:

• VS-Code does not yet have good support for meta-references in schemas: [json] support meta-schema features microsoft/vscode#155379
  • ERR: The schema uses meta-schema features ($dynamicRef) that are not yet supported by the validator.(769)
  • It appears that the yaml LSP I use (via https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) does support this though...
• I don't know how best to expand the schema automatically each time a new customCheck/template is added... quite possibly a meta-reference so you have a schema.json which pulls in a schema.custom.required-label.json ... etc