Localizing Dates in Go Templates: A Deep Dive

Introduction

In the devlog-ist/landing project, we recently tackled an interesting challenge: ensuring post publication dates were correctly localized across all portfolio themes. This involved making sure that month names and other date elements respected the application's locale, as set by the SetLocale middleware. The fix centered around using translatedFormat() instead of format() within the Go templates.

The Problem: Inconsistent Date Formatting

The initial implementation used Go's format() function to display post dates. While this worked fine for the default locale, it failed to adapt when users switched to different languages. For instance, month names would remain in English even when the application was set to display in French or Spanish.

The Solution: translatedFormat()

The key to solving this was the translatedFormat() function. This function, unlike format(), is locale-aware. It retrieves the translated month names and other date elements from the application's localization resources, ensuring that the dates are displayed correctly in the user's chosen language.

Here's a simplified example of how the change was implemented within the Go templates:

{{/* Before */}}
<time datetime="{{ .Date.Format "2006-01-02" }}">{{ .Date.Format "January 2, 2006" }}</time>

{{/* After */}}
<time datetime="{{ .Date.Format "2006-01-02" }}">{{ .Date.translatedFormat "January 2, 2006" }}</time>

In this example, replacing .Date.Format with .Date.translatedFormat ensures that the month name ("January") is rendered according to the current locale.

Impact and Benefits

This seemingly small change has a significant impact on the user experience. By correctly localizing dates, we provide a more seamless and intuitive experience for users from different regions. It also enhances the overall professionalism and polish of the devlog-ist/landing project.

Conclusion

When working with dates in Go templates, remember to use translatedFormat() instead of format() to ensure proper localization. This simple change can greatly improve the user experience for international audiences.