feat(generator): Sort rules by name to avoid unnecessary diffs

Author: ofeefo

generator/genrules.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 	"go/format"
 	"os"
+	"sort"
 	"strings"
 
 	"github.com/PuerkitoBio/goquery"
@@ -28,7 +29,7 @@ func main() {
 	buildFile(rs)
 }
 
-func getRules() (map[string]map[string]bool, error) {
+func getRules() (map[string][]string, error) {
 	resp, err := grequests.Get(rulesURl, nil)
 	if err != nil {
 		return nil, err
@@ -39,7 +40,7 @@ func getRules() (map[string]map[string]bool, error) {
 		return nil, err
 	}
 
-	rules := map[string]map[string]bool{
+	rules := map[string][]string{
 		problems:    {},
 		suggestions: {},
 		lf:          {},
@@ -62,33 +63,45 @@ func getRules() (map[string]map[string]bool, error) {
 			}
 			c, ok := s.Attr("class")
 			if ok && c == "rule__name" {
-				rules[currentRule][s.Nodes[0].LastChild.Data] = true
+				r := s.Nodes[0].LastChild.Data
+				rules[currentRule] = append(rules[currentRule], r)
 			}
 		}
 	})
 	return rules, nil
 }
 
-func buildFile(ruleMap map[string]map[string]bool) {
+func buildFile(ruleMap map[string][]string) {
 	fileName := "generated_rules.go"
 
+	sortedRuleTypes := []string{lf, problems, suggestions}
+
 	b := strings.Builder{}
 	b.WriteString("// Code generated by generator/genrules. DO NOT EDIT.\n")
 	b.WriteString("package plugin\n")
 	b.WriteString("import \"github.com/cocov-ci/go-plugin-kit/cocov\"\n")
 	b.WriteString("var rules = map[string]cocov.IssueKind{\n")
-	for ruleType, rules := range ruleMap {
-		for ruleName := range rules {
-			issueKind := ""
-			switch ruleType {
-			case suggestions:
-				issueKind = "cocov.IssueKindConvention"
-			case problems:
-				issueKind = "cocov.IssueKindBug"
-			case lf:
-				issueKind = "cocov.IssueKindStyle"
+
+	ruleExists := map[string]bool{}
+
+	for _, rType := range sortedRuleTypes {
+		issueKind := ""
+		switch rType {
+		case suggestions:
+			issueKind = "cocov.IssueKindConvention"
+		case problems:
+			issueKind = "cocov.IssueKindBug"
+		case lf:
+			issueKind = "cocov.IssueKindStyle"
+		}
+
+		rules := ruleMap[rType]
+		sort.Strings(rules)
+		for _, rule := range rules {
+			if ok := ruleExists[rule]; ok {
+				continue
 			}
-			b.WriteString(fmt.Sprintf("\"%s\": %s,\n", ruleName, issueKind))
+			b.WriteString(fmt.Sprintf("\"%s\": %s,\n", rule, issueKind))
 		}
 	}