eolang 0.13.3 → 0.14.0

package/README.md

@@ -23,7 +23,7 @@ Then, you write a simple [EO](https://www.eolang.org) program in `hello.eo` file
 in the current directory:
 
 ```
-[args...] > hello
+[args] > hello
   QQ.io.stdout > @
     "Hello, world!\n"
 ```

package/eo-version.txt

@@ -0,0 +1 @@
+0.34.1

package/mvnw/.mvn/wrapper/maven-wrapper.properties

@@ -14,5 +14,5 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.2/apache-maven-3.9.2-bin.zip
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.6/apache-maven-3.9.6-bin.zip
 wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.1/maven-wrapper-3.1.1.jar

package/mvnw/pom.xml

@@ -24,11 +24,11 @@ SOFTWARE.
   <modelVersion>4.0.0</modelVersion>
   <groupId>org.eolang</groupId>
   <artifactId>eoc</artifactId>
-  <version>1.0-SNAPSHOT</version>
+  <version>0.0.0</version>
   <properties>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
-    <eo.version>0.0.0</eo.version>
+    <eo.version>undefined</eo.version>
   </properties>
   <dependencies>
     <dependency>
@@ -39,12 +39,12 @@ SOFTWARE.
     <dependency>
       <groupId>org.junit.jupiter</groupId>
       <artifactId>junit-jupiter-api</artifactId>
-      <version>5.9.3</version>
+      <version>5.10.1</version>
     </dependency>
     <dependency>
       <groupId>org.junit.jupiter</groupId>
       <artifactId>junit-jupiter-engine</artifactId>
-      <version>5.9.3</version>
+      <version>5.10.1</version>
     </dependency>
   </dependencies>
   <build>
@@ -87,7 +87,7 @@ SOFTWARE.
       </plugin>
       <plugin>
         <artifactId>maven-surefire-plugin</artifactId>
-        <version>3.1.0</version>
+        <version>3.2.3</version>
         <configuration>
           <failIfNoTests>true</failIfNoTests>
         </configuration>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eolang",
-  "version": "0.13.3",
+  "version": "0.14.0",
   "author": "Yegor Bugayenko <yegor256@gmail.com> (https://www.yegor256.com/)",
   "license": "MIT",
   "repository": "objectionary/eoc",
@@ -31,18 +31,18 @@
   ],
   "dependencies": {
     "colors": "1.4.0",
-    "commander": "10.0.1",
-    "fast-xml-parser": "4.2.2",
-    "node": "20.2.0",
+    "commander": "11.1.0",
+    "fast-xml-parser": "4.3.2",
+    "node": "21.2.0",
     "sync-request": "6.1.0",
     "xmlhttprequest": "1.8.0"
   },
   "devDependencies": {
-    "eslint": "8.42.0",
+    "eslint": "8.56.0",
     "eslint-config-google": "0.14.0",
     "grunt": "1.6.1",
     "grunt-contrib-clean": "2.0.1",
-    "grunt-eslint": "24.1.0",
+    "grunt-eslint": "24.3.0",
     "grunt-mocha-cli": "^7.0.0",
     "mocha": "^10.2.0"
   },

package/src/commands/assemble.js

@@ -23,7 +23,7 @@
  */
 
 const path = require('path');
