feat/df-1065: Welsh translation for plugin by jbarnsley10 · Pull Request #436 · DEFRA/forms-engine-plugin

jbarnsley10 · 2026-06-29T10:58:04Z

Proposed change

Welsh translation for plugin

Jira ticket: DF-1065

Type of change

Bug fix
New feature
Breaking change
Misc. (documentation, build updates, etc)

Checklist

You have executed this code locally and it performs as expected.
You have added tests to verify your code works.
You have added code comments and JSDoc, where appropriate.
There is no commented-out code.
You have added developer docs in README.md and docs/* (where appropriate, e.g. new features).
The tests are passing (npm run test).
The linting checks are passing (npm run lint).
The code has been formatted (npm run format).

Adds buildValidationMessages(t) — a factory that accepts a language-bound translation function and returns a set of Joi message templates (JoiExpressions for lowerFirst-containing strings, plain template strings for the rest). Also adds require('@defra/forms-model') to jest.setup.cjs to align Joi's internal Symbol state across the babel-jest ESM/CJS module boundary; without this, JoiExpression objects fail Template.isTemplate() checks inside Joi's .messages() method when resetModules: true clears the registry between tests.

…Field strings

…ent strings

…calls

…s globals cast

…key, lang) Remove the lang parameter from getValidationConfig/getErrorTemplates in NationalGridFieldNumberField and OsGridRefField; fix LocationFieldBase constructor call that was passing model.language as an argument. Static getAllPossibleErrors() now constructs the result directly using the module-level t() at en-GB, matching the pattern used by EastingNorthingField.

…l.language) Remove free t() import from all five page controllers; replace every t(key, lang/this.model.language, opts) call with this.model.t(key, opts). Includes getBackLink lang var removal and all RepeatPageController list-summary translation calls.

The two inline controller.model mocks in the dispatcher error tests were missing the t() method after PaymentField.ts was updated to call model.t() instead of the free t(key, lang) function.

Adds x-pirate locale (arrr), registers it in i18next, and wires up simple-form-pirate.yaml in localFormsService. Visit /simple-form-pirate to experience the high seas.

Apply pirate flavour to every remaining bland key — date field labels, lat/long errors, address fields, button labels, repeater actions, and payment strings. Comedy matters everywhere.

…-engine-plugin into feature/i18n-linting

Scullyon

Looks good from the parts that I've looked at!

Would be good to have some docs when you're happy with the solution and perhaps some diagrams.

Question about the translation caching: does it cache translations per form until the service is restarted? If so, when we start serving thousands of forms, is there a risk to memory?

Scullyon · 2026-07-13T09:57:17Z

+      "added_other": "Ychwanegwyd [[count]] lleoliad",
+      "validation": {
+        "descriptionRequired": "Rhowch ddisgrifiad ar gyfer lleoliad [[count]]",
+        "wrongCountry": "Rhaid i leoliad [[count]] fod y tu mewn i [[country]]"


This is missing from the en-GB lookup. Perhaps a tool is required to scan the source code, extract all the required keys and then highlight any missing gaps?

Scullyon · 2026-07-13T10:09:14Z

          {{ govukButton({
-            text: "Pay and submit" if paymentPending else ("Accept and submit" if isDeclaration else "Submit"),
-            classes: "prevent-multiple-clicks",
+            text: t('pages.summary.acceptAndSubmit') if isDeclaration else t('pages.summary.submit'),


Is this supposed to reduce the conditions here (eg if paymentPending is gone)?

Corrected logic. Somehow the additional condition got lost

Scullyon · 2026-07-13T10:43:50Z

+  return i18next.t(key, { lng: language, ...options })
+}
+
+export function createFormI18nInstance(formEnGb: BaseTranslations) {


When you're nearly done and happy with everything, it would be good to get some useful doc-comments on functions.

Added a few doc comments as well as the READMEs

Scullyon · 2026-07-13T13:37:43Z

Looks good from the parts that I've looked at!

Would be good to have some docs when you're happy with the solution and perhaps some diagrams.

Question about the translation caching: does it cache translations per form until the service is restarted? If so, when we start serving thousands of forms, is there a risk to memory?

Have just seen that you've added a Markdown doc file, will take a look.

alexluckett

Since component method signatures require a Translator and FormDefinitionTranslations, it's worth adding both of those to src/server/plugins/engine/types/index.ts so they become importable by a consumer via the import from ./types.

docs/features/code-based/page-controllers.md needs updating to show the new getViewModel signature (with the new translator instance)

alexluckett · 2026-07-14T13:29:26Z

+  const language =
+    (yar.get('language') as string | undefined) ?? options.language ?? 'en-GB'
+  const translator = formModel.createTranslator(language)


this needs updating to use the new getLanguage hook that the plugin consumer provides. They might not store the language in yar.

const language = resolveLanguage(summaryRequest)

alexluckett · 2026-07-14T13:43:23Z


-  return getAnswer(/** @type {Field} */ (component), context.relevantState)
+  const field = /** @type {Field} */ (component)
+  const translator = field.model.createTranslator()


this will default to english as createTranslator receives no language preference, we need to use the translator already provided.

we should be able to change change this to const { translator } = context rather than creating a new one

Changed, plus also left in a fallback

alexluckett · 2026-07-14T13:46:07Z


-  const answer = getAnswer(component as Field, globals.context.relevantState)
+  const field = component as Field
+  const translator = field.model.createTranslator()


this will default to english as createTranslator receives no language preference, we need to use the translator already provided.

we should be able to change change this to const { translator } = globals.context rather than creating a new one

Changed, plus also left in a fallback

