Build translations from Markdown files

.gitignore

@@ -1,6 +1,7 @@
 .DS_Store
 node_modules
 /dist
+/build
 
 # local env files
 .env.local

Dockerfile

@@ -2,7 +2,7 @@
 FROM node:10 as build-stage
 COPY ./ /app
 WORKDIR /app
-RUN yarn install && yarn run build
+RUN yarn install && yarn run dumpLangFiles && cp /app/build/lang/* /app/src/lang && yarn run build
 
 FROM nginx:stable-alpine
 RUN mkdir /app

bin/compile-lang-jsons.js

@@ -0,0 +1,87 @@
+/* eslint-disable no-console */
+const fs = require('fs')
+
+const destPath = './build/translations'
+
+fs.mkdirSync(destPath, { recursive: true })
+
+const langs = fs.readdirSync('./translations', { withFileTypes: true })
+langs.forEach((entry) => {
+  if (!entry.isDirectory()) {
+    return
+  }
+
+  handleLang(entry.name)
+})
+
+function handleLang (lang) {
+  console.log(`Compiling language JSON for locale '${lang}'`)
+
+  const path = `./src/lang/${lang}.json`
+
+  if (!fs.existsSync(path)) {
+    console.error(`Could not find language JSON for locale '${lang}'`)
+    process.exit(1)
+  }
+
+  const messages = JSON.parse(fs.readFileSync(path, 'utf8'))
+
+  messages.events = buildLangEntries(lang, 'events', parseEventFile)
+  messages.locations = buildLangEntries(lang, 'locations', parseLocationFile)
+
+  const langDestPath = `${destPath}/${lang}.json`
+
+  fs.writeFileSync(langDestPath, JSON.stringify(messages, undefined, 4))
+
+  console.log(`Wrote language JSON for locale '${lang}' to '${langDestPath}'`)
+}
+
+function buildLangEntries (lang, type, parser) {
+  const dirPath = `./lang/${lang}/${type}`
+
+  if (!fs.existsSync(dirPath)) {
+    return undefined
+  }
+
+  const result = {}
+
+  console.log(`Compiling translations of ${type} for locale '${lang}'...`)
+
+  fs.readdirSync(dirPath, { withFileTypes: true }).filter(e => e.isFile() && e.name.endsWith('.md')).forEach((entry) => {
+    const entryId = entry.name.substring(0, entry.name.lastIndexOf('.md'))
+
+    result[entryId] = parser(lang, entryId, fs.readFileSync(`${dirPath}/${entry.name}`, 'utf8'))
+  })
+
+  return result
+}
+
+function parseEventFile (lang, id, content) {
+  if (!content.startsWith('#')) {
+    console.error(`Translation of event ${id} for locale '${lang}' does not start with name as Markdown heading`)
+    process.exit(1)
+  }
+
+  const firstNewLine = content.indexOf('\n')
+
+  const name = content.substring(1, firstNewLine).trim()
+  const detailsHeadingPos = content.indexOf('\n## Details')
+  const blurb = content.substring(firstNewLine, detailsHeadingPos !== -1 ? detailsHeadingPos : undefined).trim()
+  const details = detailsHeadingPos !== -1 ? content.substring(content.indexOf('\n', detailsHeadingPos + 1)).trim() : undefined
+
+  return { name, blurb, details }
+}
+
+function parseLocationFile (lang, id, content) {
+  if (!content.startsWith('#')) {
+    console.error(`Translation of location ${id} for locale '${lang}' does not start with name as Markdown heading`)
+    process.exit(1)
+  }
+
+  const firstNewLine = content.indexOf('\n')
+
+  const name = content.substring(1, firstNewLine).trim()
+  const details = content.substring(firstNewLine).trim()
+
+  return { name, details }
+}

bin/dump-lang-files.js

@@ -0,0 +1,34 @@
+/* eslint-disable no-console */
+const fs = require('fs')
+
+const events = JSON.parse(fs.readFileSync('./src/store/events.json', 'utf8'))
+events.forEach((event) => {
+  const path = `./translations/en/events/${event.id}.md`
+
+  if (fs.existsSync(path)) {
+    return
+  }
+
+  let data = `# ${event.id}\nBlurb\n`
+
+  if (event.details) {
+    data += '\n## Details\nDetails\n'
+  }
+
+  fs.writeFileSync(path, data)
+
+  console.log(`Created new translation file for event ${event.id}`)
+})
+
+const locations = JSON.parse(fs.readFileSync('./src/store/locations.json', 'utf8'))
+Object.values(locations).forEach((location) => {
+  const path = `./translations/en/locations/${location.id}.md`
+
+  if (fs.existsSync(path)) {
+    return
+  }
+
+  fs.writeFileSync(path, `# ${location.id}\nDetails\n`)
+
+  console.log(`Created new translation file for location ${location.id}`)
+})

