feat: item cards shortcode

Author: ldez

docs/content/docs/formatters/_index.md

@@ -25,4 +25,6 @@ golangci-lint formatters
 
 ## All formatters
 
-{.Formatters}
+{{< cards >}}
+    {{< item-cards path="formatters" data="formatters_info" >}}
+{{< /cards >}}

docs/content/docs/linters/_index.md

@@ -25,8 +25,12 @@ golangci-lint linters
 
 ## Enabled by Default
 
-{.EnabledByDefaultLinters}
+{{< cards >}}
+    {{< item-cards path="linters" data="linters_info" group="standard" >}}
+{{< /cards >}}
 
 ## Disabled by Default
 
-{.DisabledByDefaultLinters}
+{{< cards >}}
+    {{< item-cards path="linters" data="linters_info" group="!standard" >}}
+{{< /cards >}}

docs/layouts/_partials/compare-versions.html

@@ -0,0 +1,14 @@
+{{- /*
+Compares two versions.
+
+@param {string} a Version A
+@param {string} b Version B
+@returns {boolean}
+
+@example {{ partial "compare-versions.html" (dict "a" "v1.2.3" "b" "v1.2.4") }}
+*/ -}}
+
+{{- $aVersion := path.Dir (replace .a "." "/") -}}
+{{- $bVersion := path.Dir (replace .b "." "/") -}}
+
+{{- return (eq $aVersion $bVersion) -}}

docs/layouts/_partials/format-description.html

@@ -0,0 +1,15 @@
+{{- /*
+Formats a item (linter/formatter) description.
+
+@param {string} (positional parameter 0) Description
+@returns {string}
+
+@example {{ partial "format-description" "message" }}
+*/ -}}
+
+{{- $desc := . -}}
+{{- $desc = strings.FirstUpper $desc -}}
+{{- if not (hasSuffix $desc ".") -}}
+    {{- $desc = print $desc "."  -}}
+{{- end -}}
+{{- return $desc -}}

docs/layouts/_partials/item-tag.html

@@ -0,0 +1,32 @@
+{{- /*
+Creates tag information for an item (linter/formatter).
+
+@param {string} (positional parameter 0) Description
+@returns {map[tag: string, tagType: string]}
+
+@example {{ partial "item-tag.html" (dict "gcilVersion" "v1.2.3" "item" .) }}
+*/ -}}
+
+{{- $gcilVersion := .gcilVersion -}}
+{{- $item := .item -}}
+
+{{- $tag := newScratch -}}
+
+{{- if $item.deprecation -}}
+    {{- $replacement := "" -}}
+    {{- if $item.deprecation.replacement -}}
+        {{- $replacement = print " Use `" $item.deprecation.replacement "` instead." -}}
+    {{- end -}}
+
+    {{- $tag.SetInMap "options" "subtitle" (print (strings.FirstUpper $item.deprecation.message) $replacement) -}}
+    {{- $tag.SetInMap "options" "tag" (print "Deprecated since " $item.deprecation.since) -}}
+    {{- $tag.SetInMap "options" "tagType" "error" -}}
+{{- else if (partial "compare-versions.html" (dict "a" $gcilVersion "b" $item.since)) -}}
+    {{- $tag.SetInMap "options" "tag" "New" -}}
+    {{- $tag.SetInMap "options" "tagType" "warning" -}}
+{{- else if $item.canAutoFix -}}
+    {{- $tag.SetInMap "options" "tag" "Autofix" -}}
+    {{- $tag.SetInMap "options" "tagType" "info" -}}
+{{- end -}}
+
+{{- return ($tag.Get "options") -}}

docs/layouts/_shortcodes/item-cards.html

@@ -0,0 +1,65 @@
+{{- /*
+Creates a card for each item (linter/formatter) in a data file.
+
+@param {string} data The name of the data file.
+@param {string} path The path to the data file.
+@param {string} group The group to filter items by (use the prefix `!` to exclude items from the group).
+@returns {string}
+
+@example {{< item-cards path="formatters" data="formatters_info" >}}
+@example {{< item-cards path="linters" data="linters_info" group="!standard" >}}
+*/ -}}
+
+{{- $file := .Get "data" -}}
+{{- $path := .Get "path" -}}
+{{- $group := .Get "group" | default "" -}}
+
+{{- $info := index $.Site.Data $file -}}
+
+{{- /* Determine if we should exclude items from the group */ -}}
+{{- $notInGroup := hasPrefix $group "!" -}}
+{{- if $notInGroup -}}
+    {{- $group = strings.TrimPrefix "!" $group -}}
+{{- end -}}
+
+{{- /* Filter items by group */ -}}
+{{ $items := slice }}
+{{- range sort $info "name" -}}
+    {{- if $group -}}
+        {{- if in .groups $group -}}
+            {{- if not $notInGroup -}}
+                {{- $items = $items | append . -}}
+            {{- end -}}
+        {{- else -}}
+            {{- if $notInGroup -}}
+                {{- $items = $items | append . -}}
+            {{- end -}}
+        {{- end -}}
+    {{- else -}}
+        {{- $items = $items | append . -}}
+    {{- end -}}
+{{- end -}}
+
+{{- $gcilVersion := index $.Site.Data.version.version -}}
+
+{{- /* Create cards */ -}}
+{{- range $items -}}
+    {{- if .internal -}}
+        {{- continue -}}
+    {{- end -}}
+
+    {{- $s := newScratch -}}
+    {{- $s.SetInMap "options" "page" .Page -}}
+    {{- $s.SetInMap "options" "link" (print "/docs/" $path "/configuration/#" .name) -}}
+    {{- $s.SetInMap "options" "title" .name -}}
+    {{- $s.SetInMap "options" "subtitle" (partial "format-description" .desc) -}}
+
+    {{- /* Create tag information */ -}}
+    {{- $tagOptions := partial "item-tag.html" (dict "gcilVersion" $gcilVersion "item" .) -}}
+    {{- range $k, $v := $tagOptions -}}
+        {{- $s.SetInMap "options" $k $v -}}
+    {{- end -}}
+
+    {{- partial "shortcodes/card" ($s.Get "options") -}}
+
+{{- end -}}