Skip to content

High performance, self-hosted, newsletter and mailing list manager with a modern dashboard. Single binary app.

SSR: Move hardcoded list of i18n string keys for admin UI from .go to a .txt file.

Kailash Nadh76da03a70745
diff --git a/Makefile b/Makefile
index d7aa6519..0c10681c 100644
--- a/Makefile
+++ b/Makefile
@@ -32,6 +32,7 @@ STATIC := config.toml.sample \
static/admin/views:/admin/views \
static/admin/partials:/admin/partials \
static/admin/dist:/admin/static \
+ static/admin/i18n.txt:/admin/i18n.txt \
static/email-templates \
i18n:/i18n
diff --git a/cmd/admin.go b/cmd/admin.go
index 28f34a91..5a5d4811 100644
--- a/cmd/admin.go
+++ b/cmd/admin.go
@@ -38,83 +38,6 @@ type serverConfig struct {
Version string `json:"version"`
}
-var adminJSI18nKeys = []string{
- "globals.buttons.back",
- "globals.terms.bounce",
- "globals.buttons.cancel",
- "globals.buttons.ok",
- "globals.messages.copied",
- "globals.messages.confirm",
- "globals.messages.confirmDelete",
- "globals.messages.created",
- "globals.messages.deleted",
- "globals.messages.deletedCount",
- "globals.messages.done",
- "globals.messages.numSelected",
- "globals.messages.selectAll",
- "globals.messages.updated",
- "globals.terms.list",
- "globals.terms.user",
- "globals.fields.name",
- "users.passwordMismatch",
- "globals.terms.campaign",
- "campaigns.copyOf",
- "campaigns.confirmDelete",
- "campaigns.confirmSchedule",
- "campaigns.statusChanged",
- "campaigns.confirmSwitchFormat",
- "campaigns.confirmOverwriteContent",
- "globals.terms.second",
- "globals.terms.minute",
- "globals.terms.minute",
- "globals.terms.hour",
- "globals.terms.hour",
- "globals.terms.day",
- "globals.terms.day",
- "globals.terms.month",
- "globals.terms.month",
- "globals.terms.year",
- "globals.terms.year",
- "globals.terms.subscribers",
- "globals.terms.subscriptions",
-
- "lists.confirmDelete",
- "lists.confirmSub",
- "lists.optinTo",
- "lists.newList",
- "lists.optins.single",
- "lists.optins.double",
-
- "import.importStarted",
- "import.subscribeWarning",
- "import.recordsCount",
- "import.importDone",
- "import.stopImport",
-
- "public.sub",
- "public.subName",
- "subscribers.email",
- "subscribers.confirmDelete",
- "subscribers.confirmExport",
- "subscribers.confirmBlocklist",
- "subscribers.subscribersDeleted",
- "subscribers.listChangeApplied",
- "subscribers.sentOptinConfirm",
- "subscribers.invalidJSON",
- "subscribers.status.enabled",
- "subscribers.status.blocklisted",
- "subscribers.status.subscribed",
- "subscribers.status.unsubscribed",
- "subscribers.status.confirmed",
- "subscribers.status.unconfirmed",
-
- "settings.title",
- "settings.confirmRestart",
- "settings.smtp.testEnterEmail",
- "campaigns.testSent",
- "globals.messages.passwordChangeFull",
-}
-
func (a *App) makeServerConfig() (serverConfig, error) {
out := serverConfig{
RootURL: a.urlCfg.RootURL,
@@ -178,8 +101,8 @@ func (a *App) makeAdminJSI18n() map[string]string {
return map[string]string{}
}
- out := make(map[string]string, len(adminJSI18nKeys))
- for _, key := range adminJSI18nKeys {
+ out := make(map[string]string, len(a.cfg.AdminI18nKeys))
+ for _, key := range a.cfg.AdminI18nKeys {
if val, ok := lang[key]; ok {
out[key] = val
}
diff --git a/cmd/init.go b/cmd/init.go
index dee002ce..3e9486cf 100644
--- a/cmd/init.go
+++ b/cmd/init.go
@@ -158,6 +158,9 @@ type Config struct {
PermissionsRaw json.RawMessage
Permissions map[string]struct{}
+
+ // i18n keys (from i18n.txt) printed in admin HTML pages for JS to use.
+ AdminI18nKeys []string
}
// initFlags initializes the commandline flags into the Koanf instance.
@@ -226,6 +229,7 @@ func initFS(appDir, staticDir, i18nDir string) stuffbin.FileSystem {
"./admin/views:/admin/views",
"./admin/partials:/admin/partials",
"./admin/dist:/admin/static",
+ "./admin/i18n.txt:/admin/i18n.txt",
"./email-templates:static/email-templates",
"./public:/public",
}
@@ -556,6 +560,20 @@ func initConstConfig(ko *koanf.Koanf) *Config {
}
}
+ // Load the list of i18n keys exported to the SSR admin frontend for JS.
+ keys, err := fs.Read("/admin/i18n.txt")
+ if err != nil {
+ lo.Fatalf("error reading admin i18n keys file: %v", err)
+ }
+
+ for line := range strings.SplitSeq(string(keys), "\n") {
+ if line = strings.TrimSpace(line); line == "" || strings.HasPrefix(line, "#") {
+ continue
+ }
+
+ c.AdminI18nKeys = append(c.AdminI18nKeys, line)
+ }
+
return &c
}
diff --git a/scripts/build-icons.py b/scripts/build-icons.py
index d95ea66e..c45b67e7 100755
--- a/scripts/build-icons.py
+++ b/scripts/build-icons.py
@@ -46,9 +46,9 @@ def setup_files(vendor_dir: Path) -> Path:
def read_icons(path: Path) -> list[str]:
return [
- line.strip()
- for line in path.read_text(encoding="utf-8").splitlines()
- if line.strip()
+ line
+ for raw in path.read_text(encoding="utf-8").splitlines()
+ if (line := raw.strip()) and not line.startswith("#")
]
diff --git a/static/admin/i18n.txt b/static/admin/i18n.txt
new file mode 100644
index 00000000..540a91b4
--- /dev/null
+++ b/static/admin/i18n.txt
@@ -0,0 +1,68 @@
+# List of i18n keys whose translated strings are rendered on admin HTML pages as a map for JS to use.
+
+# Globals.
+globals.buttons.back
+globals.buttons.cancel
+globals.buttons.ok
+globals.terms.bounce
+globals.terms.list
+globals.terms.user
+globals.terms.campaign
+globals.terms.subscribers
+globals.terms.subscriptions
+globals.terms.second
+globals.terms.minute
+globals.terms.hour
+globals.terms.day
+globals.terms.month
+globals.terms.year
+globals.fields.name
+globals.messages.copied
+globals.messages.confirm
+globals.messages.confirmDelete
+globals.messages.created
+globals.messages.deleted
+globals.messages.deletedCount
+globals.messages.done
+globals.messages.numSelected
+globals.messages.selectAll
+globals.messages.updated
+globals.messages.passwordChangeFull
+users.passwordMismatch
+campaigns.copyOf
+campaigns.confirmDelete
+campaigns.confirmSchedule
+campaigns.statusChanged
+campaigns.confirmSwitchFormat
+campaigns.confirmOverwriteContent
+campaigns.testSent
+lists.confirmDelete
+lists.confirmSub
+lists.optinTo
+lists.newList
+lists.optins.single
+lists.optins.double
+import.importStarted
+import.subscribeWarning
+import.recordsCount
+import.importDone
+import.stopImport
+public.sub
+public.subName
+subscribers.email
+subscribers.confirmDelete
+subscribers.confirmExport
+subscribers.confirmBlocklist
+subscribers.subscribersDeleted
+subscribers.listChangeApplied
+subscribers.sentOptinConfirm
+subscribers.invalidJSON
+subscribers.status.enabled
+subscribers.status.blocklisted
+subscribers.status.subscribed
+subscribers.status.unsubscribed
+subscribers.status.confirmed
+subscribers.status.unconfirmed
+settings.title
+settings.confirmRestart
+settings.smtp.testEnterEmail
diff --git a/static/admin/icons.txt b/static/admin/icons.txt
index 0e0e1393..035e9889 100644
--- a/static/admin/icons.txt
+++ b/static/admin/icons.txt
@@ -1,3 +1,4 @@
+# List of feathericons to be compiled into an SVG sprite.
activity
alert-triangle
arrow-down