chore: add some comments to l10n plugin

Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>

Author: susnux

build/extract-l10n.mjs

@@ -28,25 +28,33 @@ extractor.createHtmlParser([
 ])
 	.parseFilesGlob('./src/**/*.vue')
 
+const messages = extractor.getMessages()
+
 /**
  * remove references to avoid conflicts but save them for code splitting
  *
  * @type {Record<string,string[]>}
  */
-export const context = extractor.getMessages().map((msg) => {
-	const localContext = [msg.text ?? '', [...new Set(msg.references.map((ref) => ref.split(':')[0] ?? ''))].sort().join(':')]
+export const context = messages.map((msg) => {
+	// mapping of translation ID -> filename(s) [id, filename1:filename2:...]
+	const idUsage = [
+		msg.text ?? '',
+		// get the reference file names only (split off line number), remove duplicates and sort them
+		[...new Set(msg.references.map((ref) => ref.split(':')[0] ?? ''))].sort().join(':'),
+	]
+	// remove reference to avoid conflicts on transifex
 	msg.references = []
-	return localContext
-}).reduce((p, [id, usage]) => {
-	const localContext = { ...(Array.isArray(p) ? {} : p) }
+	return idUsage
+}).reduce((localContext, [id, usage]) => {
+	// add translation bundles to their usage context (filenames -> [ids])
 	if (usage in localContext) {
 		localContext[usage].push(id)
 		return localContext
 	} else {
 		localContext[usage] = [id]
 	}
 	return localContext
-})
+}, {})
 
 extractor.savePotFile('./l10n/messages.pot')
 

build/l10n-plugin.mts

@@ -104,7 +104,9 @@ export default (dir: string) => {
 				return `import {t,n,register,${imports.join(',')}} from '\0l10n';register(${imports.join(',')});export {t,n};`
 			} else if (id === '\0l10n') {
 				// exports are all chunked translations
-				const exports = Object.entries(nameMap).map(([usage, id]) => `export const ${id} = ${JSON.stringify(translations[usage])}`).join(';\n')
+				const exports = Object.entries(nameMap)
+					.map(([usage, id]) => `export const ${id} = ${JSON.stringify(translations[usage])}`)
+					.join(';\n')
 				return `${l10nRegistrationCode}\n${exports}`
 			}
 		},