feat(#93): fix all eslint complaints

objectionary · Nov 30, 2022 · 7a5fa4c · 7a5fa4c
1 parent e36ecc1
commit 7a5fa4c
Show file tree

Hide file tree

Showing 10 changed files with 88 additions and 62 deletions.
diff --git a/src/commands/assemble.js b/src/commands/assemble.js
@@ -29,6 +29,7 @@ const parserVersion = require('../parser-version');
 /**
  * Command to assemble .XMIR files.
  * @param {Hash} opts - All options
+ * @return {Promise} of assemble task
  */
 module.exports = function(opts) {
   return mvnwSync([
@@ -41,7 +42,7 @@ module.exports = function(opts) {
     `-Deo.outputDir=${path.resolve(opts.target, 'classes')}`,
     `-Deo.placed=${path.resolve(opts.target, 'eo-placed.csv')}`,
     `-Deo.placedFormat=csv`,
-  ]).then(r => {
+  ]).then((r) => {
      console.info('EO program assembled in %s', path.resolve(opts.target));
      return r;
   });

diff --git a/src/commands/compile.js b/src/commands/compile.js
@@ -29,6 +29,7 @@ const parserVersion = require('../parser-version');
 /**
  * Command to compile target language into binaries.
  * @param {Hash} opts - All options
+ * @return {Promise} of compile task
  */
 module.exports = function(opts) {
   const target = path.resolve(opts.target);
@@ -40,7 +41,7 @@ module.exports = function(opts) {
     `-Deo.targetDir=${target}`,
     `-Deo.generatedDir=${path.resolve(opts.target, 'generated-sources')}`,
     '-Deo.version=' + (opts.parser ? opts.parser : parserVersion()),
-  ]).then(r => {
+  ]).then((r) => {
      console.info('Java .class files compiled into %s', target);
      return r;
   });

diff --git a/src/commands/gmi.js b/src/commands/gmi.js
@@ -29,6 +29,7 @@ const parserVersion = require('../parser-version');
 /**
  * Generate GMI files from XMIR.
  * @param {Hash} opts - All options
+ * @return {Promise} of gmi task
  */
 module.exports = function(opts) {
   const argv = [
@@ -59,7 +60,7 @@ module.exports = function(opts) {
     argv.push('-Deo.generateGraphFiles');
     argv.push('-Deo.generateDotFiles');
   }
-  return mvnwSync(argv).then(r => {
+  return mvnwSync(argv).then((r) => {
       console.info('GMI files generated in %s', path.resolve(opts.target));
       return r;
   });

diff --git a/src/commands/link.js b/src/commands/link.js
@@ -29,15 +29,16 @@ const parserVersion = require('../parser-version');
 /**
  * Command to link binaries into a single executable binary.
  * @param {Hash} opts - All options
+ * @return {Promise} of link task
  */
 module.exports = function(opts) {
   return mvnwSync([
     'jar:jar',
     opts.verbose ? '' : '--quiet',
     `-Deo.targetDir=${path.resolve(opts.target)}`,
     '-Deo.version=' + (opts.parser ? opts.parser : parserVersion()),
-  ]).then(r => {
+  ]).then((r) => {
      console.info('Executable JAR created at %s', path.resolve(opts.target, 'eoc.jar'));
      return r;
-  })
+  });
 };
diff --git a/src/commands/register.js b/src/commands/register.js
@@ -29,6 +29,7 @@ const parserVersion = require('../parser-version');
 /**
  * Command to register .EO sources.
  * @param {Hash} opts - All options
+ * @return {Promise} of register task
  */
 module.exports = function(opts) {
   const foreign = path.resolve(opts.target, 'eo-foreign.json');
@@ -38,7 +39,7 @@ module.exports = function(opts) {
     opts.verbose ? '' : '--quiet',
     `-Deo.targetDir=${path.resolve(opts.target)}`,
     `-Deo.sourcesDir=${path.resolve(opts.sources)}`,
-  ]).then(r => {
+  ]).then((r) => {
      console.info('EO objects registered in %s', foreign);
      return r;
   });

diff --git a/src/commands/test.js b/src/commands/test.js
@@ -28,6 +28,7 @@ const path = require('path');
 /**
  * Command to run all available unit tests.
  * @param {Hash} opts - All options
+ * @return {Promise} of compile task
  */
 module.exports = function(opts) {
   return mvnwSync([

diff --git a/src/commands/transpile.js b/src/commands/transpile.js
@@ -29,6 +29,7 @@ const parserVersion = require('../parser-version');
 /**
  * Command to transpile XMIR files into target language.
  * @param {Hash} opts - All options
+ * @return {Promise} of transpile task
  */
 module.exports = function(opts) {
   const sources = path.resolve(opts.target, 'generated-sources');
@@ -38,7 +39,7 @@ module.exports = function(opts) {
     opts.verbose ? '' : '--quiet',
     `-Deo.targetDir=${path.resolve(opts.target)}`,
     `-Deo.generatedDir=${sources}`,
-  ]).then(r => {
+  ]).then((r) => {
     console.info('Java sources generated in %s', sources);
     return r;
   });

diff --git a/src/eoc.js b/src/eoc.js
@@ -89,7 +89,7 @@ program.command('assemble')
   .action((str, opts) => {
     if (program.opts().alone == undefined) {
       register(program.opts())
-      .then(r => assemble(program.opts()));
+      .then((r) => assemble(program.opts()));
     } else {
       assemble(program.opts());
     }
@@ -106,8 +106,8 @@ program.command('gmi')
   .action((str, opts) => {
     if (program.opts().alone == undefined) {
       register(program.opts())
-      .then(r => assemble(program.opts()))
-      .then(r => gmi({...program.opts(), ...str}));
+      .then((r) => assemble(program.opts()))
+      .then((r) => gmi({...program.opts(), ...str}));
     } else {
       gmi({...program.opts(), ...str});
     }
@@ -118,10 +118,10 @@ program.command('transpile')
   .action((str, opts) => {
     if (program.opts().alone == undefined) {
       register(program.opts())
-      .then(r => assemble(program.opts()))
-      .then(r => transpile(program.opts()));
+      .then((r) => assemble(program.opts()))
+      .then((r) => transpile(program.opts()));
     } else {
-      transpile(program.opts())
+      transpile(program.opts());
     }
   });
 
@@ -130,9 +130,9 @@ program.command('compile')
   .action((str, opts) => {
     if (program.opts().alone == undefined) {
       register(program.opts())
-      .then(r => assemble(program.opts()))
-      .then(r => transpile(program.opts()))
-      .then(r => compile(program.opts()))
+      .then((r) => assemble(program.opts()))
+      .then((r) => transpile(program.opts()))
+      .then((r) => compile(program.opts()));
     } else {
       compile(program.opts());
     }
@@ -143,10 +143,10 @@ program.command('link')
   .action((str, opts) => {
     if (program.opts().alone == undefined) {
       register(program.opts())
-      .then(r => assemble(program.opts()))
-      .then(r => transpile(program.opts()))
-      .then(r => compile(program.opts()))
-      .then(r => link(program.opts()))
+      .then((r) => assemble(program.opts()))
+      .then((r) => transpile(program.opts()))
+      .then((r) => compile(program.opts()))
+      .then((r) => link(program.opts()));
     } else {
        link(program.opts());
     }
@@ -158,11 +158,11 @@ program.command('dataize')
   .action((str, opts) => {
     if (program.opts().alone == undefined) {
       register(program.opts())
-      .then(r => assemble(program.opts()))
-      .then(r => transpile(program.opts()))
-      .then(r => compile(program.opts()))
-      .then(r => link(program.opts()))
-      .then(r => dataize(program.args[1], program.args.slice(2), {...program.opts(), ...str}));
+      .then((r) => assemble(program.opts()))
+      .then((r) => transpile(program.opts()))
+      .then((r) => compile(program.opts()))
+      .then((r) => link(program.opts()))
+      .then((r) => dataize(program.args[1], program.args.slice(2), {...program.opts(), ...str}));
     } else {
       dataize(program.args[1], program.args.slice(2), {...program.opts(), ...str});
     }
@@ -173,11 +173,11 @@ program.command('test')
   .action((str, opts) => {
     if (program.opts().alone == undefined) {
       register(program.opts())
-      .then(r => assemble(program.opts()))
-      .then(r => transpile(program.opts()))
-      .then(r => compile(program.opts()))
-      .then(r => link(program.opts()))
-      .then(r => test(program.opts()))
+      .then((r) => assemble(program.opts()))
+      .then((r) => transpile(program.opts()))
+      .then((r) => compile(program.opts()))
+      .then((r) => link(program.opts()))
+      .then((r) => test(program.opts()));
     } else {
       test(program.opts());
     }

diff --git a/src/mvnw.js b/src/mvnw.js
@@ -39,6 +39,7 @@ function shell() {
 /**
  * Run mvnw with provided commands.
  * @param {Hash} args - All arguments to pass to it
+ * @return {Promise} of maven execution task
  */
 module.exports = function(args) {
   return new Promise((resolve, reject) => {
@@ -63,16 +64,16 @@ module.exports = function(args) {
             shell: shell(),
           }
         );
-      let target = params.find(element => element.includes("targetDir"));
-      if(target != undefined){
-        status.start(args[0], target.split("=")[1]);
+      const target = params.find((element) => element.includes('targetDir'));
+      if (target != undefined) {
+        status.start(args[0], target.split('=')[1]);
       }
-      result.on('close', code => {
+      result.on('close', (code) => {
         if (code !== 0) {
           throw new Error('The command "' + cmd + '" exited with #' + code + ' code');
         }
         status.stop();
         resolve(args);
       });
   });
-};
+};
diff --git a/src/status.js b/src/status.js
@@ -31,47 +31,65 @@ module.exports = {
     stop: stop,
 };
 
-var running = false;
-var phase = "unknown";
-var beginning;
-var target;
+let running = false;
+let phase = 'unknown';
+let beginning;
+let target;
 
-function start(stage, dir){
+/**
+ * Starts mvnw execution status detection.
+ * @param {String} stage - A maven stage like assemble, compile, transpile, etc.
+ * @param {String} dir - Directory where to check progress - ./.eoc
+ */
+function start(stage, dir) {
   running = true;
   phase = stage;
   target = dir;
   beginning = Date.now();
-  var check = function(){
-    if(running){
+  const check = function() {
+    if (running) {
        print();
        setTimeout(check, 200);
     }
-  }
+  };
   check();
 }
 
-function stop(){
+/**
+ * Stops mvnw execution status detection.
+ */
+function stop() {
   running = false;
-  process.stdout.write("\n");
+  process.stdout.write('\n');
 }
 
-function print(){
-    readline.clearLine(process.stdout);
-    readline.cursorTo(process.stdout, 0);
-    let duration = Date.now() - beginning;
-    function count(dir, curr){
-        if(fs.existsSync(dir)) {
-            for (const f of fs.readdirSync(dir)) {
-                next = path.join(dir, f);
-                if(fs.statSync(next).isDirectory()){
-                   curr = count(next, curr);
-                } else {
-                   curr++;
-                }
-            }
+/**
+ * Prints mvnw execution status.
+ */
+function print() {
+  readline.clearLine(process.stdout);
+  readline.cursorTo(process.stdout, 0);
+  const duration = Date.now() - beginning;
+  /**
+   * Recursively calculates number of files under a directory.
+   * @param {String} dir - Directory where to count.
+   * @param {Integer} curr - Current counter.
+   * @return {Integer} Total number files.
+   */
+  function count(dir, curr) {
+    if (fs.existsSync(dir)) {
+      for (const f of fs.readdirSync(dir)) {
+        next = path.join(dir, f);
+        if (fs.statSync(next).isDirectory()) {
+          curr = count(next, curr);
+        } else {
+          curr++;
         }
-        return curr;
+      }
     }
-    process.stdout.write(`\x1b[33m[${phase}] ${duration} ms. Total number of compiled files ${count(target, 0)}\x1b[0m`);
+    return curr;
+  }
+  process.stdout.write(
+    `\x1b[33m[${phase}] ${duration} ms. Total number of compiled files ${count(target, 0)}\x1b[0m`
+  );
 }
-