Extracted translations and added translation settings

# Conflicts:
#	.github/workflows/pr.yaml
#	CHANGELOG.md
#	composer.lock

Author: rimi-itk

.github/workflows/pr.yaml

@@ -372,3 +372,23 @@ jobs:
       - name: Reverse patch
         run: |
           docker compose exec phpfpm patch --strip=1 --verbose --input=${{ matrix.patch }} --reverse
+
+  check-translations:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: arduino/setup-task@v2
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Install site
+        run: |
+          docker network create frontend
+          task site-install --yes
+
+      - name: Extract translations
+        run: |
+          task translations:extract
+
+      - run: |
+          task translations:diff

.gitignore

@@ -45,3 +45,5 @@ private-files
 /playwright/.cache/
 
 config/sync/**/webform.webform.*
+
+web/*/custom/*/translations/*.*.mo

CHANGELOG.md

@@ -6,6 +6,8 @@ Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+* [PR-468](https://github.com/itk-dev/hoeringsportal/pull/468)
+  Added module and theme translations
 * [PR-428](https://github.com/itk-dev/hoeringsportal/pull/428)
   Upgraded to PHP 8.4
 * [PR-494](https://github.com/itk-dev/hoeringsportal/pull/494)

Taskfile.yml

@@ -13,6 +13,12 @@ vars:
   PRETIX_URL: '{{.TASK_PRETIX_URL | default "http://pretix.hoeringsportal.local.itkdev.dk"}}'
   PRETIX_ORGANIZER: '{{.TASK_PRETIX_ORGANIZER | default "dpl-cms"}}'
 
+  CUSTOM_MODULES:
+    sh: ls web/modules/custom/*/*.info.yml | xargs basename -s '.info.yml'
+
+  CUSTOM_THEMES:
+    sh: ls web/themes/custom/*/*.info.yml | xargs basename -s '.info.yml'
+
 tasks:
   default:
     cmds:
@@ -52,12 +58,13 @@ tasks:
 
   site-open:
     cmds:
-      - if command -v open 2>&1 >/dev/null; then open "$(task site-url)"; else echo "$(task site-url)"; fi
+      # `open` is defined in GitHub Actions (ubuntu-latest), but cannot actually be run without error. Therefore we add `|| true` to prevent errors.
+      - if command -v open 2>&1 >/dev/null; then open "$(task site-url)" || true; else echo "$(task site-url)"; fi
     silent: true
 
   site-open-admin:
     cmds:
-      - if command -v open 2>&1 >/dev/null; then open "{{.URL}}"; else echo "{{.URL}}"; fi
+      - if command -v open 2>&1 >/dev/null; then open "{{.URL}}" || true; else echo "{{.URL}}"; fi
     vars:
       URL:
         sh: task drush -- user:login --no-browser
@@ -258,3 +265,79 @@ tasks:
       # https://www.drupal.org/project/drupal/issues/3496223
       - 'task compose -- exec phpfpm sed -i "s/Plural-Forms: nplurals=2; plural=(n > 1);/Plural-Forms: nplurals=2; plural=(n != 1);/" translations/custom-translations.da.po'
     silent: true
+
+  translations:extract:modules:
+    cmds:
+      # https://github.com/go-task/task/discussions/1543
+      - for:
+          matrix:
+            MODULE:
+              ref: .CUSTOM_MODULES
+            LANGUAGE:
+              - da
+        cmd: |
+          task drush -- potx single --folder=modules/custom/{{.ITEM.MODULE}}/ --language {{.ITEM.LANGUAGE}} --translations && \
+          mkdir -p web/modules/custom/{{.ITEM.MODULE}}/translations && \
+          mv web/general.pot web/modules/custom/{{.ITEM.MODULE}}/translations/{{.ITEM.MODULE}}.{{.ITEM.LANGUAGE}}.po
+    internal: true
+
+  translations:extract:themes:
+    cmds:
+      # https://github.com/go-task/task/discussions/1543
+      - for:
+          matrix:
+            THEME:
+              ref: .CUSTOM_THEMES
+            LANGUAGE:
+              - da
+        # `drush potx` always writes to web/general.pot, so we move this file
+        # into the desired destination in the `translations` folder inside the
+        # module folder.
+        cmd: |
+          task drush -- potx single --folder=themes/custom/{{.ITEM.THEME}}/ --language {{.ITEM.LANGUAGE}} --translations && \
+          mkdir -p web/themes/custom/{{.ITEM.THEME}}/translations && \
+          mv web/general.pot web/themes/custom/{{.ITEM.THEME}}/translations/{{.ITEM.THEME}}.{{.ITEM.LANGUAGE}}.po
+    internal: true
+
+  translations:diff:
+    cmds:
+      # Ignore some PO metadata when git diff'ing, e.g.
+      #
+      # "POT-Creation-Date: 2025-03-12 18:18+0100\n"
+      # "PO-Revision-Date: 2025-03-12 18:18+0100\n"
+      - git diff --exit-code --ignore-blank-lines --ignore-matching-lines='^"PO.*-Date' web/*/custom/*/translations
+
+  translations:extract:
+    cmds:
+      - task drush -- --yes pm:install potx
+      - task: translations:extract:modules
+      - task: translations:extract:themes
+      - task drush -- --yes pm:uninstall potx
+    silent: true
+
+  # @todo Can we use `drush locale:check` and/or `drush locale:update` to update
+  # module translations without overriding existing translations?
+  # @todo Do we want to override (existing) translations?
+  translations:import:modules:
+    cmds:
+      - for:
+          matrix:
+            MODULE:
+              ref: .CUSTOM_MODULES
+        cmd: task drush -- locale:import-all --override=none modules/custom/{{.ITEM.MODULE}}/translations/
+    silent: true
+
+  translations:import:themes:
+    cmds:
+      - for:
+          matrix:
+            THEME:
+              ref: .CUSTOM_THEMES
+        cmd: task drush -- locale:import-all --override=none themes/custom/{{.ITEM.THEME}}/translations/
+    silent: true
+
+  translations:import:all:
+    cmds:
+      - task: translations:import:modules
+      - task: translations:import:themes
+    silent: true

composer.json

@@ -84,6 +84,7 @@
         "drupal/content_fixtures": "dev-3498162-not-compatible-with",
         "drupal/core-dev": "^10.0",
         "drupal/masquerade": "^2.0",
+        "drupal/potx": "^1.1",
         "drupal/webprofiler": "^10.3",
         "ergebnis/composer-normalize": "^2.44",
         "mglaman/phpstan-drupal": "^1.1",

documentation/Translation.md

@@ -0,0 +1,19 @@
+# Translation
+
+We use [Translation template extractor](https://www.drupal.org/project/potx) to extract translations from custom modules
+and themes.
+
+We use the `interface translation` stuff defined in
+[locale.api.php](https://git.drupalcode.org/project/drupal/-/blob/11.x/core/modules/locale/locale.api.php).
+
+Extract translations by running
+
+``` shell name=translations:extract
+task translations:extract
+```
+
+Import (extracted) translations by running
+
+``` shell name=translations:import:all
+task translations:import:all
+```

web/modules/custom/hoeringsportal_citizen_proposal/hoeringsportal_citizen_proposal.info.yml

@@ -6,3 +6,7 @@ core_version_requirement: ^8.8 || ^9 || ^10
 dependencies:
   - twig_tweak:twig_tweak
   - drupal:symfony_mailer
+
+# https://git.drupalcode.org/project/drupal/-/blob/11.x/core/modules/locale/locale.api.php
+'interface translation project': hoeringsportal_citizen_proposal
+'interface translation server pattern': modules/custom/%project/translations/%project.%language.po