alexluckett · 2026-07-14T13:46:31Z

    | undefined
 }
-
-export function setPageTitles(def: FormDefinition) {


removed on purpose?

Yes. The logic that handles 'page title' vs 'first question title' (for translation purposes) needs to know if the page title is set in the definition, or left blank. The call to setPageTitles was masking this so it was impossible to tell if the page title was originally blank.
The logic has moved elsewhere so the translator can determine which part to translate.

alexluckett · 2026-07-14T13:47:46Z

+    item: Item,
+    prop: keyof EntityTranslations['listItems'][string]
+  ) => string
+  language: string


language can be removed, it's unused

Done. It is used in runner, but I could extend the type in runner as not used in plugin

sonarqubecloud · 2026-07-16T11:50:21Z

Quality Gate passed

Issues
0 New issues
8 Accepted issues

Measures
0 Security Hotspots
92.3% Coverage on New Code
2.2% Duplication on New Code

See analysis details on SonarQube Cloud

alexluckett added 30 commits April 16, 2026 19:41

feat(i18n): finalise en-GB translation file with all template strings

3da1cf1

feat(i18n): add i18next module with en-GB initialisation and t() wrapper

05b0179

feat(i18n): add language and validationMessages to FormModel

475b583

feat(i18n): rebuild messageTemplate from buildValidationMessages factory

6653669

feat(i18n): translate DatePartsField and MonthYearField sub-labels

524efd3

feat(i18n): translate UkAddressField sub-labels

655f133

feat(i18n): translate LatLongField and EastingNorthingField strings

4174c73

feat(i18n): translate LocationFieldBase, NationalGridField, OsGridRef…

e4811d3

…Field strings

feat(i18n): translate DeclarationField and GeospatialField strings

a7632e9

feat(i18n): translate PaymentField and FileUploadField runtime strings

c41db71

feat(i18n): translate optionalText in FormComponent.getViewModel

2c21615

feat(i18n): translate SummaryViewModel and SummaryPageController paym…

0fd0c4f

…ent strings

feat(i18n): translate all RepeatPageController hardcoded strings

94e3bca

feat(i18n): register t() as Nunjucks global with en-GB fallback

1f1cb2c

feat(i18n): wire per-request t() into all page controller view models

74bd913

feat(i18n): replace all hardcoded strings in HTML templates with t() …

3fbb5ca

…calls

feat(i18n): fix TypeScript errors — JSON import attribute and Nunjuck…

5083ad3

…s globals cast

Add missing translations

84d6a4d

wire in remaining translation keys

f2362d2

move component errors into component block

065ffc6

feat(i18n): add FormModel.t() method — language-bound translation helper

13d06d0

docs(i18n): document FormModel.t() language-binding intent

f666c5a

fix(test): add model.t() to PaymentField dispatcher test mocks

0c8c1bf

The two inline controller.model mocks in the dispatcher error tests were missing the t() method after PaymentField.ts was updated to call model.t() instead of the free t(key, lang) function.

Add translation helper in model to reduce repeated language prop access

77a8200

refactor(i18n): SummaryViewModel uses model.t() instead of t(key, lang)

874f604

feat(i18n): add pirate translation and simple-form-pirate demo

14f1ba1

Adds x-pirate locale (arrr), registers it in i18next, and wires up simple-form-pirate.yaml in localFormsService. Visit /simple-form-pirate to experience the high seas.

feat(i18n): fully pirate all keys in x-pirate translation

46f372e

Apply pirate flavour to every remaining bland key — date field labels, lat/long errors, address fields, button labels, repeater actions, and payment strings. Comedy matters everywhere.

davidjamesstone and others added 18 commits July 2, 2026 12:20

Add context to the status page view model

7068d03

Handles hint for list items

196d135

Merge branch 'main' into feature/i18n-linting

dc56e76

Handles multi-language for Markdown

42ae8a8

Add createFormTranslator helper

156bca6

Merge branch 'feature/i18n-linting' of https://github.com/defra/forms…

a383b54

…-engine-plugin into feature/i18n-linting

Fixed linting errors

3129cf7

Passes metadata into FormModel for translator

03af5b0

Handles metadata child structures

ed4b9cc

Translates all entries in confirmation page

bfe275a

Removed metadata param for translator

51c4ea1

Resolved test issues

4456ecb

Corrected params for getLanguage

f9468aa

Possible fix for page/component titles

6d51c2c

Fixed page title logic

0f3597f

Handles submission guidance

b12ddb0

Corrected status page flow

17b4a67

Added doc file

0d68e89

jbarnsley10 mentioned this pull request Jul 13, 2026

DF-1069: feature/i18n-welsh DEFRA/forms-runner#1242

Open

Scullyon reviewed Jul 13, 2026

View reviewed changes

jbarnsley10 added 2 commits July 13, 2026 16:30

After review

f49dbf0

Fixed parent title override

c88728b

alexluckett reviewed Jul 14, 2026

View reviewed changes

jbarnsley10 added 5 commits July 15, 2026 15:24

Changes after review

97bdb08

Reinstated language as property of translator

14d7460

Added extra type exports

2043ae2

Updated docs

fd3b3d7

Corrected language list

0e15142

Uh oh!

Conversation

jbarnsley10 commented Jun 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed change

Type of change

Checklist

Uh oh!

Scullyon left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Scullyon commented Jul 13, 2026

Uh oh!

alexluckett left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alexluckett Jul 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud Bot commented Jul 16, 2026

Quality Gate passed

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

jbarnsley10 commented Jun 29, 2026 •

edited

Loading

alexluckett Jul 14, 2026 •

edited

Loading