Issue 6171 - create CSV exporter and importer for translations

build/csv-export.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-present eyeo GmbH
  *
  * Adblock Plus is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 3 as
  * published by the Free Software Foundation.
  *
  * Adblock Plus is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ skipping 207 matching lines @@
     }).catch((error) =>
     {
       console.error(error);
     });
   });
 }
 
 /**
  * Reads JSON file and assign filename and locale to it
  * @param {string} filePath - ex.: "locales/en_US/desktop-options.json"
- * @param {function} callback - fileName, locale and strings of locale file

[Thomas Greiner, 2018/06/12 14:50:42]

Detail: This parameter no longer exists. Instead, you can change the return type
to `Promise<Object>` and describe its contents there.

[saroyanm, 2018/06/13 15:36:25]

Done.

- *                   Parameters:
- *                     * Error message
- *                     * Object containing fileName, locale and strings
- * @returns {Promise}
- */
-function readJson(filePath, callback)
-{
-  return new Promise((resolve, reject) =>

[Thomas Greiner, 2018/06/12 14:50:42]

You can simply return the promise you get from `readFile()` instead of creating
a new one. That way you won't have to worry about error handling in here.

But note that you'll need to move `path.parse()` inside the arrow function for
any of its errors to be passed on.

[saroyanm, 2018/06/13 15:36:25]

Done.

+ * @returns {Promise<Object>} resolves fileName, locale and strings of the
+ *                            locale file
+ */
+function readJson(filePath)
+{
+  return readFile(filePath, "utf8").then((data) =>
   {
     const {dir, base} = path.parse(filePath);
-    readFile(filePath, "utf8").then((data) =>
-    {
-      const locale = dir.split(path.sep).pop();
-      const strings = JSON.parse(data);
-      resolve({fileName: base, locale, strings});
-    }).catch((err) =>
-    {
-      reject(err);
-    });
+    const locale = dir.split(path.sep).pop();
+    const strings = JSON.parse(data);
+    return {fileName: base, locale, strings};
   });
 }
 
 /**
  * Exit process and log error message
  * @param {String} error error message
  */
 function exitProcess(error)
 {
   console.error(error);
   process.exit(1);
 }
 
 // CLI
 const helpText = `
 About: Converts locale files between CSV and JSON formats
 Usage: csv-export.js [option] [argument]
 Options:
   -f [FILENAME]         Name of the files to be exported ex.: -f firstRun.json
                         option can be used multiple times.
                         If omitted all files are being exported
 
   -o [FILENAME]         Output filename ex.:
-                        -f firstRun.json -o {hash}-firstRun.csv
-                        Placeholders:
-                          {hash} - Mercurial current revision hash

[Thomas Greiner, 2018/06/12 14:50:42]

Detail: Again, these placeholders no longer exists so we need to update this
entire argument description.

See
https://codereview.adblockplus.org/29636585/diff2/29784598:29799613/build/csv...

[saroyanm, 2018/06/13 15:36:26]

Done.

+                        -f firstRun.json -o firstRun.csv
                         If omitted the output fileName is set to
-                        translations-{repo}-{hash}.csv
+                        translations.csv
 
   -i [FILENAME]         Import file path ex: -i issue-reporter.csv
 `;
 
 const argv = process.argv.slice(2);
 let stopExportScript = false;
 // Filter to be used export to the fileNames inside
 const filesFilter = [];
 
 for (let i = 0; i < argv.length; i++)
@@ skipping 25 matching lines @@
       }
       const importFile = argv[i + 1];
       importTranslations(importFile);
       stopExportScript = true;
       break;
   }
 }
 
 if (!stopExportScript)
   exportTranslations(filesFilter);