package.json

@@ -5,7 +5,9 @@
   "scripts": {
     "serve": "vue-cli-service serve",
     "build": "vue-cli-service build",
-    "lint": "vue-cli-service lint"
+    "lint": "vue-cli-service lint",
+    "dumpLangFiles": "node ./bin/dump-lang-files.js",
+    "compileLangJsons": "node ./bin/compile-lang-jsons.js"
   },
   "dependencies": {
     "@johmun/vue-tags-input": "^2.1.0",

src/lang/de.json

@@ -28,10 +28,5 @@
         "ed": "Die Tänzerin am Abgrund",
         "ob": "Der Ruf der Klingen & Die Splitter der Macht",
         "row": "Rhythm of War"
-    },
-    "events": {
-        "shattering": {
-            "name": "Shattering of Adonalsium"
-        }
     }
 }

src/lang/en.json

@@ -33,96 +33,5 @@
         "ed": "Edgedancer",
         "ob": "Oathbringer",
         "row": "Rhythm of War"
-    },
-    "events": {
-        "shattering": {
-            "name": "Shattering of Adonalsium",
-            "blurb": "Adonalsium was shattered into 16 Shards at this event"
-        },
-        "ashyn-exodus": {
-            "name": "Exodus from Ashyn"
-        }
-    },
-    "locations": {
-        "alethkar": {
-            "name": "Alethkar",
-            "details": "Alethkar is the largest and most prominent of the five Vorin nations on Roshar. People from Alethkar are known as Alethi, and their royal colors are blue and gold. Prior to the True Desolation, they were engaged in the War of Reckoning against the listeners. At the present, vast majority of their territory is under control of the Voidbringers."
-        },
-        "jah-keved": {
-            "name": "Jah Keved"
-        },
-        "herdaz": {
-            "name": "Herdaz"
-        },
-        "kharbranth": {
-            "name": "Kharbranth",
-            "details": "Kharbranth, City of Bells, is an independent city-state on Roshar, ruled by King Taravangian. It is one of the five Vorin nations and home to the Palanaeum, the largest library on Roshar. Kharbranth is known for the quality of its hospitals, and people come from all over the world to study medicine from Kharbranth's surgeons. The Kharbranthian royal colors are burnt orange and white, and have become synonymous around Roshar as the colors of surgeons, medicine, and healing."
-        },
-        "thaylenah": {
-            "name": "Thaylenah"
-        },
-        "azir": {
-            "name": "Azir"
-        },
-        "shinovar": {
-            "name": "Shinovar"
-        },
-        "aimia": {
-            "name": "Aimia"
-        },
-        "iri": {
-            "name": "Iri"
-        },
-        "rira": {
-            "name": "Rira"
-        },
-        "reshi-isles": {
-            "name": "Reshi Isles"
-        },
-        "urithiru": {
-            "name": "Urithiru"
-        },
-        "shattered-plains": {
-            "name": "The Shattered Plains"
-        },
-        "tashikk": {
-            "name": "Tashikk"
-        },
-        "emul": {
-            "name": "Emul"
-        },
-        "tukar": {
-            "name": "Tukar"
-        },
-        "marat": {
-            "name": "Marat"
-        },
-        "liafor": {
-            "name": "Liafor"
-        },
-        "babatharnam": {
-            "name": "Babatharnam"
-        },
-        "marabethia": {
-            "name": "Marabethia"
-        },
-        "purelake": {
-            "name": "Purelake"
-        },
-        "kholinar": {
-            "name": "Kholinar"
-        },
-        "rathalas": {
-            "name": "Rathalas"
-        },
-        "new-natanatan": {
-            "name": "New Natanatan"
-        },
-        "thaylen-city": {
-            "name": "Thaylen City"
-        },
-        "valley": {
-            "name": "The Valley"
-        }
     }
 }

translations/en/events/adolin-birth.md

@@ -0,0 +1,6 @@
+# adolin-birth
+
+Blurb
+
+## Details
+Adolin was born in 1120, like the good lad that he is

translations/en/events/ashyn-exodus.md

@@ -0,0 +1,2 @@
+# ashyn-exodus
+Blurb

translations/en/events/conquest-of-alethkar.md

@@ -0,0 +1,2 @@
+# conquest-of-alethkar
+Blurb

translations/en/events/dalinar-birth.md

@@ -0,0 +1,2 @@
+# dalinar-birth
+Blurb

translations/en/events/dalinar-nightwatcher.md

@@ -0,0 +1,2 @@
+# dalinar-nightwatcher
+Blurb

translations/en/events/dalinar-opens-honors-perpendicularity.md

@@ -0,0 +1,2 @@
+# dalinar-opens-honors-perpendicularity
+Blurb

