added autogenerated comments translations, closes #6

Author: ovfireandvoid

README.md

@@ -29,7 +29,7 @@ You can use `doxyjs` as standalone CLI tool to generate pseudo C++ code from jav
 Printing pseudo C++ representation of Javascript source to standard output:
 
 ```sh
-doxyqml --encoding utf8 --line-break lf file.js other_file.js
+doxyqml --encoding utf8 --line-break lf --lang ru file.js
 ```
 
 #### Options
@@ -39,17 +39,28 @@ $ doxyjs --help
 
   Usage: doxyjs [options] [files...]
 
-  Converts Javascript into psudo C++ for Doxygen processing
+  Converts Javascript into psudo C++ for Doxygen
 
   Options:
 
     -h, --help                     output usage information
     -V, --version                  output the version number
     -e, --encoding <encoding>      source files encoding (utf8 by default)
     -b, --line-break <line break>  line break symbol [lf|crlf] (lf by default)
+    -l, --lang <language code>     output language (en by default)
 
 ```
 
+List of supported encodings can be found [here](https://nodejs.org/api/buffer.html#buffer_buffers_and_character_encodings).
+
+List of supported languages:
+
+*   de
+*   en
+*   es
+*   it
+*   ru
+
 ### Doxygen Integration
 
 To use `doxyjs` with Doxygen you must make few changes to your Doxyfile.
@@ -146,9 +157,6 @@ Next contructions will be interpreted as classes:
  * @param type:Object arg argument description
  */
 function Argument(arg) {
-    if (!(this instanceof Argument)) {
-        return new Argument(arg);
-    }
 }
 
 /*!
@@ -179,13 +187,6 @@ Argument.prototype.addArgument = function(arg) {
  * @param type:Object cmd command description
  */
 function Command(cmd) {
-    if (!(this instanceof Command)) {
-        return new Command(cmd);
-    }
-
-    var _cmd = (cmd || {});
-
-    Argument.call(this, _cmd);
 }
 
 Command.prototype = Object.create(Argument.prototype);
@@ -196,13 +197,6 @@ Command.prototype.constructor = Argument;
  * @param type:Object event event description
  */
 function Event(event) {
-    if (!(this instanceof Event)) {
-        return new Event(event);
-    }
-
-    var _event = (event || {});
-
-    Argument.call(this, _event);
 }
 
 Event.prototype = Object.create(Argument.prototype);

doxyjs.js

@@ -4,7 +4,7 @@ const reduceToken = require('./src/reduceToken');
 const tokenConverter = require('./src/tokenConverter.js');
 const tokenExporter = require('./src/tokenExporter.js');
 
-const doxyjs = (input_data, encoding, linebreak) => {
+const doxyjs = (input_data, encoding, linebreak, ts) => {
   const input_lines = input_data.split(linebreak).filter(line => line.length);
   const input_file_tokens = input_lines.reduce(extractToken, []);
   const input_file_structure = input_file_tokens.reduce(reduceToken, {
@@ -24,14 +24,14 @@ const doxyjs = (input_data, encoding, linebreak) => {
     .map(tokenConverter.convertClass);
 
   const exported_variables = global_variables.map(v =>
-    tokenExporter.exportGlobalVariable(v, linebreak)
+    tokenExporter.exportGlobalVariable(v, linebreak, ts)
   );
   const exported_functions = global_functions.map(f =>
-    tokenExporter.exportGlobalFunction(f, linebreak)
+    tokenExporter.exportGlobalFunction(f, linebreak, ts)
   );
 
   const exported_classes = classes.map(c =>
-    tokenExporter.exportClass(c, linebreak)
+    tokenExporter.exportClass(c, linebreak, ts)
   );
 
   process.stdout.write(
@@ -42,13 +42,13 @@ const doxyjs = (input_data, encoding, linebreak) => {
   );
 };
 
-module.exports = (filename, encoding, linebreak) => {
+module.exports = (filename, encoding, linebreak, ts) => {
   fs.readFile(filename, encoding, (error, data) => {
     if (error) {
       console.error(`doxyjs: can't read file ${filename}, aborting`);
       process.exit(1);
     }
 
-    doxyjs(data, encoding, linebreak);
+    doxyjs(data, encoding, linebreak, ts);
   });
 };

index.js

@@ -1,9 +1,12 @@
 #!/usr/bin/env node
 
 const program = require('commander');
+const localize = require('localize');
 const doxyjs = require('./doxyjs');
 const pkg = require('./package.json');
 
+const translator = new localize('./translations');
+
 program
   .description(pkg.description)
   .version(pkg.version)
@@ -18,6 +21,11 @@ program
     'line break symbol [lf|crlf] (lf by default)',
     val => (val.match(/^crlf$/i) ? '\r\n' : '\n'),
     '\n'
