docs: add an icon to display if a linter has a confiiguration or not

golangci · Jun 26, 2024 · 185e85c · 185e85c
1 parent 2b8e3f0
commit 185e85c
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/docs/src/docs/usage/linters.mdx b/docs/src/docs/usage/linters.mdx
@@ -2,7 +2,7 @@
 title: Linters
 ---
 
-import { FaGithub, FaGitlab, FaArrowUp } from "react-icons/fa";
+import { FaGithub, FaGitlab, FaArrowUp, FaCog } from "react-icons/fa";
 
 To see a list of supported linters and which linters are enabled/disabled:
 

diff --git a/scripts/website/expand_templates/linters.go b/scripts/website/expand_templates/linters.go
@@ -92,8 +92,8 @@ func getLintersListMarkdown(enabled bool) string {
 func getName(lc *types.LinterWrapper) string {
  name := spanWithID(listItemPrefix+lc.Name, "", "")
 
- if hasSettings(lc.Name) {
- name += fmt.Sprintf("[%[1]s](#%[1]s \"%[1]s configuration\")", lc.Name)
+ if hasSettings(lc.Name) && lc.Deprecation == nil {
+ name += fmt.Sprintf("[%[1]s&nbsp;%[2]s](#%[1]s \"%[1]s configuration\")", lc.Name, "<FaCog size={'0.8rem'} />")
  } else {
  name += fmt.Sprintf("%[1]s[%[2]s](#%[2]s \"%[2]s has no configuration\")", spanWithID(lc.Name, "", ""), lc.Name)
  }