eolang 0.29.0 → 0.30.0

package/README.md

@@ -5,7 +5,7 @@
 
 [![grunt](https://github.com/objectionary/eoc/actions/workflows/grunt.yml/badge.svg)](https://github.com/objectionary/eoc/actions/workflows/grunt.yml)
 [![node-current](https://img.shields.io/node/v/eolang)](https://www.npmjs.com/package/eolang)
-[![PDD status](http://www.0pdd.com/svg?name=objectionary/eoc)](http://www.0pdd.com/p?name=objectionary/eoc)
+[![PDD status](https://www.0pdd.com/svg?name=objectionary/eoc)](https://www.0pdd.com/p?name=objectionary/eoc)
 [![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)
 
@@ -18,7 +18,7 @@ First, you install [npm][npm-install] and [Java SE][java-se].
 Then, you install [eolang][npm] package:
 
 ```bash
-npm install -g eolang@0.28.0
+npm install -g eolang@0.29.0
 ```
 
 Then, you write a simple [EO](https://www.eolang.org) program in `hello.eo` file
@@ -69,6 +69,11 @@ There are also commands that help manipulate with XMIR and EO sources
 * `phi` generates `.phi` files from `.xmir` files
 * `unphi` generates `.xmir` files from `.phi` files
 * `print` generates `.eo` files from `.phi` files
+* `generate_comments` generates `.json` files with LLM-generated
+  documentation for `.eo` structures
+* `docs` generates HTML documentation from `.xmir` files
+* `latex` generates `.tex` files from `.eo` sources
+* `fmt` formats `.eo` files in the source directory
 * ~~`translate` converts Java/C++/Python/etc. program to EO program~~
 * ~~`demu` removes `cage` and `memory` objects~~
 * ~~`dejump` removes `goto` objects~~

package/REUSE.toml

@@ -4,11 +4,19 @@
 version = 1
 [[annotations]]
 path = [
+    ".DS_Store",
+    ".gitattributes",
+    ".gitignore",
+    ".npmignore",
+    ".pdd",
     "**.csv",
     "**.json",
     "**.md",
     "**.png",
     "**.txt",
+    "**/.DS_Store",
+    "**/.gitignore",
+    "**/.pdd",
     "**/*.csv",
     "**/*.jpg",
     "**/*.json",
@@ -18,17 +26,9 @@ path = [
     "**/*.svg",
     "**/*.txt",
     "**/*.vm",
-    "**/.DS_Store",
-    "**/.gitignore",
-    "**/.pdd",
     "**/CITATION.cff",
     "**/CNAME",
     "**/MANIFEST.MF",
-    ".DS_Store",
-    ".gitattributes",
-    ".gitignore",
-    ".npmignore",
-    ".pdd",
     "CITATION.cff",
     "MANIFEST.MF",
     "README.md",

package/eo-version.txt

@@ -1 +1 @@
-0.55.0
+0.56.7

package/eslint.config.js

@@ -0,0 +1,75 @@
+/*
+ * SPDX-FileCopyrightText: Copyright (c) 2022-2025 Objectionary.com
+ * SPDX-License-Identifier: MIT
+ */
+
+const { configs } = require('@eslint/js');
+const promise = require('eslint-plugin-promise');
+
+module.exports = [
+  {
+    ignores: ['node_modules/'],
+  },
+  {
+    ...configs.all,
+    files: ['**/*.js'],
+    languageOptions: {
+      ecmaVersion: 2019,
+      sourceType: 'module'
+    },
+    plugins: {
+      promise,
+    },
+    rules: {
+      ...configs.all.rules,
+      'camelcase': 'off',
+      'capitalized-comments': 'off',
+      'consistent-return': 'off',
+      'default-param-last': 'off',
+      'eqeqeq': 'off',
+      'func-names': 'off',
+      'func-style': 'off',
+      'id-length': 'off',
+      'indent': ['error', 2, { "SwitchCase": 1 }],
+      'init-declarations': 'off',
+      'max-len': ['error', { code: 200 }],
+      'max-lines': 'off',
+      'max-lines-per-function': 'off',
+      'max-params': 'off',
+      'max-statements': 'off',
+      'no-alert': 'off',
+      'no-console': 'off',
+      'no-dupe-keys': 'off',
+      'no-inline-comments': 'off',
+      'no-invalid-this': 'off',
+      'no-magic-numbers': 'off',
+      'no-multi-assign': 'off',
+      'no-param-reassign': 'off',
+      'no-plusplus': 'off',
+      'no-promise-executor-return': 'off',
+      'no-prototype-builtins': 'off',
+      'no-shadow': 'off',
+      'no-ternary': 'off',
+      'no-undef': 'off',
+      'no-undefined': 'off',
+      'no-unused-vars': 'off',
+      'no-use-before-define': 'off',
+      'one-var': 'off',
+      'prefer-destructuring': 'off',
+      'require-await': 'off',
+      'require-unicode-regexp': 'off',
+      'sort-keys': 'off',
+      'sort-vars': 'off',
+      "promise/prefer-await-to-then": "off"
+    }
+  },
+  {
+    files: [
+      'src/commands/js/transpile.js',
+      'src/commands/js/link.js',
+    ],
+    rules: {
+      'promise/prefer-await-to-then': 'warn',
+    },
+  }
+];

package/home-tag.txt

@@ -1 +1 @@
-0.55.0
+0.56.7

package/mvnw/dependency-reduced-pom.xml

@@ -7,7 +7,7 @@
   <build>
     <sourceDirectory>${eo.generatedDir}</sourceDirectory>
     <outputDirectory>${eo.targetDir}/classes</outputDirectory>
-    <testOutputDirectory>${eo.targetDir}/classes</testOutputDirectory>
+    <testOutputDirectory>${eo.targetDir}/test-classes</testOutputDirectory>
     <directory>${eo.targetDir}</directory>
     <finalName>eoc</finalName>
     <plugins>
@@ -79,7 +79,7 @@
       </plugin>
       <plugin>
         <artifactId>maven-surefire-plugin</artifactId>
-        <version>3.5.2</version>
+        <version>3.5.3</version>
         <configuration>
           <failIfNoTests>true</failIfNoTests>
           <useFile>false</useFile>
@@ -94,6 +94,25 @@
           </properties>
         </configuration>
       </plugin>
+      <plugin>
+        <groupId>org.codehaus.mojo</groupId>
+        <artifactId>build-helper-maven-plugin</artifactId>
+        <version>3.6.1</version>
+        <executions>
+          <execution>
+            <id>add-test-sources</id>
+            <phase>generate-test-sources</phase>
+            <goals>
+              <goal>add-test-source</goal>
+            </goals>
+            <configuration>
+              <sources>
+                <source>${project.build.directory}/generated-test-sources</source>
+              </sources>
+            </configuration>
+          </execution>
+        </executions>
+      </plugin>
     </plugins>
   </build>
   <properties>
@@ -102,6 +121,6 @@
     <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
     <heap-size>undefined</heap-size>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-    <jeo.version>0.6.26</jeo.version>
+    <jeo.version>0.10.0</jeo.version>
   </properties>
 </project>

package/mvnw/pom.xml

@@ -10,7 +10,7 @@
   <version>0.0.0</version>
   <packaging>jar</packaging>
   <properties>
-    <jeo.version>0.6.26</jeo.version>
+    <jeo.version>0.10.0</jeo.version>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
     <eo.version>undefined</eo.version>
@@ -26,13 +26,13 @@
     <dependency>
       <groupId>org.junit.jupiter</groupId>
       <artifactId>junit-jupiter-api</artifactId>
-      <version>5.11.4</version>
+      <version>5.13.0</version>
       <scope>compile</scope>
     </dependency>
     <dependency>
       <groupId>org.junit.jupiter</groupId>
       <artifactId>junit-jupiter-engine</artifactId>
-      <version>5.11.4</version>
+      <version>5.13.0</version>
       <scope>compile</scope>
     </dependency>
   </dependencies>
@@ -41,7 +41,7 @@
     <sourceDirectory>${eo.generatedDir}</sourceDirectory>
     <directory>${eo.targetDir}</directory>
     <outputDirectory>${eo.targetDir}/classes</outputDirectory>
-    <testOutputDirectory>${eo.targetDir}/classes</testOutputDirectory>
+    <testOutputDirectory>${eo.targetDir}/test-classes</testOutputDirectory>
     <plugins>
       <plugin>
         <artifactId>maven-enforcer-plugin</artifactId>
@@ -111,7 +111,7 @@
       </plugin>
       <plugin>
         <artifactId>maven-surefire-plugin</artifactId>
-        <version>3.5.2</version>
+        <version>3.5.3</version>
         <configuration>
           <failIfNoTests>true</failIfNoTests>
           <useFile>false</useFile>
@@ -128,6 +128,25 @@
           </properties>
         </configuration>
       </plugin>
+      <plugin>
+        <groupId>org.codehaus.mojo</groupId>
+        <artifactId>build-helper-maven-plugin</artifactId>
+        <version>3.6.1</version>
+        <executions>
+          <execution>
+            <id>add-test-sources</id>
+            <phase>generate-test-sources</phase>
+            <goals>
+              <goal>add-test-source</goal>
+            </goals>
+            <configuration>
+              <sources>
+                <source>${project.build.directory}/generated-test-sources</source>
+              </sources>
+            </configuration>
+          </execution>
+        </executions>
+      </plugin>
     </plugins>
   </build>
 </project>

package/package.json

@@ -4,25 +4,30 @@
     "eoc": "./src/eoc.js"
   },
   "dependencies": {
+    "@langchain/core": "^0.3.55",
+    "@langchain/openai": "^0.5.10",
     "colors": "1.4.0",
     "commander": "12.1.0",
     "eo2js": "0.0.8",
-    "fast-xml-parser": "4.5.1",
-    "node": "23.5.0",
+    "fast-xml-parser": "5.2.3",
+    "node": "24.1.0",
     "relative": "3.0.2",
-    "semver": "7.6.3",
+    "semver": "7.7.2",
     "sync-request": "6.1.0",
     "xmlhttprequest": "1.8.0"
   },
   "description": "A collection of command line tools for EOLANG: compiling, parsing, transpiling to other languages, optimizing, and analyzing",
   "devDependencies": {
-    "eslint": "9.17.0",
+    "@eslint/js": "^9.27.0",
+    "eslint": "9.28.0",
     "eslint-config-google": "0.14.0",
+    "eslint-plugin-promise": "^7.2.1",
     "grunt": "1.6.1",
     "grunt-contrib-clean": "2.0.1",
-    "grunt-eslint": "24.3.0",
-    "grunt-mocha-cli": "^4.0.0",
-    "mocha": "^10.8.2"
+    "grunt-eslint": "25.0.0",
+    "grunt-mocha-cli": "^7.0.0",
+    "mocha": "^11.5.0",
+    "patch-package": "^8.0.0"
   },
   "engines": {
     "node": ">6.0",
@@ -49,7 +54,8 @@
   ],
   "repository": "objectionary/eoc",
   "scripts": {
+    "postinstall": "patch-package",
     "test": "mocha --timeout 1200000"
   },
-  "version": "0.29.0"
+  "version": "0.30.0"
 }

package/patches/grunt-mocha-cli+7.0.0.patch

@@ -0,0 +1,25 @@
+# SPDX-FileCopyrightText: Copyright (c) 2025 Objectionary.com
+# SPDX-License-Identifier: MIT
+diff --git a/node_modules/grunt-mocha-cli/lib/index.js b/node_modules/grunt-mocha-cli/lib/index.js
+index 59f7a07..4cc7182 100644
+--- a/node_modules/grunt-mocha-cli/lib/index.js
++++ b/node_modules/grunt-mocha-cli/lib/index.js
+@@ -2,6 +2,7 @@
+ const fs = require('fs')
+ const path = require('path')
+ const grunt = require('grunt')
++const os = require('os')
+ 
+ const BOOL_OPTIONS = [
+   'allow-uncaught',
+@@ -55,6 +56,10 @@ module.exports = function(options) {
+     spawnOptions.cmd = path.dirname(spawnOptions.cmd)
+     spawnOptions.cmd += '/../.bin/mocha'
+ 
++    if (os.platform() === 'win32') {
++      spawnOptions.opts.shell = true
++    }
++
+     if (process.platform === 'win32') {
+       spawnOptions.cmd += '.cmd'
+     }

package/src/commands/assemble.js

@@ -1,23 +1,3 @@
-// Copyright (c) 2022-2025 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.
-
 /*
  * SPDX-FileCopyrightText: Copyright (c) 2022-2025 Objectionary.com
  * SPDX-License-Identifier: MIT
@@ -35,10 +15,8 @@ const {elapsed} = require('../elapsed');
  */
 module.exports = function(opts) {
   const target = path.resolve(opts.target);
-  return elapsed((tracked) => {
-    return mvnw(['eo:assemble'].concat(flags(opts)), opts.target, opts.batch).then((r) => {
-      tracked.print('EO program assembled in %s', rel(target));
-      return r;
-    });
-  });
+  return elapsed((tracked) => mvnw(['eo:assemble'].concat(flags(opts)), opts.target, opts.batch).then((r) => {
+    tracked.print('EO program assembled in %s', rel(target));
+    return r;
+  }));
 };

package/src/commands/audit.js

@@ -1,23 +1,3 @@
-// Copyright (c) 2022-2025 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.
-
 /*
  * SPDX-FileCopyrightText: Copyright (c) 2022-2025 Objectionary.com
  * SPDX-License-Identifier: MIT

package/src/commands/clean.js

@@ -1,23 +1,3 @@
-// Copyright (c) 2022-2025 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.
-
 /*
  * SPDX-FileCopyrightText: Copyright (c) 2022-2025 Objectionary.com
  * SPDX-License-Identifier: MIT

package/src/commands/docs.js

@@ -1,23 +1,3 @@
-// Copyright (c) 2022-2025 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.
-
 /*
  * SPDX-FileCopyrightText: Copyright (c) 2022-2025 Objectionary.com
  * SPDX-License-Identifier: MIT
@@ -27,10 +7,48 @@ const fs = require('fs');
 const path = require('path');
 
 /**
- * Command to create docs from .EO sources.
+ * Recursively reads all .xmir files from a directory.
+ * @param {string} dir - Directory path
+ * @return {string[]} Array of file paths
+ */
+function readXmirsRecursively(dir) {
+  const files = [];
+  const entries = fs.readdirSync(dir, {withFileTypes: true});
+  for (const entry of entries) {
+    const full = path.join(dir, entry.name);
+    if (entry.isDirectory()) {
+      files.push(...readXmirsRecursively(full));
+    } else if (entry.name.endsWith('.xmir')) {
+      files.push(full);
+    }
+  }
+  return files;
+}
+
+/**
+ * Command to generate documentation.
  * @param {Hash} opts - All options
  */
 module.exports = function(opts) {
-  const filePath = path.resolve('eodocs.html');
-  fs.writeFileSync(filePath, '');
+  try {
+    const input = path.resolve(opts.target, '.eoc', '1-parse');
+    const output = path.resolve(opts.target, 'docs');
+    fs.mkdirSync(output, {recursive: true});
+    const xmirs = readXmirsRecursively(input);
+    for (const xmir of xmirs) {
+      const relative = path.relative(input, xmir);
+      const packages = path.dirname(relative).split(path.sep).join('.');
+      const html = path.join(output, `package_${packages}.html`);
+      fs.mkdirSync(path.dirname(html), {recursive: true});
+      fs.writeFileSync(html, '');
+    }
+    const packages = path.join(output, 'packages.html');
+    fs.writeFileSync(packages, '');
+    const css = path.join(output, 'styles.css');
+    fs.writeFileSync(css, '');
+    console.info('Documentation generation completed in %s directory', output);
+  } catch (error) {
+    console.error('Error generating documentation:', error);
+    throw error;
+  }
 };

package/src/commands/foreign.js

@@ -1,23 +1,3 @@
-// Copyright (c) 2022-2025 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.
-
 /*
  * SPDX-FileCopyrightText: Copyright (c) 2022-2025 Objectionary.com
  * SPDX-License-Identifier: MIT
@@ -32,10 +12,10 @@ const fs = require('fs');
  * @param {Hash} opts - All options
  */
 module.exports = function(opts) {
-  const file = path.resolve(opts.target, 'eo-foreign.json');
-  const all = JSON.parse(fs.readFileSync(file, 'utf8'));
+  const file = path.resolve(opts.target, 'eo-foreign.json'),
+    all = JSON.parse(fs.readFileSync(file, 'utf8'));
   console.info('There are %d objects in %s:', all.length, rel(file));
   all.forEach((obj) => {
-    console.info('  %s', obj['id']);
+    console.info('  %s', obj.id);
   });
 };