Merge pull request #1721 from adaptlearning/issue/1715

Add custom function to generate lang files

Author: tomgreenfield

.gitignore

@@ -23,8 +23,6 @@ package-lock.json
 /plugins/content/menu/versions/
 /plugins/content/bower/bowercache/
 
-/routes/lang/en.json
-
 /temp
 /test/.testcache
 /tmp

Gruntfile.js

@@ -4,13 +4,14 @@ module.exports = function(grunt) {
   // Project configuration.
   grunt.initConfig({
     pkg: grunt.file.readJSON('package.json'),
-    "merge-json": {
-      en: {
-        src: [
-          'routes/lang/en-application.json',
-          'frontend/src/**/lang/en.json'
-        ],
-        dest: 'routes/lang/en.json'
+    'generate-lang-json': {
+      options: {
+        langFileExt: '.json',
+        src: {
+          backend: 'routes/lang',
+          frontend: 'frontend/src/**/lang'
+        },
+        dest: 'temp/lang'
       }
     },
     copy: {
@@ -269,6 +270,30 @@ module.exports = function(grunt) {
       done();
     }
   });
+  grunt.registerTask('generate-lang-json', function() {
+    const fs = require('fs-extra');
+    const path = require('path');
+
+    const options = this.options();
+    const backendGlob = path.join(options.src.backend, `*${options.langFileExt}`);
+    const dest = options.dest;
+    // load each route lang file
+    /**
+    * NOTE there must be a file in routes/lang for the language to be loaded,
+    * won't work if you've only got lang files in frontend
+    */
+    grunt.file.expand({}, path.join(backendGlob)).forEach(backendPath => {
+      const basename = path.basename(backendPath);
+      const frontendGlob = path.join(options.src.frontend, basename);
+      let data = { ...fs.readJSONSync(backendPath) };
+      // load all matching frontend lang files
+      grunt.file.expand({}, frontendGlob).forEach(frontendPath => {
+        data = { ...data, ...fs.readJSONSync(frontendPath) };
+      });
+      fs.ensureDirSync(dest);
+      fs.writeJSONSync(path.join(dest, basename), data, { spaces: 2 });
+    });
+  });
 
   grunt.registerTask('default', ['build:dev']);
   grunt.registerTask('test', ['mochaTest']);
@@ -290,7 +315,7 @@ module.exports = function(grunt) {
       config.isProduction = isProduction;
       grunt.file.write(configFile, JSON.stringify(config, null, 2));
       // run the task
-      grunt.task.run(['migration-conf', 'requireBundle', 'merge-json', 'copy', 'less:' + compilation, 'handlebars', 'requirejs:'+ compilation]);
+      grunt.task.run(['migration-conf', 'requireBundle', 'generate-lang-json', 'copy', 'less:' + compilation, 'handlebars', 'requirejs:'+ compilation]);
 
     } catch(e) {
       grunt.task.run(['requireBundle', 'copy', 'less:' + compilation, 'handlebars', 'requirejs:' + compilation]);

package.json

@@ -47,7 +47,6 @@
     "grunt-contrib-copy": "^1.0.0",
     "grunt-contrib-handlebars": "^2.0.0",
     "grunt-contrib-requirejs": "^1.0.0",
-    "grunt-merge-json": "^0.9.7",
     "grunt-mocha-test": "^0.13.3",
     "handlebars": "^4.4.0",
     "handlebars-form-helpers": "^0.1.4",

routes/lang/en-application.json routes/lang/en.jsonroutes/lang/en-application.json renamed to routes/lang/en.json

@@ -1,18 +1,19 @@
 var express = require('express');
 var path = require('path');
 var fs = require('fs');
-var server = module.exports = express();
 
-server.get('/lang/:lang', function (req, res, next) {
-    var lang = req.params.lang; // ie 'en' for /lang/en
-    var filename = path.join(__dirname, lang) + '.json';
-    var file;
+var configuration = require('../../lib/configuration');
+var Constants = require('../../lib/outputmanager').Constants;
 
-    fs.exists(filename, function(exists) {
-        file = exists 
-            ? require(filename)
-            : require(path.join(__dirname, 'en') + '.json');
+var server = module.exports = express();
 
-        return res.json(file);
-    });
+server.get('/lang/:lang', function (req, res, next) {
+  var lang = req.params.lang; // ie 'en' for /lang/en
+  var filename = path.join(configuration.serverRoot, Constants.Folders.Temp, 'lang', lang + '.json');
+  fs.exists(filename, function(exists) {
+    if(!exists) {
+      return res.status(404).end();
+    }
+    return res.json(require(filename));
+  });
 });