⚡ Optimize the i18n system

Author: frncesc

.vscode/launch.json

@@ -1,21 +1,22 @@
 {
   "version": "0.2.0",
   "configurations": [
-
     {
       "type": "node",
       "request": "launch",
       "name": "Launch Program",
       "program": "${workspaceRoot}/test/nodejs/serializeProject.js",
       "cwd": "${workspaceRoot}",
-      "args": ["test/jclic-demo/demo.jclic"]
+      "args": [
+        "test/jclic-demo/demo.jclic"
+      ]
     },
     {
       "name": "Launch Chrome against localhost",
       "type": "chrome",
       "request": "launch",
-      "url": "http://localhost:8080/index.html",
-      "webRoot": "${workspaceRoot}",
+      "url": "http://localhost:9001/index.html",
+      "webRoot": "${workspaceFolder}",
       "runtimeExecutable": "/usr/bin/chromium-browser",
       "runtimeArgs": [
         "--incognito"
@@ -29,4 +30,4 @@
       "webRoot": "${workspaceRoot}"
     }
   ]
-}
+}

CHANGELOG.md

@@ -1,3 +1,10 @@
+### v2.1.1 (2021-04-12)
+#### Bug fixes
+- Fixed an issue with i18n, which did not correctly apply the required language selection.
+
+#### Improvements
+- i18n has been written from scratch, simplifying its operation and supporting different "locale" encodings.
+
 ### v2.1.0 (2021-04-10)
 #### Breaking changes
 - JClic projects can be now encapsulated in JSON format (files with extension `.jclic.json`). Current files in XML format (`.jclic`) will be still supported, but JSON will be the default format from now. Both formats can also be packaged in ZIP files (files of type `.jclic.zip` and `.scorm.zip`). This will simplify the development of the upcoming new project _JClic Author HTML5_.

README.md

@@ -65,7 +65,6 @@ JClic.js makes use of:
 * [jQuery](https://jquery.com/) to parse XML documents and manage DOM objects
 * [JSZip](https://stuk.github.io/jszip/) to extract contents from "jclic.zip" files
 * [clipboard-polyfill](https://github.com/lgarron/clipboard-polyfill) to copy reports data into the user's clipboard
-* [i18next](https://github.com/i18next/i18next) to deal with messages translated into different languages
 * [script.js](https://github.com/ded/script.js) to read JClic projects from local file systems as JSONP
 * [webfontloader](https://github.com/typekit/webfontloader) to dynamically load web fonts as needed
 * [MidiPlayerJS](https://github.com/grimmdude/MidiPlayerJS), [soundfont-player](https://github.com/danigb/soundfont-player), [audio-loader](https://github.com/audiojs/audio-loader) and [sample-player](https://github.com/danigb/sample-player) to process and play MIDI files

build-locales.js

@@ -1,15 +1,14 @@
 #!/usr/bin/env node
 
 /*
- * Process a set of '.po' language files, extracting its keys and messages, and building
- * an object suitable for [i18next](https://www.npmjs.com/package/i18next)
+ * Process a set of '.po' language files, extracting its keys and messages
  */
 
-/* global module:true */
-const fs = require('fs')
-const path = require('path')
-const po2json = require('po2json')
-const pkg = require('./package.json')
+/* global require, console, module:true */
+const fs = require('fs');
+const path = require('path');
+const po2json = require('po2json');
+const pkg = require('./package.json');
 
 const _LOCALES = path.resolve('locales');
 const _GLOBALDATA = path.resolve('src', 'GlobalData.js');
@@ -21,65 +20,65 @@ const newerData = function (locales = _LOCALES, fileName = _GLOBALDATA) {
   const gTime = fs.statSync(fileName).ctimeMs;
   return fs.statSync(path.resolve('./package.json')).ctimeMs > gTime
     || fs.readdirSync(locales).find(fn => fn.endsWith('.po') && fs.statSync(path.resolve(locales, fn)).ctimeMs > gTime) !== undefined;
-}
+};
 
-// Compiles all 'po' language files in ./locales, returning the resulting i18next options object
+// Compiles all 'po' language files in ./locales, returning the resulting options object
 const getData = function (locales = _LOCALES, verbose = true) {
 
-  // Initialize the i18next options object
+  // Initialize the options object
   const opt = {
     version: `${pkg.version} (${(new Date()).toISOString().substr(0, 10)})`,
     languages: ['en'],
-    messages: {}
-  }
+    messages: {},
+  };
 
   // Process all .po files found in `localesDir`
   fs.readdirSync(locales).forEach(fn => {
     if (fn.endsWith('.po')) {
       // Gent language code from file name, skipping extension
-      const lang = fn.substr(0, fn.lastIndexOf('.'))
-      const file = path.resolve(locales, fn)
+      const lang = fn.substr(0, fn.lastIndexOf('.'));
+      const file = path.resolve(locales, fn);
       if (verbose)
-        console.log(`Processing language ${lang}`)
+        console.log(`Processing language ${lang}`);
       try {
         // Parse file with po2json and store result in `opt.messages`
-        opt.messages[lang] = po2json.parseFileSync(file, { format: 'mf' })
+        opt.messages[lang] = po2json.parseFileSync(file, { format: 'mf' });
         // Add lang to the list of known languages
-        opt.languages.push(lang)
+        opt.languages.push(lang);
       } catch (e) {
-        console.error(`Error processing ${file}: ${e}`)
+        console.error(`Error processing ${file}: ${e}`);
       }
     }
-  })
-  return opt
-}
+  });
+  return opt;
+};
 
 // Generates the AMD module `GlobalData.js`, containing a single call to `define` with the content of `opt`
 const writeDataToJSFile = function (opt, file = _GLOBALDATA, verbose = true) {
   if (verbose)
-    console.log(`Generating file ${file}`)
+    console.log(`Generating file ${file}`);
 
   try {
     fs.writeFileSync(file, `
 // WARNING: Auto-generated file, based on "language.po" files stored in "/locales". Do not edit!
 // Launch "npm run build-locales" to update this file
 
-export default ${JSON.stringify(opt)};`)
+export default ${JSON.stringify(opt)};`);
   } catch (e) {
-    console.error(`Error generating file ${file}: ${e}`)
+    console.error(`Error generating file ${file}: ${e}`);
   }
-}
+};
 
 module.exports = function (locales = _LOCALES, file = _GLOBALDATA, verbose = true) {
   // Run only if newer data
   if (newerData(locales, file))
-    writeDataToJSFile(getData(locales, verbose), file, verbose)
-}
+    writeDataToJSFile(getData(locales, verbose), file, verbose);
+};
 
-module.exports.getData = getData
-module.exports.writeDataToJSFile = writeDataToJSFile
+module.exports.getData = getData;
+module.exports.writeDataToJSFile = writeDataToJSFile;
 
 // Allow direct call from nodejs CLI
 if (require.main == module)
-  module.exports()
+  module.exports();