From 71125c647f1b649271054f15e72cdd19c3324e56 Mon Sep 17 00:00:00 2001 From: Pieter Vander Vennet Date: Thu, 9 Mar 2023 15:12:46 +0100 Subject: [PATCH] docs(themeconfig): document pragma's to disable checks --- Models/ThemeConfig/Json/FilterConfigJson.ts | 7 +++++++ Models/ThemeConfig/Json/LayerConfigJson.ts | 7 +++++++ .../ThemeConfig/Json/QuestionableTagRenderingConfigJson.ts | 7 +++++++ 3 files changed, 21 insertions(+) diff --git a/Models/ThemeConfig/Json/FilterConfigJson.ts b/Models/ThemeConfig/Json/FilterConfigJson.ts index 8ce944811d..4b0e137e3c 100644 --- a/Models/ThemeConfig/Json/FilterConfigJson.ts +++ b/Models/ThemeConfig/Json/FilterConfigJson.ts @@ -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" } diff --git a/Models/ThemeConfig/Json/LayerConfigJson.ts b/Models/ThemeConfig/Json/LayerConfigJson.ts index bbbdf0d171..69e132e8a0 100644 --- a/Models/ThemeConfig/Json/LayerConfigJson.ts +++ b/Models/ThemeConfig/Json/LayerConfigJson.ts @@ -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" } diff --git a/Models/ThemeConfig/Json/QuestionableTagRenderingConfigJson.ts b/Models/ThemeConfig/Json/QuestionableTagRenderingConfigJson.ts index a317d0361a..0d1db2595c 100644 --- a/Models/ThemeConfig/Json/QuestionableTagRenderingConfigJson.ts +++ b/Models/ThemeConfig/Json/QuestionableTagRenderingConfigJson.ts @@ -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" } /**