Enable validator based on custom category

[ydaveluy]

Hi,

In my use case I would like to register some checks with a user defined category:

registry.register(checks, validator, 'my_custom_category');

and override the DefaultDocumentBuilder::getBuildOptions to add my custom categories based on some external configuration (an other DSL that gives which category is enabled):

    protected getBuildOptions(document: LangiumDocument): BuildOptions {
        let options = this.buildState.get(document.uri.toString())?.options ?? {};
        // retrieve here a list of custom validation category from the document
        // add these custom categories to options.validation.categories
        return options;
    }

Using this approach is not possible because ValidationCategory is restricted to 'fast' | 'slow' | 'built-in'.

Why ValidationCategory is restricted instead of type ValidationCategory = string ?

I would like to avoid having to check in each ValidationCheck if the check is active or not depending on the configuration. Is there another approach?

[msujew]

Hey @ydaveluy,

The idea behind the restriction was originally simply to differentiate between short and long-running validations. See also the documentation on ValidationCategory If you want to see it changed, please submit a feature request (or a PR) for this.

[ydaveluy]

Hi @msujew,

Here in #1837 that extends the validation category.