translations/en/events/dalinar-wins-oathbringer.md

@@ -0,0 +1,2 @@
+# dalinar-wins-oathbringer
+Blurb

translations/en/events/discovery-of-parshendi.md

@@ -0,0 +1,2 @@
+# discovery-of-parshendi
+Blurb

translations/en/events/end-of-hierocracy.md

@@ -0,0 +1,2 @@
+# end-of-hierocracy
+Blurb

translations/en/events/evi-death.md

@@ -0,0 +1,2 @@
+# evi-death
+Blurb

translations/en/events/false-desolation.md

@@ -0,0 +1,2 @@
+# false-desolation
+Blurb

translations/en/events/founding-knights-radiant.md

@@ -0,0 +1,2 @@
+# founding-knights-radiant
+Blurb

translations/en/events/gavilar-assassination.md

@@ -0,0 +1,2 @@
+# gavilar-assassination
+Blurb

translations/en/events/gavilar-coronation.md

@@ -0,0 +1,2 @@
+# gavilar-coronation
+Blurb

translations/en/events/kaladin-birth.md

@@ -0,0 +1,2 @@
+# kaladin-birth
+Blurb

translations/en/events/kaladin-joins-army.md

@@ -0,0 +1,2 @@
+# kaladin-joins-army
+Blurb

translations/en/events/kaladin-kills-helaran.md

@@ -0,0 +1,2 @@
+# kaladin-kills-helaran
+Blurb

translations/en/events/last-desolation.md

@@ -0,0 +1,2 @@
+# last-desolation
+Blurb

translations/en/events/lin-davar-murder.md

@@ -0,0 +1,2 @@
+# lin-davar-murder
+Blurb

translations/en/events/roshone-arrival.md

@@ -0,0 +1,2 @@
+# roshone-arrival
+Blurb

translations/en/events/scouring-of-amia.md

@@ -0,0 +1,2 @@
+# scouring-of-amia
+Blurb

translations/en/events/shallan-arrives-in-kharbranth.md

@@ -0,0 +1,2 @@
+# shallan-arrives-in-kharbranth
+Blurb

translations/en/events/shallan-birth.md

@@ -0,0 +1,2 @@
+# shallan-birth
+Blurb

translations/en/events/shallan-kills-father.md

@@ -0,0 +1,2 @@
+# shallan-kills-father
+Blurb

translations/en/events/shallan-kills-mother.md

@@ -0,0 +1,2 @@
+# shallan-kills-mother
+Blurb

translations/en/events/shattering.md

@@ -0,0 +1,2 @@
+# shattering
+Blurb

translations/en/events/surgeon-training-begins.md

@@ -0,0 +1,2 @@
+# surgeon-training-begins
+Blurb

translations/en/events/szeth-named-truthless.md

@@ -0,0 +1,2 @@
+# szeth-named-truthless
+Blurb

translations/en/events/taravangian-acquires-oathstone.md

@@ -0,0 +1,2 @@
+# taravangian-acquires-oathstone
+Blurb

translations/en/events/taravangian-nightwatcher.md

@@ -0,0 +1,2 @@
+# taravangian-nightwatcher
+Blurb

translations/en/events/the-gang-is-in-shadesmar.md

@@ -0,0 +1,2 @@
+# the-gang-is-in-shadesmar
+Blurb

translations/en/events/tien-death.md

@@ -0,0 +1,2 @@
+# tien-death
+Blurb

translations/en/locations/aimia.md

@@ -0,0 +1,2 @@
+# Aimia
+Details

translations/en/locations/alethkar.md

@@ -0,0 +1,2 @@
+# Alethkar
+Details

translations/en/locations/azir.md

@@ -0,0 +1,2 @@
+# Azir
+Details

translations/en/locations/babatharnam.md

@@ -0,0 +1,2 @@
+# Babatharnam
+Details

translations/en/locations/emul.md

@@ -0,0 +1,2 @@
+# Emul
+Details

translations/en/locations/herdaz.md

@@ -0,0 +1,2 @@
+# Herdaz
+Details

translations/en/locations/iri.md

@@ -0,0 +1,2 @@
+# Iri
+Details

translations/en/locations/jah-keved.md

@@ -0,0 +1,2 @@
+# Jah Keved
+Details

translations/en/locations/kharbranth.md

@@ -0,0 +1,2 @@
+# Kharbranth
+Details

translations/en/locations/kholinar.md

@@ -0,0 +1,2 @@
+# Kholinar
+Details

translations/en/locations/liafor.md

@@ -0,0 +1,2 @@
+# Liafor
+Details

translations/en/locations/marabethia.md

@@ -0,0 +1,2 @@
+# Marabethia
+Details

translations/en/locations/marat.md

@@ -0,0 +1,2 @@
+# Marat
+Details