Merge pull request #2693 from gradido/2366-devopsbackend-have-yarn-locales-fix-in-the-backend

feat(other): add locales check to backend and integrate it to test workflow

.github/workflows/test.yml

@@ -360,6 +360,25 @@ jobs:
       - name: backend | Lint
         run: docker run --rm gradido/backend:test yarn run lint
 
+  ##############################################################################
+  # JOB: LOCALES BACKEND #######################################################
+  ##############################################################################
+  locales_backend:
+    name: Locales - Backend
+    runs-on: ubuntu-latest
+    needs: [build_test_backend]
+    steps:
+      ##########################################################################
+      # CHECKOUT CODE ##########################################################
+      ##########################################################################
+      - name: Checkout code
+        uses: actions/checkout@v3
+      ##########################################################################
+      # LOCALES BACKEND #####################################################
+      ##########################################################################
+      - name: Backend | Locales
+        run: cd backend && yarn && yarn locales
+  
   ##############################################################################
   # JOB: LINT DATABASE UP ######################################################
   ##############################################################################

backend/package.json

@@ -15,7 +15,8 @@
     "lint": "eslint --max-warnings=0 --ext .js,.ts .",
     "test": "cross-env TZ=UTC NODE_ENV=development jest --runInBand --coverage --forceExit --detectOpenHandles",
     "seed": "cross-env TZ=UTC NODE_ENV=development ts-node -r tsconfig-paths/register src/seeds/index.ts",
-    "klicktipp": "cross-env TZ=UTC NODE_ENV=development ts-node -r tsconfig-paths/register src/util/klicktipp.ts"
+    "klicktipp": "cross-env TZ=UTC NODE_ENV=development ts-node -r tsconfig-paths/register src/util/klicktipp.ts",
+    "locales": "scripts/sort.sh"
   },
   "dependencies": {
     "@hyperswarm/dht": "^6.2.0",

backend/scripts/sort.sh

@@ -0,0 +1,25 @@
+#!/bin/bash
+
+ROOT_DIR=$(dirname "$0")/..
+
+tmp=$(mktemp)
+exit_code=0
+
+for locale_file in $ROOT_DIR/src/locales/*.json
+do
+  jq -f $(dirname "$0")/sort_filter.jq $locale_file > "$tmp"
+  if [ "$*" == "--fix" ]
+  then
+    mv "$tmp" $locale_file
+  else
+    if diff -q "$tmp" $locale_file > /dev/null ;
+    then
+      : # all good
+    else
+      exit_code=$?
+      echo "$(basename -- $locale_file) is not sorted by keys"
+    fi
+  fi
+done
+
+exit $exit_code

backend/scripts/sort_filter.jq

@@ -0,0 +1,13 @@
+def walk(f):
+  . as $in
+  | if type == "object" then
+      reduce keys_unsorted[] as $key
+        ( {}; . + { ($key):  ($in[$key] | walk(f)) } ) | f
+  elif type == "array" then map( walk(f) ) | f
+  else f
+  end;
+
+def keys_sort_by(f):
+  to_entries | sort_by(.key|f ) | from_entries;
+
+walk(if type == "object" then keys_sort_by(ascii_upcase) else . end)

backend/src/locales/de.json

@@ -1,10 +1,5 @@
 {
   "emails": {
-    "addedContributionMessage": {
-      "commonGoodContributionMessage": "du hast zu deinem Gemeinwohl-Beitrag „{contributionMemo}“ eine Nachricht von {senderFirstName} {senderLastName} erhalten.",
-      "subject": "Gradido: Nachricht zu deinem Gemeinwohl-Beitrag",
-      "toSeeAndAnswerMessage": "Um die Nachricht zu sehen und darauf zu antworten, gehe in deinem Gradido-Konto ins Menü „Gemeinschaft“ auf den Tab „Meine Beiträge zum Gemeinwohl“!"
-    },
     "accountActivation": {
       "duration": "Der Link hat eine Gültigkeit von {hours} Stunden und {minutes} Minuten. Sollte die Gültigkeit des Links bereits abgelaufen sein, kannst du dir hier einen neuen Link schicken lassen:",
       "emailRegistered": "deine E-Mail-Adresse wurde soeben bei Gradido registriert.",
@@ -19,6 +14,11 @@
       "onForgottenPasswordCopyLink": "oder kopiere den obigen Link in dein Browserfenster.",
       "subject": "Gradido: Erneuter Registrierungsversuch mit deiner E-Mail"
     },
+    "addedContributionMessage": {
+      "commonGoodContributionMessage": "du hast zu deinem Gemeinwohl-Beitrag „{contributionMemo}“ eine Nachricht von {senderFirstName} {senderLastName} erhalten.",
+      "subject": "Gradido: Nachricht zu deinem Gemeinwohl-Beitrag",
+      "toSeeAndAnswerMessage": "Um die Nachricht zu sehen und darauf zu antworten, gehe in deinem Gradido-Konto ins Menü „Gemeinschaft“ auf den Tab „Meine Beiträge zum Gemeinwohl“!"
+    },
     "contributionConfirmed": {
       "commonGoodContributionConfirmed": "dein Gemeinwohl-Beitrag „{contributionMemo}“ wurde soeben von {senderFirstName} {senderLastName} bestätigt und in deinem Gradido-Konto gutgeschrieben.",
       "subject": "Gradido: Dein Gemeinwohl-Beitrag wurde bestätigt"

backend/src/locales/en.json

@@ -1,10 +1,5 @@
 {
   "emails": {
-    "addedContributionMessage": {
-      "commonGoodContributionMessage": "you have received a message from {senderFirstName} {senderLastName} regarding your common good contribution “{contributionMemo}”.",
-      "subject": "Gradido: Message about your common good contribution",
-      "toSeeAndAnswerMessage": "To view and reply to the message, go to the “Community” menu in your Gradido account and click on the “My contributions to the common good” tab!"
-    },
     "accountActivation": {
       "duration": "The link has a validity of {hours} hours and {minutes} minutes. If the validity of the link has already expired, you can have a new link sent to you here:",
       "emailRegistered": "Your email address has just been registered with Gradido.",
@@ -19,6 +14,11 @@
       "onForgottenPasswordCopyLink": "or copy the link above into your browser window.",
       "subject": "Gradido: Try To Register Again With Your Email"
     },
+    "addedContributionMessage": {
+      "commonGoodContributionMessage": "you have received a message from {senderFirstName} {senderLastName} regarding your common good contribution “{contributionMemo}”.",
+      "subject": "Gradido: Message about your common good contribution",
+      "toSeeAndAnswerMessage": "To view and reply to the message, go to the “Community” menu in your Gradido account and click on the “My contributions to the common good” tab!"
+    },
     "contributionConfirmed": {
       "commonGoodContributionConfirmed": "Your public good contribution “{contributionMemo}” has just been confirmed by {senderFirstName} {senderLastName} and credited to your Gradido account.",
       "subject": "Gradido: Your contribution to the common good was confirmed"