+  )
+  .option(
+    '-l, --lang <language code>',
+    'output language (en by default)',
+    'en'
   );
 
 program.parse(process.argv);
@@ -27,6 +35,8 @@ if (program.args.length == 0) {
   process.exit(1);
 }
 
+translator.setLocale(program.lang);
+
 program.args.forEach(file => {
-  doxyjs(file, program.encoding, program.lineBreak);
+  doxyjs(file, program.encoding, program.lineBreak, translator);
 });

package.json

@@ -1,7 +1,7 @@
 {
   "name": "doxyjs",
   "version": "1.0.3",
-  "description": "Converts Javascript into psudo C++ for Doxygen processing",
+  "description": "Converts Javascript into psudo C++ for Doxygen",
   "main": "index.js",
   "author": "Dmitry Toropchin",
   "license": "MIT",
@@ -14,7 +14,11 @@
     "url": "https://github.com/dmitrytoropchin/doxyjs.git"
   },
   "dependencies": {
-    "commander": "^2.9.0"
+    "commander": "^2.9.0",
+    "localize": "^0.4.7"
+  },
+  "devDependencies": {
+    "jest": "^20.0.4"
   },
   "bin": {
     "doxyjs": "./index.js"
@@ -23,12 +27,10 @@
     "node": ">=7.0.0"
   },
   "keywords": [
-    "cli", "doxygen"
+    "cli",
+    "doxygen"
   ],
   "scripts": {
     "test": "jest"
-  },
-  "devDependencies": {
-    "jest": "^20.0.4"
   }
 }

src/tokenExporter.js

@@ -1,4 +1,4 @@
-const exportGlobalVariable = (global_variable, linebreak) => {
+const exportGlobalVariable = (global_variable, linebreak, ts) => {
   let variable_export = '';
 
   if (global_variable.comment && global_variable.comment.brief) {
@@ -10,7 +10,7 @@ const exportGlobalVariable = (global_variable, linebreak) => {
   return variable_export;
 };
 
-const exportGlobalFunction = (global_function, linebreak) => {
+const exportGlobalFunction = (global_function, linebreak, ts) => {
   let function_export = '';
 
   if (global_function.comment) {
@@ -45,7 +45,7 @@ const exportGlobalFunction = (global_function, linebreak) => {
   return function_export;
 };
 
-const exportClass = (_class, linebreak) => {
+const exportClass = (_class, linebreak, ts) => {
   let class_export = '';
 
   if (_class.constructor && _class.constructor.comment) {
@@ -66,7 +66,9 @@ const exportClass = (_class, linebreak) => {
       const comment = _class.constructor.comment;
 
       class_export += `/*!${linebreak}`;
-      class_export += ` * @brief Constructor${linebreak}`;
+      class_export += ` * @brief ${ts
+        ? ts.translate('Constructor')
+        : 'Constructor'}${linebreak}`;
 
       if (comment.params) {
         Object.keys(comment.params)
@@ -86,7 +88,7 @@ const exportClass = (_class, linebreak) => {
   }
 
   _class.methods.forEach(method => {
-    class_export += `${exportGlobalFunction(method, linebreak)}`;
+    class_export += `${exportGlobalFunction(method, linebreak, ts)}`;
   });
 
   class_export += `};${linebreak}`;

translations/translations.json

@@ -0,0 +1,9 @@
+{
+  "Constructor": {
+    "de": "Konstrukteur",
+    "en": "Constructor",
+    "es": "Constructor",
+    "it": "Costruttore",
+    "ru": "Конструктор"
+  }
+}

yarn.lock

@@ -404,6 +404,10 @@ commander@^2.9.0:
   dependencies:
     graceful-readlink ">= 1.0.0"
 
+commander@~2.1.0:
+  version "2.1.0"
+  resolved "https://registry.yarnpkg.com/commander/-/commander-2.1.0.tgz#d121bbae860d9992a3d517ba96f56588e47c6781"
+
 [email protected]:
   version "0.0.1"
   resolved "https://registry.yarnpkg.com/concat-map/-/concat-map-0.0.1.tgz#d8a96bd77fd68df7793a73036a3ba0d5405d477b"
@@ -1264,6 +1268,12 @@ load-json-file@^1.0.0:
     pinkie-promise "^2.0.0"
     strip-bom "^2.0.0"
 
+localize@^0.4.7:
+  version "0.4.7"
+  resolved "https://registry.yarnpkg.com/localize/-/localize-0.4.7.tgz#e3b69e5ac1ee47fe211ff07a02b8f2e969bf9cfa"
+  dependencies:
+    commander "~2.1.0"
+
 locate-path@^2.0.0:
   version "2.0.0"
   resolved "https://registry.yarnpkg.com/locate-path/-/locate-path-2.0.0.tgz#2b568b265eec944c6d9c0de9c3dbbbca0354cd8e"