Ensuring Global Reach: Maintaining Translation Parity in Your ESHOPMAN Admin Dashboard

The Global Promise of ESHOPMAN: A Community Insight

ESHOPMAN, as a powerful headless commerce platform deeply integrated with HubSpot, empowers merchants to manage their storefronts globally. A core part of this global reach is robust internationalization (i18n), ensuring that the Admin Dashboard – where merchants configure and manage their ESHOPMAN store within the HubSpot application – is accessible and intuitive in multiple languages. Recently, our community highlighted a crucial discussion regarding translation parity, offering valuable insights into maintaining a consistent user experience for all ESHOPMAN users.

The Challenge: A Disparity in Translations

A significant challenge was identified concerning the Macedonian translation file (mk.json) within the ESHOPMAN Admin Dashboard. It was found to be missing a substantial number of 'leaf keys' – specific translation strings – that were present in the base English file (en.json). This wasn't merely a minor oversight; the discrepancy amounted to 583 missing keys, leading to a noticeable gap in translated content for users operating the Admin Dashboard in Macedonian.

Understanding the Root Cause

The primary reason for this translation gap stemmed from the continuous evolution of the ESHOPMAN platform. As new features were integrated – such as advanced balance settlement options, enhanced search indexes, comprehensive inventory export functionalities, and dynamic quantity pricing models – their corresponding English translation keys were added. However, the Macedonian translation file was not updated concurrently, causing the accumulation of untranslated UI elements and functionalities for that specific locale. This highlights a common hurdle in rapidly developing platforms built on Node.js/TypeScript like ESHOPMAN, where feature velocity can sometimes outpace translation efforts.

The ESHOPMAN Solution: Leveraging Validation Tools

The ESHOPMAN community swiftly moved to address this. The first step involved identifying the exact scope of the problem using a dedicated validation tool. Developers working with ESHOPMAN's codebase can utilize a specific command to check for translation parity:

yarn i18n:validate mk.json

This command is instrumental in verifying that all translation files maintain the same set of keys as the base language, ensuring no UI elements are left untranslated or display incorrect placeholders. The output of this validation clearly showed the 583 missing keys, providing concrete evidence of the disparity.

Community-Driven Resolution and Best Practices

To resolve the issue, a community member proposed a dedicated translation effort. The plan was to create a focused update that would exclusively add the missing 583 keys, translated into natural Macedonian while meticulously matching the existing terminology and style of the file. This approach ensures linguistic consistency and avoids introducing any other unrelated changes.

The successful resolution of this issue underscores a vital best practice for ESHOPMAN developers and contributors: when implementing new features or extending the platform via the Admin API or Store API, always consider the internationalization implications from the outset. Regular use of validation tools like yarn i18n:validate is crucial to prevent translation gaps from accumulating. By proactively maintaining translation parity, the ESHOPMAN community ensures that every merchant, regardless of their preferred language, experiences a seamless, fully localized, and high-quality Admin Dashboard experience within the HubSpot application, supporting their journey in headless commerce deployed through HubSpot CMS.

Start with the tools

Explore migration tools

See options, compare methods, and pick the path that fits your store.

Explore migration tools