-const mvnw = require('../mvnw');
+const {mvnw, flags} = require('../mvnw');
 
 /**
  * Command to assemble .XMIR files.
@@ -31,18 +31,7 @@ const mvnw = require('../mvnw');
  * @return {Promise} of assemble task
  */
 module.exports = function(opts) {
-  return mvnw([
-    'eo:assemble',
-    '-Deo.version=' + opts.parser,
-    '-Deo.hash=' + (opts.hash ? opts.hash : opts.parser),
-    opts.verbose ? '--errors' : '',
-    opts.verbose ? '' : '--quiet',
-    opts.trackOptimizationSteps ? '-Deo.trackOptimizationSteps' : '',
-    `-Deo.targetDir=${path.resolve(opts.target)}`,
-    `-Deo.outputDir=${path.resolve(opts.target, 'classes')}`,
-    `-Deo.placed=${path.resolve(opts.target, 'eo-placed.csv')}`,
-    `-Deo.placedFormat=csv`,
-  ], opts.target, opts.batch).then((r) => {
+  return mvnw(['eo:assemble'].concat(flags(opts)), opts.target, opts.batch).then((r) => {
     console.info('EO program assembled in %s', path.resolve(opts.target));
     return r;
   });

package/src/commands/audit.js

@@ -22,7 +22,7 @@
  * SOFTWARE.
  */
 
-const mvnw = require('../mvnw');
+const {mvnw} = require('../mvnw');
 
 /**
  * Command to audit all packages.

package/src/commands/compile.js

@@ -22,7 +22,7 @@
  * SOFTWARE.
  */
 
-const mvnw = require('../mvnw');
+const {mvnw, flags} = require('../mvnw');
 const path = require('path');
 
 /**
@@ -32,16 +32,7 @@ const path = require('path');
  */
 module.exports = function(opts) {
   const target = path.resolve(opts.target);
-  return mvnw([
-    'compiler:compile',
-    opts.verbose ? '--errors' : '',
-    opts.verbose ? '' : '--quiet',
-    `-Dmaven.compiler.source=1.8`,
-    `-Dmaven.compiler.target=1.8`,
-    `-Deo.targetDir=${target}`,
-    `-Deo.generatedDir=${path.resolve(opts.target, 'generated-sources')}`,
-    '-Deo.version=' + opts.parser,
-  ], opts.target, opts.batch).then((r) => {
+  return mvnw(['compiler:compile'].concat(flags(opts)), opts.target, opts.batch).then((r) => {
     console.info('Java .class files compiled into %s', target);
     return r;
   });

package/src/commands/dataize.js

@@ -32,15 +32,18 @@ const path = require('path');
  * @param {Hash} opts - All options
  */
 module.exports = function(obj, args, opts) {
-  spawn(
-    `java`,
-    [
-      '-Dfile.encoding=UTF-8',
-      `-Xss${opts.stack}`,
-      '-jar', path.resolve(opts.target, 'eoc.jar'),
-      obj,
-      ...args,
-    ],
-    {stdio: 'inherit'}
-  );
+  const params = [
+    '-Dfile.encoding=UTF-8',
+    `-Xss${opts.stack}`,
+    '-jar', path.resolve(opts.target, 'eoc.jar'),
+    obj,
+    ...args,
+  ];
+  console.debug('+ java ' + params.join(' '));
+  spawn('java', params, {stdio: 'inherit'}).on('close', (code) => {
+    if (code !== 0) {
+      console.error(`Java exited with #${code} code`);
+      process.exit(1);
+    }
+  });
 };

package/src/commands/link.js

@@ -22,7 +22,7 @@
  * SOFTWARE.
  */
 
-const mvnw = require('../mvnw');
+const {mvnw, flags} = require('../mvnw');
 const path = require('path');
 
 /**
@@ -31,13 +31,7 @@ const path = require('path');
  * @return {Promise} of link task
  */
 module.exports = function(opts) {
-  return mvnw([
-    'jar:jar',
-    opts.verbose ? '--errors' : '',
-    opts.verbose ? '' : '--quiet',
-    `-Deo.targetDir=${path.resolve(opts.target)}`,
-    '-Deo.version=' + opts.parser,
-  ], opts.target, opts.batch).then((r) => {
+  return mvnw(['jar:jar'].concat(flags(opts)), opts.target, opts.batch).then((r) => {
     console.info('Executable JAR created at %s', path.resolve(opts.target, 'eoc.jar'));
     return r;
   });

package/src/commands/parse.js

@@ -23,7 +23,7 @@
  */
 
 const path = require('path');
-const mvnw = require('../mvnw');
+const {mvnw, flags} = require('../mvnw');
 
 /**
  * Command to parse EO into .XMIR files.
@@ -31,15 +31,7 @@ const mvnw = require('../mvnw');
  * @return {Promise} of assemble task
  */
 module.exports = function(opts) {
-  return mvnw([
-    'eo:parse',
-    '-Deo.version=' + opts.parser,
-    '-Deo.hash=' + (opts.hash ? opts.hash : opts.parser),
-    opts.verbose ? '--errors' : '',
-    opts.verbose ? '' : '--quiet',
-    `-Deo.targetDir=${path.resolve(opts.target)}`,
-    `-Deo.outputDir=${path.resolve(opts.target, 'classes')}`,
-  ], opts.target, opts.batch).then((r) => {
+  return mvnw(['eo:parse'].concat(flags(opts)), opts.target, opts.batch).then((r) => {
     console.info('EO sources parsed in %s', path.resolve(opts.target));
     return r;
   });

package/src/commands/phi.js

@@ -0,0 +1,48 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2022-2023 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 path = require('path');
+const {mvnw, flags} = require('../mvnw');
+
+/**
+ * Command to convert .XMIR files into .PHI files.
+ * @param {Hash} opts - All options
+ * @return {Promise} of assemble task
+ */
+module.exports = function(opts) {
+  return mvnw(
+    ['eo:xmir-to-phi']
+      .concat(flags(opts))
+      .concat(
+        [
+          `-DphiInputDir=${path.resolve(opts.target, '2-optimize')}`,
+          `-DphiOutputDir=${path.resolve(opts.target, 'phi')}`,
+        ]
+      ),
+    opts.target, opts.batch
+  ).then((r) => {
+    console.info('XMIR files converted into PHI files at %s', path.resolve(opts.target));
+    return r;
+  });
+};

package/src/commands/register.js

@@ -22,7 +22,7 @@
  * SOFTWARE.
  */
 
-const mvnw = require('../mvnw');
+const {mvnw, flags} = require('../mvnw');
 const path = require('path');
 
 /**
@@ -32,14 +32,7 @@ const path = require('path');
  */
 module.exports = function(opts) {
   const foreign = path.resolve(opts.target, 'eo-foreign.json');
-  return mvnw([
-    'eo:register',
-    '-Deo.version=' + opts.parser,
-    opts.verbose ? '--errors' : '',
-    opts.verbose ? '' : '--quiet',
-    `-Deo.targetDir=${path.resolve(opts.target)}`,
-    `-Deo.sourcesDir=${path.resolve(opts.sources)}`,
-  ], opts.target, opts.batch).then((r) => {
+  return mvnw(['eo:register'].concat(flags(opts)), opts.target, opts.batch).then((r) => {
     console.info('EO objects registered in %s', foreign);
     return r;
   });

package/src/commands/sodg.js

@@ -23,7 +23,7 @@
  */
 
 const path = require('path');
-const mvnw = require('../mvnw');
+const {mvnw, flags} = require('../mvnw');
 
 /**
  * Generate SODG files from XMIR.
@@ -31,13 +31,7 @@ const mvnw = require('../mvnw');
  * @return {Promise} of sodg task
  */
 module.exports = function(opts) {
-  const argv = [
-    'eo:sodg',
-    '-Deo.version=' + opts.parser,
-    opts.verbose ? '' : '--quiet',
-    opts.verbose ? '--errors' : '',
-    `-Deo.targetDir=${path.resolve(opts.target)}`,
-  ];
+  const argv = ['eo:sodg'].concat(flags(opts));
   argv.push('-Deo.sodgIncludes=' + opts.include);
   if (opts.exclude) {
     argv.push('-Deo.sodgExcludes=' + opts.exclude);

package/src/commands/test.js

@@ -22,8 +22,7 @@
  * SOFTWARE.
  */
 
-const mvnw = require('../mvnw');
-const path = require('path');
+const {mvnw, flags} = require('../mvnw');
 
 /**
  * Command to run all available unit tests.
@@ -31,9 +30,5 @@ const path = require('path');
  * @return {Promise} of compile task
  */
 module.exports = function(opts) {
-  return mvnw([
-    'surefire:test',
-    '-Deo.version=' + opts.parser,
-    `-Deo.targetDir=${path.resolve(opts.target)}`,
-  ]);
+  return mvnw(['surefire:test'].concat(flags(opts)));
 };

package/src/commands/transpile.js

@@ -22,7 +22,7 @@
  * SOFTWARE.
  */
 
-const mvnw = require('../mvnw');
+const {mvnw, flags} = require('../mvnw');
 const path = require('path');
 
 /**
@@ -32,14 +32,7 @@ const path = require('path');
  */
 module.exports = function(opts) {
   const sources = path.resolve(opts.target, 'generated-sources');
-  return mvnw([
-    'eo:transpile',
-    '-Deo.version=' + opts.parser,
-    opts.verbose ? '--errors' : '',
-    opts.verbose ? '' : '--quiet',
-    `-Deo.targetDir=${path.resolve(opts.target)}`,
-    `-Deo.generatedDir=${sources}`,
-  ], opts.target, opts.batch).then((r) => {
+  return mvnw(['eo:transpile'].concat(flags(opts)), opts.target, opts.batch).then((r) => {
     console.info('Java sources generated in %s', sources);
     return r;
   });

package/src/commands/verify.js

@@ -0,0 +1,38 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2022-2023 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 path = require('path');
+const {mvnw, flags} = require('../mvnw');
+
+/**
+ * Command to verify .XMIR files.
+ * @param {Hash} opts - All options
+ * @return {Promise} of assemble task
+ */
+module.exports = function(opts) {
+  return mvnw(['eo:verify'].concat(flags(opts)), opts.target, opts.batch).then((r) => {
+    console.info('EO program verified in %s', path.resolve(opts.target));
+    return r;
+  });
+};

package/src/eoc.js

@@ -30,7 +30,9 @@ const clean = require('./commands/clean');
 const parse = require('./commands/parse');
 const assemble = require('./commands/assemble');
 const sodg = require('./commands/sodg');
+const phi = require('./commands/phi');
 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');
@@ -43,16 +45,23 @@ if (process.argv.includes('--verbose')) {
   console.debug('Debug output is turned ON');
 }
 
-let parser = '0.29.4';
+const fs = require('fs');
+const path = require('path');
+let parser = fs.readFileSync(path.join(__dirname, '../eo-version.txt'), 'utf8');
 if (process.argv.includes('--latest')) {
   parser = require('./parser-version').get();
+} else {
+  console.debug('EO parser ' + parser + '; use the --latest flag if you need a freshier one');
 }
 
 const version = require('./version');
 program
   .name('eoc')
-  .description('EO command-line toolkit (' + version.what + ' ' + version.when + ')')
-  .version(version.what);
+  .usage('[options] command')
+  .summary('EO command line toolkit')
+  .description('EO command-line toolkit (' + version.what + ' built on ' + version.when + ')')
+  .version(version.what, '-v, --version', 'Output the version number')
+  .helpOption('-?, --help', 'Print this help information');
 
 program
   .option('-s, --sources <path>', 'Directory with .EO sources', '.')
@@ -65,6 +74,7 @@ program
   .option('--no-color', 'Disable colorization of console messages')
   .option('--track-optimization-steps', 'Save intermediate XMIR files')
   .option('-c, --clean', 'Delete ./.eoc directory')
+  .option('--debug', 'Print ALL debug messages, heavily overloading the log')
   .option('--verbose', 'Print debug messages and full output of child processes');
 
 program.command('audit')
@@ -136,6 +146,32 @@ program.command('sodg')
     }
   });
 
+program.command('phi')
+  .description('Generate PHI files from XMIR')
+  .action((str, opts) => {
+    clear(str);
+    if (program.opts().alone == undefined) {
+      register(program.opts())
+        .then((r) => assemble(program.opts()))
+        .then((r) => phi(program.opts()));
+    } else {
+      phi(program.opts());
+    }
+  });
+
+program.command('verify')
+  .description('Verify XMIR files and fail if any issues inside')
+  .action((str, opts) => {
+    clear(str);
+    if (program.opts().alone == undefined) {
+      register(program.opts())
+        .then((r) => assemble(program.opts()))
+        .then((r) => verify(program.opts()));
+    } else {
+      verify(program.opts());
+    }
+  });
+
 program.command('transpile')
   .description('Convert EO files into target language')
   .action((str, opts) => {
@@ -143,6 +179,7 @@ program.command('transpile')
     if (program.opts().alone == undefined) {
       register(program.opts())
         .then((r) => assemble(program.opts()))
+        .then((r) => verify(program.opts()))
         .then((r) => transpile(program.opts()));
     } else {
       transpile(program.opts());
@@ -156,6 +193,7 @@ program.command('compile')
     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()));
     } else {
@@ -170,6 +208,7 @@ program.command('link')
     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()));
@@ -186,6 +225,7 @@ program.command('dataize')
     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()))
@@ -202,6 +242,7 @@ program.command('test')
     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()))

package/src/mvnw.js

@@ -43,6 +43,28 @@ let target;
 let running = false;
 let beginning;
 
+/**
+ * Prepare options for Maven.
+ * @param {Hash} opts - Opts provided to the "eoc"
+ * @return {Array} of Maven options
+ */
+module.exports.flags = function(opts) {
+  return [
+    '-Deo.version=' + opts.parser,
+    '-Deo.hash=' + (opts.hash ? opts.hash : opts.parser),
+    opts.verbose ? '--errors' : '',
+    opts.verbose ? '' : '--quiet',
+    opts.debug ? '--debug' : '',
+    `-Deo.sourcesDir=${path.resolve(opts.sources)}`,
+    `-Deo.targetDir=${path.resolve(opts.target)}`,
+    `-Deo.outputDir=${path.resolve(opts.target, 'classes')}`,
+    `-Deo.generatedDir=${path.resolve(opts.target, 'generated-sources')}`,
+    `-Deo.placed=${path.resolve(opts.target, 'eo-placed.csv')}`,
+    `-Deo.placedFormat=csv`,
+    opts.trackOptimizationSteps ? '-Deo.trackOptimizationSteps' : '',
+  ];
+};
+
 /**
  * Run mvnw with provided commands.
  * @param {Hash} args - All arguments to pass to it
@@ -50,7 +72,7 @@ let beginning;
  * @param {Boolean} batch - Is it batch mode (TRUE) or interactive (FALSE)?
  * @return {Promise} of maven execution task
  */
-module.exports = function(args, tgt, batch) {
+module.exports.mvnw = function(args, tgt, batch) {
   return new Promise((resolve, reject) => {
     target = tgt;
     phase = args[0];
@@ -131,7 +153,6 @@ function stop() {
  * Prints mvnw execution status.
  */
 function print() {
-  readline.clearLine(process.stdout);
   const duration = Date.now() - beginning;
   /**
    * Recursively calculates number of files under a directory.
@@ -161,8 +182,9 @@ function print() {
     elapsed = `${Math.ceil(duration / 3600000)}min`;
   }
   process.stdout.write(
-    colors.yellow(`[${phase}] ${elapsed}; ${count(target, 0)} files generated...`)
+    colors.yellow(`[${phase}] ${elapsed}; ${count(target, 0)} files generated so far...`)
   );
+  readline.clearLine(process.stdout, 1);
   readline.cursorTo(process.stdout, 0);
 }
 

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.13.3',
-  when: '2023-06-03'
+  what: '0.14.0',
+  when: '2023-12-22'
 };