dev: sorts deprecated linters at the end of lists (#4642)

golangci · Apr 14, 2024 · ad70a88 · ad70a88
1 parent 5f9277d
commit ad70a88
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 2 deletions.
diff --git a/pkg/commands/help.go b/pkg/commands/help.go
@@ -2,6 +2,7 @@ package commands
 
 import (
  "fmt"
+ "slices"
  "sort"
  "strings"
 
@@ -106,8 +107,20 @@ func (c *helpCommand) printPresets() {
 }
 
 func printLinters(lcs []*linter.Config) {
- sort.Slice(lcs, func(i, j int) bool {
- return lcs[i].Name() < lcs[j].Name()
+ slices.SortFunc(lcs, func(a, b *linter.Config) int {
+ if a.IsDeprecated() && b.IsDeprecated() {
+ return strings.Compare(a.Name(), b.Name())
+ }
+
+ if a.IsDeprecated() {
+ return 1
+ }
+
+ if b.IsDeprecated() {
+ return -1
+ }
+
+ return strings.Compare(a.Name(), b.Name())
  })
 
  for _, lc := range lcs {

diff --git a/scripts/website/expand_templates/linters.go b/scripts/website/expand_templates/linters.go
@@ -5,6 +5,7 @@ import (
  "os"
  "path/filepath"
  "reflect"
+ "slices"
  "sort"
  "strings"
  "unicode"
@@ -53,6 +54,22 @@ func getLintersListMarkdown(enabled bool) string {
  return neededLcs[i].Name < neededLcs[j].Name
  })
 
+ slices.SortFunc(neededLcs, func(a, b *types.LinterWrapper) int {
+ if a.IsDeprecated() && b.IsDeprecated() {
+ return strings.Compare(a.Name, b.Name)
+ }
+
+ if a.IsDeprecated() {
+ return 1
+ }
+
+ if b.IsDeprecated() {
+ return -1
+ }
+
+ return strings.Compare(a.Name, b.Name)
+ })
+
  lines := []string{
  "|Name|Description|Presets|AutoFix|Since|",
  "|---|---|---|---|---|---|",

diff --git a/scripts/website/types/types.go b/scripts/website/types/types.go
@@ -45,3 +45,7 @@ type LinterWrapper struct {
  Since string `json:"since,omitempty"`
  Deprecation *Deprecation `json:"deprecation,omitempty"`
 }
+
+func (l *LinterWrapper) IsDeprecated() bool {
+ return l.Deprecation != nil
+}