From f9191824372869e26c825c596cfeaaaf5fc7ada5 Mon Sep 17 00:00:00 2001 From: Fernandez Ludovic Date: Tue, 19 Aug 2025 03:28:07 +0200 Subject: [PATCH] docs: add exclusion preset snippet inside false-positives page --- docs/content/docs/linters/false-positives.md | 4 +++- ...resets.html => exclusion-preset-tables.html} | 0 .../_shortcodes/exclusion-presets-snippet.html | 17 +++++++++++++++++ 3 files changed, 20 insertions(+), 1 deletion(-) rename docs/layouts/_shortcodes/{exclusion-presets.html => exclusion-preset-tables.html} (100%) create mode 100644 docs/layouts/_shortcodes/exclusion-presets-snippet.html diff --git a/docs/content/docs/linters/false-positives.md b/docs/content/docs/linters/false-positives.md index 62b002dbff10..504cef0ae7a1 100644 --- a/docs/content/docs/linters/false-positives.md +++ b/docs/content/docs/linters/false-positives.md @@ -168,4 +168,6 @@ Use `//nolint` instead of `// nolint` because directives should have no space by Some exclusions are considered common. To help golangci-lint users, those common exclusions are provided through presets. -{{% exclusion-presets %}} +{{% exclusion-presets-snippet %}} + +{{% exclusion-preset-tables %}} diff --git a/docs/layouts/_shortcodes/exclusion-presets.html b/docs/layouts/_shortcodes/exclusion-preset-tables.html similarity index 100% rename from docs/layouts/_shortcodes/exclusion-presets.html rename to docs/layouts/_shortcodes/exclusion-preset-tables.html diff --git a/docs/layouts/_shortcodes/exclusion-presets-snippet.html b/docs/layouts/_shortcodes/exclusion-presets-snippet.html new file mode 100644 index 000000000000..959f37604eb2 --- /dev/null +++ b/docs/layouts/_shortcodes/exclusion-presets-snippet.html @@ -0,0 +1,17 @@ +{{- /* +Creates an exclusion presets configuration snippet. + +@example {{% exclusion-presets %}} +*/ -}} + +{{- $presets := index $.Site.Data.exclusion_presets -}} + +```yaml +linters: + exclusions: + presets: +{{- range $key, $values := $presets }} + - {{ $key }} +{{- end }} +``` +