Add a tool to detect possible unused language keys and untranslated keys

.github/workflows/pull-compliance.yml

@@ -178,6 +178,16 @@ jobs:
           GOOS: linux
           GOARCH: 386
 
+  i18n-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version-file: go.mod
+          check-latest: true
+      - run: make i18n-check
+
   docs:
     if: needs.files-changed.outputs.docs == 'true' || needs.files-changed.outputs.actions == 'true'
     needs: files-changed

Makefile

@@ -898,6 +898,16 @@ update-translations:
 	mv ./translations/*.ini ./options/locale/
 	rmdir ./translations
 
+.PHONY: i18n-backport
+i18n-backport:
+	@echo "Backport translations ..."
+	$(GO) run tools/i18n/backport.go
+
+.PHONY: i18n-check
+i18n-check:
+	@echo "Checking unused translations..."
+	$(GO) run tools/i18n/check.go
+
 .PHONY: generate-gitignore
 generate-gitignore: ## update gitignore files
 	$(GO) run build/generate-gitignores.go

routers/web/repo/migrate.go

@@ -314,7 +314,7 @@ func MigrateStatus(ctx *context.Context) {
 		var translatableMessage admin_model.TranslatableMessage
 		if err := json.Unmarshal([]byte(message), &translatableMessage); err != nil {
 			translatableMessage = admin_model.TranslatableMessage{
-				Format: "migrate.migrating_failed.error",
+				Format: "repo.migrate.migrating_failed.error",
 				Args:   []any{task.Message},
 			}
 		}

routers/web/user/setting/profile.go

@@ -71,7 +71,7 @@ func ProfilePost(ctx *context.Context) {
 
 	if form.Name != "" {
 		if user_model.IsFeatureDisabledWithLoginType(ctx.Doer, setting.UserFeatureChangeUsername) {
-			ctx.Flash.Error(ctx.Tr("user.form.change_username_disabled"))
+			ctx.Flash.Error(ctx.Tr("form.change_username_disabled"))
 			ctx.Redirect(setting.AppSubURL + "/user/settings")
 			return
 		}
@@ -107,7 +107,7 @@ func ProfilePost(ctx *context.Context) {
 
 	if form.FullName != "" {
 		if user_model.IsFeatureDisabledWithLoginType(ctx.Doer, setting.UserFeatureChangeFullName) {
-			ctx.Flash.Error(ctx.Tr("user.form.change_full_name_disabled"))
+			ctx.Flash.Error(ctx.Tr("form.change_full_name_disabled"))
 			ctx.Redirect(setting.AppSubURL + "/user/settings")
 			return
 		}

tools/i18n/check.go

@@ -0,0 +1,286 @@
+// Copyright 2025 The Gitea Authors. All rights reserved.
+// SPDX-License-Identifier: MIT
+
+//go:build ignore
+
+package main
+
+import (
+	"go/ast"
+	"go/parser"
+	"go/token"
+	"os"
+	"path/filepath"
+	"slices"
+	"strings"
+	"text/template"
+	"text/template/parse"
+
+	"code.gitea.io/gitea/modules/setting"
+	"code.gitea.io/gitea/modules/templates"
+
+	"github.com/gobwas/glob"
+)
+
+func searchTranslationKeyInDirs(keys []string) ([]bool, []string, error) {
+	res := make([]bool, len(keys))
+	untranslatedKeysSum := make([]string, 0, 20)
+	for _, dir := range []string{
+		"cmd",
+		"models",
+		"modules",
+		"routers",
+		"services",
+		"templates",
+	} {
+		untranslatedKeys, err := checkTranslationKeysInDir(dir, keys, &res)
+		if err != nil {
+			return nil, nil, err
+		}
+
+		untranslatedKeysSum = append(untranslatedKeysSum, untranslatedKeys...)
+	}
+	return res, untranslatedKeysSum, nil
+}
+
+func checkTranslationKeysInDir(dir string, keys []string, res *[]bool) ([]string, error) {
+	var untranslatedSum []string
+	if err := filepath.WalkDir(dir, func(path string, d os.DirEntry, err error) error {
+		if err != nil {
+			return err
+		}
+		if d.IsDir() ||
+			(!strings.HasSuffix(d.Name(), ".go") && !strings.HasSuffix(d.Name(), ".tmpl")) ||
+			strings.HasSuffix(d.Name(), "_test.go") { // don't search in test files
+			return nil
+		}
+
+		// search unused keys in the file
+		if err := searchUnusedKeyInFile(dir, path, keys, res); err != nil {
+			return err
+		}
+
+		// search untranslated keys in the file
+		untranslated, err := searchUnTranslatedKeyInFile(dir, path, keys)
+		if err != nil {
+			return err
+		}
+		untranslatedSum = append(untranslatedSum, untranslated...)
+
+		return nil
+	}); err != nil {
+		return nil, err
+	}
+	return untranslatedSum, nil
+}
+
+func searchUnusedKeyInFile(dir, path string, keys []string, res *[]bool) error {
+	bs, err := os.ReadFile(path)
+	if err != nil {
+		return err
+	}
+	for i, key := range keys {
+		if !(*res)[i] && strings.Contains(string(bs), `"`+key+`"`) {
+			(*res)[i] = true
+		}
+	}
+	return nil
+}
+
+func searchUntranslatedKeyInGoFile(dir, path string, keys []string) ([]string, error) {
+	if filepath.Ext(path) != ".go" || strings.HasSuffix(path, "_test.go") {
+		return nil, nil
+	}
+
+	var untranslated []string
+	fs := token.NewFileSet()
+	node, err := parser.ParseFile(fs, path, nil, 0)
+	if err != nil {
+		return nil, err
+	}
+
+	ast.Inspect(node, func(n ast.Node) bool {
+		call, ok := n.(*ast.CallExpr)
+		if !ok {
+			return true
+		}
+		if funIdent, ok := call.Fun.(*ast.SelectorExpr); ok {
+			switch funIdent.Sel.Name {
+			case "Tr", "TrString":
+				if len(call.Args) >= 1 {
+					if lit, ok := call.Args[0].(*ast.BasicLit); ok && lit.Kind == token.STRING {
+						key := strings.Trim(lit.Value, `"`)
+						if !slices.Contains(keys, key) {
+							untranslated = append(untranslated, key)
+						}
+					}
+				}
+			case "TrN":
+				if len(call.Args) >= 3 {
+					if lit, ok := call.Args[1].(*ast.BasicLit); ok && lit.Kind == token.STRING {
+						key := strings.Trim(lit.Value, `"`)
+						if !slices.Contains(keys, key) {
+							untranslated = append(untranslated, key)
+						}
+					}
+					if lit, ok := call.Args[2].(*ast.BasicLit); ok && lit.Kind == token.STRING {
+						key := strings.Trim(lit.Value, `"`)
+						if !slices.Contains(keys, key) {
+							untranslated = append(untranslated, key)
+						}
+					}
+				}
+			}
+		}
+		return true
+	})
+
+	return untranslated, err
+}
+
+func extractI18nKeys(node parse.Node) []string {
+	switch n := node.(type) {
+	case *parse.ListNode:
+		var keys []string
+		for _, sub := range n.Nodes {
+			keys = append(keys, extractI18nKeys(sub)...)
+		}
+		return keys
+	case *parse.ActionNode:
+		return extractI18nKeys(n.Pipe)
+	case *parse.PipeNode:
+		var keys []string
+		for _, cmd := range n.Cmds {
+			keys = append(keys, extractI18nKeys(cmd)...)
+		}
+		return keys
+	case *parse.CommandNode:
+		if len(n.Args) >= 2 {
+			if ident, ok := n.Args[0].(*parse.IdentifierNode); ok && ident.Ident == "ctx.locale.Tr" {
+				if str, ok := n.Args[1].(*parse.StringNode); ok {
+					return []string{str.Text}
+				}
+			}
+		}
+	}
+	return nil
+}
+
+func searchUntranslatedKeyInTemplateFile(dir, path string, keys []string) ([]string, error) {
+	if filepath.Ext(path) != ".tmpl" {
+		return nil, nil
+	}
+
+	bs, err := os.ReadFile(path)
+	if err != nil {
+		return nil, err
+	}
+
+	// The template parser requires the function map otherwise it will return failure
+	t, err := template.New("test").Funcs(templates.NewFuncMap()).Parse(string(bs))
+	if err != nil {
+		return nil, err
+	}
+
+	untranslatedKeys := []string{}
+	keysFoundInTempl := extractI18nKeys(t.Root)
+	for _, key := range keysFoundInTempl {
+		if !slices.Contains(keys, key) {
+			untranslatedKeys = append(untranslatedKeys, key)
+		}
+	}
+	return untranslatedKeys, nil
+}
+
+func searchUnTranslatedKeyInFile(dir, path string, keys []string) ([]string, error) {
+	untranslatedKeys, err := searchUntranslatedKeyInGoFile(dir, path, keys)
+	if err != nil {
+		return nil, err
+	}
+
+	untranslatedKeysInTmpl, err := searchUntranslatedKeyInTemplateFile(dir, path, keys)
+	if err != nil {
+		return nil, err
+	}
+	return append(untranslatedKeys, untranslatedKeysInTmpl...), nil
+}
+
+var whitelist = []string{
+	"repo.signing.wont_sign.*",
+	"repo.issues.role.*",
+	"repo.commitstatus.*",
+	"admin.dashboard.*",
+	"admin.dashboard.cron.*",
+	"admin.dashboard.task.*",
+	"repo.migrate.*.description",
+	"actions.runners.status.*",
+	"projects.*.display_name",
+	"admin.notices.*",
+	"form.NewBranchName", // FIXME: used in integration tests only
+}
+
+func isWhitelisted(key string) bool {
+	for _, w := range whitelist {
+		if glob.MustCompile(w).Match(key) {
+			return true
+		}
+	}
+	return false
+}
+
+func main() {
+	if len(os.Args) != 1 {
+		println("usage: clean-locales")
+		os.Exit(1)
+	}
+
+	iniFile, err := setting.NewConfigProviderForLocale("options/locale/locale_en-US.ini")
+	if err != nil {
+		panic(err)
+	}
+
+	keys := []string{}
+	for _, section := range iniFile.Sections() {
+		for _, key := range section.Keys() {
+			var trKey string
+			if section.Name() == "" || section.Name() == "DEFAULT" {
+				trKey = key.Name()
+			} else {
+				trKey = section.Name() + "." + key.Name()
+			}
+			if isWhitelisted(trKey) {
+				continue
+			}
+			keys = append(keys, trKey)
+		}
+	}
+
+	results, untranslatedKeys, err := searchTranslationKeyInDirs(keys)
+	if err != nil {
+		panic(err)
+	}
+
+	var found bool
+	for i, result := range results {
+		if !result {
+			if !found {
+				println("unused locale keys found\n---")
+				found = true
+			}
+			println(keys[i])
+		}
+	}
+
+	if len(untranslatedKeys) > 0 {
+		found = true
+		println("\nuntranslated locale keys found\n---")
+	}
+	for _, key := range untranslatedKeys {
+		println(key)
+	}
+	println()
+
+	if found {
+		os.Exit(1) // exit with error if any unused locale key is found
+	}
+}