eolang 0.19.0 → 0.20.0

package/README.md

@@ -1,4 +1,4 @@
-# EOLANG Command Line
+# EOLANG Command Line Took-Kit
 
 [![EO principles respected here](https://www.elegantobjects.org/badge.svg)](https://www.elegantobjects.org)
 [![We recommend IntelliJ IDEA](https://www.elegantobjects.org/intellij-idea.svg)](https://www.jetbrains.com/idea/)
@@ -9,11 +9,9 @@
 [![Hits-of-Code](https://hitsofcode.com/github/objectionary/eoc)](https://hitsofcode.com/view/github/objectionary/eoc)
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/objectionary/eoc/blob/master/LICENSE.txt)
 
-First, you install
-[npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
-and [Java SE](https://www.oracle.com/java/technologies/downloads/).
+First, you install [npm][npm-install] and [Java SE][java-se].
 
-Then, you install [eolang](https://www.npmjs.com/package/eolang) package:
+Then, you install [eolang][npm] package:
 
 ```bash
 npm install -g eolang
@@ -39,8 +37,7 @@ That's it.
 ## Commands
 
 You can also do many other things with `eoc` commands
-(the flow is explained in
-[this blog post](https://www.yegor256.com/2021/10/21/objectionary.html)):
+(the flow is explained in [this blog post][blog]):
 
 * `register` finds necessary EO files and registers them in a JSON catalog
 * `assemble` parses EO files into XMIR, optimizes them,
@@ -56,9 +53,7 @@ There are also commands that help manipulate with XMIR and EO sources
 
 * `audit` inspects all required packages and reports their status
 * `foreign` inspects all objects found in the program after `assemble` step
-* `sodg` generates SODG from XMIR, further rederable
-  as XML or
-  [Dot](https://en.wikipedia.org/wiki/DOT_%28graph_description_language%29)
+* `sodg` generates SODG from XMIR, further rederable as XML or [Dot][dot]
 * `phi` generates PHI files from XMIR
 * `unphi` generates XMIR files from PHI files
 * `print` generates EO files from PHI files
@@ -69,7 +64,7 @@ There are also commands that help manipulate with XMIR and EO sources
 * ~~`flatten` moves inner objects to upper level~~
 
 This command line toolkit simply integrates other tools available in
-[@objectionary](https://github.com/objectionary) GitHub organization.
+the [@objectionary](https://github.com/objectionary) GitHub organization.
 
 ## How to Contribute
 
@@ -84,3 +79,9 @@ npm test -- test/test_mvnw.js
 Make your changes and then
 [make](https://www.yegor256.com/2014/04/15/github-guidelines.html)
 a pull request.
+
+[npm]: https://www.npmjs.com/package/eolang
+[java-se]: https://www.oracle.com/java/technologies/downloads/
+[npm-install]: https://docs.npmjs.com/downloading-and-installing-node-js-and-npm
+[dot]: https://en.wikipedia.org/wiki/DOT_%28graph_description_language%29
+[blog]: https://www.yegor256.com/2021/10/21/objectionary.html

package/eo-version.txt

@@ -1 +1 @@
-0.38.0
+0.38.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eolang",
-  "version": "0.19.0",
+  "version": "0.20.0",
   "author": "Yegor Bugayenko <yegor256@gmail.com> (https://www.yegor256.com/)",
   "license": "MIT",
   "repository": "objectionary/eoc",
@@ -32,15 +32,16 @@
   "dependencies": {
     "colors": "1.4.0",
     "commander": "12.0.0",
+    "eo2js": "0.0.6",
     "fast-xml-parser": "4.3.6",
-    "node": "21.7.3",
+    "node": "22.1.0",
     "relative": "3.0.2",
-    "semver": "7.6.0",
+    "semver": "7.6.2",
     "sync-request": "6.1.0",
     "xmlhttprequest": "1.8.0"
   },
   "devDependencies": {
-    "eslint": "9.1.1",
+    "eslint": "9.2.0",
     "eslint-config-google": "0.14.0",
     "grunt": "1.6.1",
     "grunt-contrib-clean": "2.0.1",

package/src/commands/{compile.js → java/compile.js}

@@ -23,12 +23,12 @@
  */
 
 const rel = require('relative');
-const {mvnw, flags} = require('../mvnw');
+const {mvnw, flags} = require('../../mvnw');
 const path = require('path');
 
 /**
  * Command to compile target language into binaries.
- * @param {Hash} opts - All options
+ * @param {Object} opts - All options
  * @return {Promise} of compile task
  */
 module.exports = function(opts) {

package/src/commands/{dataize.js → java/dataize.js}

@@ -29,7 +29,7 @@ const path = require('path');
  * Runs the single executable binary.
  * @param {String} obj - Name of object to dataize
  * @param {Array} args - Arguments
- * @param {Hash} opts - All options
+ * @param {Object} opts - All options
  */
 module.exports = function(obj, args, opts) {
   const params = [

package/src/commands/{link.js → java/link.js}

@@ -23,12 +23,12 @@
  */
 
 const rel = require('relative');
-const {mvnw, flags} = require('../mvnw');
+const {mvnw, flags} = require('../../mvnw');
 const path = require('path');
 
 /**
  * Command to link binaries into a single executable binary.
- * @param {Hash} opts - All options
+ * @param {Object} opts - All options
  * @return {Promise} of link task
  */
 module.exports = function(opts) {

package/src/commands/{test.js → java/test.js}

@@ -22,11 +22,11 @@
  * SOFTWARE.
  */
 
-const {mvnw, flags} = require('../mvnw');
+const {mvnw, flags} = require('../../mvnw');
 
 /**
  * Command to run all available unit tests.
- * @param {Hash} opts - All options
+ * @param {Object} opts - All options
  * @return {Promise} of compile task
  */
 module.exports = function(opts) {

package/src/commands/{transpile.js → java/transpile.js}

@@ -23,12 +23,12 @@
  */
 
 const rel = require('relative');
-const {mvnw, flags} = require('../mvnw');
+const {mvnw, flags} = require('../../mvnw');
 const path = require('path');
 
 /**
  * Command to transpile XMIR files into target language.
- * @param {Hash} opts - All options
+ * @param {Object} opts - All options
  * @return {Promise} of transpile task
  */
 module.exports = function(opts) {

package/src/commands/js/compile.js

@@ -0,0 +1,35 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2022-2024 Objectionary.com
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included
+ * in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+/**
+ * Command to compile target language into binaries.
+ * @param {Object} opts - All options
+ * @return {Promise} of compile task
+ */
+module.exports = function(opts) {
+  return new Promise((resolve, reject) => {
+    console.info('Compile step is skipped for JavaScript');
+    resolve(opts);
+  });
+};

package/src/commands/js/dataize.js

@@ -0,0 +1,39 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2022-2024 Objectionary.com
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included
+ * in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+const eo2jsw = require('../../eo2jsw');
+
+/**
+ * Runs the single executable binary.
+ * @param {String} obj - Name of object to dataize
+ * @param {Array} args - Arguments
+ * @param {Object} opts - All options
+ * @return {Promise} of executed command
+ */
+module.exports = function(obj, args, opts) {
+  return eo2jsw(
+    ['dataize', obj, ...args.filter((arg) => !arg.startsWith('-'))].join(' '),
+    {...opts, alone: true, project: 'project'}
+  );
+};

package/src/commands/js/link.js

@@ -0,0 +1,41 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2022-2024 Objectionary.com
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included
+ * in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+const rel = require('relative');
+const path = require('path');
+const eo2jsw = require('../../eo2jsw');
+const {program} = require('commander');
+
+/**
+ * Command to create and build NPM project.
+ * @param {Object} opts - All options
+ * @return {Promise} of link task
+ */
+module.exports = function(opts) {
+  const tests = program.args[0] === 'test' || !!opts.tests;
+  return eo2jsw('link', {...opts, alone: true, project: 'project', tests}).then((r) => {
+    console.info(`NPM project generated in ${rel(path.resolve(opts.target, 'project'))}`);
+    return r;
+  });
+};

package/src/commands/js/test.js

@@ -0,0 +1,34 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2022-2024 Objectionary.com
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included
+ * in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+const eo2jsw = require('../../eo2jsw');
+
+/**
+ * Command to run all available unit tests.
+ * @param {Object} opts - All options
+ * @return {Promise} of compile task
+ */
+module.exports = function(opts) {
+  return eo2jsw('test', {...opts, alone: true, project: 'project'});
+};

package/src/commands/js/transpile.js

@@ -0,0 +1,39 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2022-2024 Objectionary.com
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included
+ * in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+const rel = require('relative');
+const eo2jsw = require('../../eo2jsw');
+const path = require('path');
+
+/**
+ * Command to transpile XMIR files into target language.
+ * @param {Object} opts - All options
+ * @return {Promise} of transpile task
+ */
+module.exports = function(opts) {
+  return eo2jsw('transpile', {...opts, alone: true, project: 'project'}).then((r) => {
+    console.info(`JS sources are generated in ${rel(path.resolve(opts.target, 'project'))}`);
+    return r;
+  });
+};

package/src/eo2jsw.js

@@ -0,0 +1,43 @@
+const path = require('path');
+const {execSync} = require('child_process');
+
+/**
+ * Convert eoc arguments to appropriate eo2js flags
+ * @param {Object} args - eoc arguments
+ * @param {String} lib - Path to eo2js lib
+ * @return {Array.<String>} - Flags for eo2js
+ */
+const flags = function(args, lib) {
+  return [
+    '--target', args.target,
+    '--project', args.project || 'project',
+    '--foreign eo-foreign.json',
+    '--resources', path.resolve(lib, 'resources'),
+    args.alone ? '--alone' : '',
+    args.tests ? '--tests' : ''
+  ];
+};
+
+/**
+ * Wrapper for eo2js.
+ * @param {String} command - Command to execute
+ * @param {Object} args - Command arguments
+ * @return {Promise<Array.<String>>}
+ */
+const eo2jsw = function(command, args) {
+  const lib = path.resolve(__dirname, '../node_modules/eo2js/src');
+  const bin = path.resolve(lib, 'eo2js.js');
+  return new Promise((resolve, reject) => {
+    execSync(
+      `node ${bin} ${command} ${flags(args, lib).filter((flag) => flag !== '').join(' ')}`,
+      {
+        timeout: 1200000,
+        windowsHide: true,
+        stdio: 'inherit'
+      }
+    );
+    resolve(args);
+  });
+};
+
+module.exports = eo2jsw;

package/src/eoc.js

@@ -35,12 +35,35 @@ const unphi = require('./commands/unphi');
 const print = require('./commands/print');
 const register = require('./commands/register');
 const verify = require('./commands/verify');
-const transpile = require('./commands/transpile');
-const compile = require('./commands/compile');
-const link = require('./commands/link');
-const dataize = require('./commands/dataize');
 const foreign = require('./commands/foreign');
-const test = require('./commands/test');
+
+/**
+ * Target language option.
+ */
+const language = {
+  java: 'Java',
+  js: 'JavaScript',
+};
+
+/**
+ * Platform dependent commands.
+ */
+const commands = {
+  [language.java]: {
+    transpile: require('./commands/java/transpile'),
+    link: require('./commands/java/link'),
+    compile: require('./commands/java/compile'),
+    dataize: require('./commands/java/dataize'),
+    test: require('./commands/java/test')
+  },
+  [language.js]: {
+    transpile: require('./commands/js/transpile'),
+    link: require('./commands/js/link'),
+    compile: require('./commands/js/compile'),
+    dataize: require('./commands/js/dataize'),
+    test: require('./commands/js/test')
+  }
+};
 
 if (process.argv.includes('--verbose')) {
   tinted.enable('debug');
@@ -77,6 +100,7 @@ program
   .option('--parser <version>', 'Set the version of EO parser to use', parser)
   .option('--latest', 'Use the latest parser version from Maven Central')
   .option('--alone', 'Just run a single command without dependencies')
+  .option('-l, --language <name>', 'Language of target execution platform', language.java)
   .option('-b, --batch', 'Run in batch mode, suppress interactive messages')
   .option('--no-color', 'Disable colorization of console messages')
   .option('--track-optimization-steps', 'Save intermediate XMIR files')
@@ -198,28 +222,30 @@ program.command('transpile')
   .description('Convert EO files into target language')
   .action((str, opts) => {
     clear(str);
+    const lang = program.opts().language;
     if (program.opts().alone == undefined) {
       register(program.opts())
         .then((r) => assemble(program.opts()))
         .then((r) => verify(program.opts()))
-        .then((r) => transpile(program.opts()));
+        .then((r) => commands[lang].transpile(program.opts()));
     } else {
-      transpile(program.opts());
+      commands[lang].transpile(program.opts());
     }
   });
 
 program.command('compile')
   .description('Compile target language sources into binaries')
   .action((str, opts) => {
+    const lang = program.opts().language;
     clear(str);
     if (program.opts().alone == undefined) {
       register(program.opts())
         .then((r) => assemble(program.opts()))
         .then((r) => verify(program.opts()))
-        .then((r) => transpile(program.opts()))
-        .then((r) => compile(program.opts()));
+        .then((r) => commands[lang].transpile(program.opts()))
+        .then((r) => commands[lang].compile(program.opts()));
     } else {
-      compile(program.opts());
+      commands[lang].compile(program.opts());
     }
   });
 
@@ -227,15 +253,16 @@ program.command('link')
   .description('Link together all binaries into a single executable binary')
   .action((str, opts) => {
     clear(str);
+    const lang = program.opts().language;
     if (program.opts().alone == undefined) {
       register(program.opts())
         .then((r) => assemble(program.opts()))
         .then((r) => verify(program.opts()))
-        .then((r) => transpile(program.opts()))
-        .then((r) => compile(program.opts()))
-        .then((r) => link(program.opts()));
+        .then((r) => commands[lang].transpile(program.opts()))
+        .then((r) => commands[lang].compile(program.opts()))
+        .then((r) => commands[lang].link(program.opts()));
     } else {
-      link(program.opts());
+      commands[lang].link(program.opts());
     }
   });
 
@@ -244,16 +271,21 @@ program.command('dataize')
   .option('--stack <size>', 'Change stack size', '1M')
   .action((str, opts) => {
     clear(str);
+    const lang = program.opts().language;
     if (program.opts().alone == undefined) {
       register(program.opts())
         .then((r) => assemble(program.opts()))
         .then((r) => verify(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) => commands[lang].transpile(program.opts()))
+        .then((r) => commands[lang].compile(program.opts()))
+        .then((r) => commands[lang].link(program.opts()))
+        .then((r) => commands[lang].dataize(
+          program.args[1], program.args.slice(2), {...program.opts(), ...str}
+        ));
     } else {
-      dataize(program.args[1], program.args.slice(2), {...program.opts(), ...str});
+      commands[lang].dataize(
+        program.args[1], program.args.slice(2), {...program.opts(), ...str}
+      );
     }
   });
 
@@ -261,16 +293,17 @@ program.command('test')
   .description('Run all visible unit tests')
   .action((str, opts) => {
     clear(str);
+    const lang = program.opts().language;
     if (program.opts().alone == undefined) {
       register(program.opts())
         .then((r) => assemble(program.opts()))
         .then((r) => verify(program.opts()))
-        .then((r) => transpile(program.opts()))
-        .then((r) => compile(program.opts()))
-        .then((r) => link(program.opts()))
-        .then((r) => test(program.opts()));
+        .then((r) => commands[lang].transpile(program.opts()))
+        .then((r) => commands[lang].compile(program.opts()))
+        .then((r) => commands[lang].link(program.opts()))
+        .then((r) => commands[lang].test(program.opts()));
     } else {
-      test(program.opts());
+      commands[lang].test(program.opts());
     }
   });
 

package/src/mvnw.js

@@ -46,7 +46,7 @@ let beginning;
 
 /**
  * Prepare options for Maven.
- * @param {Hash} opts - Opts provided to the "eoc"
+ * @param {Object} opts - Opts provided to the "eoc"
  * @return {Array} of Maven options
  */
 module.exports.flags = function(opts) {
@@ -72,9 +72,9 @@ module.exports.flags = function(opts) {
 
 /**
  * Run mvnw with provided commands.
- * @param {Hash} args - All arguments to pass to it
- * @param {String} tgt - Path to the target directory
- * @param {Boolean} batch - Is it batch mode (TRUE) or interactive (FALSE)?
+ * @param {Array.<String>} args - All arguments to pass to it
+ * @param {String} [tgt] - Path to the target directory
+ * @param {Boolean} [batch] - Is it batch mode (TRUE) or interactive (FALSE)?
  * @return {Promise} of maven execution task
  */
 module.exports.mvnw = function(args, tgt, batch) {
@@ -131,8 +131,6 @@ module.exports.mvnw = function(args, tgt, batch) {
 
 /**
  * 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() {
   running = true;

package/src/version.js

@@ -25,6 +25,6 @@
 // The values here are replaced automatically by the .rultor.yml script,
 // at the "release" pipeline:
 module.exports = {
-  what: '0.19.0',
-  when: '2024-05-11'
+  what: '0.20.0',
+  when: '2024-05-31'
 };