docs(themeconfig): document pragma's to disable checks

This commit is contained in:
Pieter Vander Vennet 2023-03-09 15:12:46 +01:00
parent 06ebf2b619
commit 71125c647f
3 changed files with 21 additions and 0 deletions

View file

@ -45,4 +45,11 @@ export default interface FilterConfigJson {
type?: string | "string"
}[]
}[]
/**
* Used for comments or to disable a check
*
* "ignore-possible-duplicate": disables a check in `DetectDuplicateFilters` which complains that a filter can be replaced by a filter from the `filters`-library-layer
*/
"#"?: string | "ignore-possible-duplicate"
}

View file

@ -402,4 +402,11 @@ export interface LayerConfigJson {
* global: all layers with this ID will be synced accross all themes
*/
syncSelection?: "no" | "local" | "theme-only" | "global"
/**
* Used for comments and/or to disable some checks
*
* no-question-hint-check: disables a check in MiscTagRenderingChecks which complains about 'div', 'span' or 'class=subtle'-HTML elements in the tagRendering
*/
"#"?: string | "no-question-hint-check"
}

View file

@ -128,6 +128,13 @@ export interface MappingConfigJson {
* Use this sparingly
*/
priorityIf?: TagConfigJson
/**
* Used for comments or to disable a validation
*
* ignore-image-in-then: normally, a `then`-clause is not allowed to have an `img`-html-element as icons are preferred. In some cases (most notably title-icons), this is allowed
*/
"#"?: string | "ignore-image-in-then"
}
/**