{"id":19838986,"url":"https://github.com/objectionary/ineo-maven-plugin","last_synced_at":"2025-05-01T18:31:44.218Z","repository":{"id":203303421,"uuid":"709214061","full_name":"objectionary/ineo-maven-plugin","owner":"objectionary","description":"Maven plugin that inlines and specializes objects in EO programs","archived":false,"fork":false,"pushed_at":"2024-10-23T18:51:53.000Z","size":698,"stargazers_count":4,"open_issues_count":17,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-24T04:49:29.158Z","etag":null,"topics":["eolang","java","maven-plugin","optimization"],"latest_commit_sha":null,"homepage":"http://www.objectionary.com/ineo-maven-plugin/","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/objectionary.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-10-24T08:59:28.000Z","updated_at":"2024-06-26T14:10:32.000Z","dependencies_parsed_at":null,"dependency_job_id":"450117eb-fa76-4148-94be-4c1a2c2a4756","html_url":"https://github.com/objectionary/ineo-maven-plugin","commit_stats":null,"previous_names":["objectionary/ineo-maven-plugin"],"tags_count":13,"template":false,"template_full_name":"l3r8yJ/elegant","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/objectionary%2Fineo-maven-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/objectionary%2Fineo-maven-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/objectionary%2Fineo-maven-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/objectionary%2Fineo-maven-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/objectionary","download_url":"https://codeload.github.com/objectionary/ineo-maven-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251924795,"owners_count":21666039,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["eolang","java","maven-plugin","optimization"],"created_at":"2024-11-12T12:19:49.819Z","updated_at":"2025-05-01T18:31:43.667Z","avatar_url":"https://github.com/objectionary.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cimg alt=\"logo\" src=\"https://www.objectionary.com/cactus.svg\" height=\"100px\" /\u003e\n\n[![EO principles respected here](https://www.elegantobjects.org/badge.svg)](https://www.elegantobjects.org)\n[![DevOps By Rultor.com](http://www.rultor.com/b/objectionary/eo)](http://www.rultor.com/p/objectionary/eo)\n[![We recommend IntelliJ IDEA](https://www.elegantobjects.org/intellij-idea.svg)](https://www.jetbrains.com/idea/)\n\n\n[![Maven Central](https://img.shields.io/maven-central/v/org.eolang/ineo-maven-plugin.svg)](https://maven-badges.herokuapp.com/maven-central/org.eolang/ineo-maven-plugin)\n[![Javadoc](http://www.javadoc.io/badge/org.eolang/ineo-maven-plugin.svg)](http://www.javadoc.io/doc/org.eolang/ineo-maven-plugin)\n[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE.txt)\n[![Hits-of-Code](https://hitsofcode.com/github/objectionary/ineo-maven-plugin?branch=master\u0026label=Hits-of-Code)](https://hitsofcode.com/github/objectionary/ineo-maven-plugin/view?branch=master\u0026label=Hits-of-Code)\n![Lines of code](https://sloc.xyz/github/objectionary/ineo-maven-plugin)\n[![codecov](https://codecov.io/gh/objectionary/ineo-maven-plugin/branch/master/graph/badge.svg)](https://codecov.io/gh/objectionary/ineo-maven-plugin)\n\n\n**INEO** (stands for EO Inliner) is the tool to inline EO objects in order to get a faster and \nlighter EO code. \n\n# How to use\n\nTo run the plugin you need at least Maven 3.1.+ and Java 8+.\nThe plugin provides two optimizations:\n\n### FUSE \nThe optimization scans the directory and checks if there's any`.xmir` file where the next code occurs:\n\n```xml\n\u003co base=\".new\"\u003e\n  \u003co base=\"B\"/\u003e\n  \u003co base=\".new\"\u003e\n    \u003co base=\"A\"/\u003e\n    \u003co base=\"int\" data=\"bytes\"\u003e\n      \u003c!-- BYTES HERE --\u003e\n    \u003c/o\u003e\n  \u003c/o\u003e\n\u003c/o\u003e\n```\n\nThe plugin adds new fused `BA.xmir` file into the directory and replaces the `xmir` above with the \nnext one:\n\n```xml\n\n\u003co base=\".new\"\u003e\n  \u003co base=\"BA\"/\u003e\n  \u003co base=\"int\" data=\"bytes\"\u003e\n    \u003c!-- BYTES HERE --\u003e\n  \u003c/o\u003e\n\u003c/o\u003e\n```\n\n### STATICIZE\nThe optimization scans the directory and checks if there's any`.xmir` file where the next code occurs:\n\n```xml\n\u003co base=\".get\"\u003e\n  \u003co base=\".new\"\u003e\n    \u003co base=\"A\"/\u003e\n    \u003co base=\"int\" data=\"bytes\"\u003e\n      \u003c!-- BYTES HERE --\u003e\n    \u003c/o\u003e\n  \u003c/o\u003e\n\u003c/o\u003e\n```\n\nThe plugin adds new staticized `StaticizedA.xmir` file into the directory and replaces the `xmir` above with the\nnext one:\n\n```xml\n\n\u003co base=\".get\"\u003e\n  \u003co base=\".new\"\u003e\n    \u003co base=\"StaticizedA\"/\u003e\n    \u003co base=\"int\" data=\"bytes\"\u003e\n      \u003c!-- BYTES HERE --\u003e\n    \u003c/o\u003e\n  \u003c/o\u003e\n\u003c/o\u003e\n```\n\nMeantime `StaticizedA` will use static method instead of instance one. \n\nObjects `A` and `B` must be from the same package and have the same prefix.\n\n### FACTORIALIZE\n\nThe optimization scans the directory and\n1. replaces `org/eolang/benchmark/Main.xmir` with [this Main.xmir](https://github.com/objectionary/ineo-maven-plugin/blob/master/src/main/resources/org/eolang/ineo/factorialize/Main.xmir)\n2. puts [`Factorialized.xmir`](https://github.com/objectionary/ineo-maven-plugin/blob/master/src/main/resources/org/eolang/ineo/factorialize/Factorialized.xmir) near `Main.xmir`\n\n[Here](https://github.com/objectionary/benchmark) you may find a working example that uses the \nplugin with other optimization tools, like [JEO](https://github.com/objectionary/jeo-maven-plugin) \nand [OPEO](https://github.com/objectionary/opeo-maven-plugin)\n\n## Invoke the plugin from the Maven lifecycle\n\nYou can run the plugin from the Maven lifecycle by adding the following\nconfiguration to your `pom.xml` file:\n\n```xml\n\n\u003cbuild\u003e\n  \u003cplugins\u003e\n    \u003cplugin\u003e\n      \u003cgroupId\u003eorg.eolang\u003c/groupId\u003e\n      \u003cartifactId\u003eineo-maven-plugin\u003c/artifactId\u003e\n      \u003cversion\u003e0.2.0\u003c/version\u003e\n      \u003cexecutions\u003e\n        \u003cexecution\u003e\n          \u003cid\u003efuse\u003c/id\u003e\n          \u003cphase\u003egenerate-sources\u003c/phase\u003e\n          \u003cgoals\u003e\n            \u003cgoal\u003efuse\u003c/goal\u003e\n          \u003c/goals\u003e\n        \u003c/execution\u003e\n        \u003cexecution\u003e\n          \u003cid\u003estaticize\u003c/id\u003e\n          \u003cphase\u003egenerate-sources\u003c/phase\u003e\n          \u003cgoals\u003e\n            \u003cgoal\u003efuse\u003c/goal\u003e\n          \u003c/goals\u003e\n        \u003c/execution\u003e\n        \u003cexecution\u003e\n          \u003cid\u003efactorialize\u003c/id\u003e\n          \u003cphase\u003egenerate-sources\u003c/phase\u003e\n          \u003cgoals\u003e\n            \u003cgoal\u003efactorialize\u003c/goal\u003e\n          \u003c/goals\u003e\n          \u003cconfiguration\u003e\n            \u003csourcesDir\u003eSOURCES DIRECTORY\u003c/sourcesDir\u003e\n            \u003coutputDir\u003eOUTPUT DIRECTORY\u003c/outputDir\u003e\n            \u003cmain\u003ePATH TO Main.xmir\u003c/main\u003e\n            \u003cfactorial\u003ePATH TO Factorial.xmir\u003c/factorial\u003e\n          \u003c/configuration\u003e\n        \u003c/execution\u003e\n      \u003c/executions\u003e\n    \u003c/plugin\u003e\n  \u003c/plugins\u003e\n\u003c/build\u003e\n```\n\nMore details about plugin usage you can find in our\n[Maven site](https://objectionary.github.io/ineo-maven-plugin).\n\n## How to Contribute\n\nFork repository, make changes, then send us\na [pull request](https://www.yegor256.com/2014/04/15/github-guidelines.html).\nWe will review your changes and apply them to the `master` branch shortly,\nprovided they don't violate our quality standards. To avoid frustration,\nbefore sending us your pull request please run full Maven build:\n\n```bash\n$ mvn clean install -Pqulice\n```\n\nYou will need [Maven 3.3+](https://maven.apache.org) and Java 8+ installed.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fobjectionary%2Fineo-maven-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fobjectionary%2Fineo-maven-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fobjectionary%2Fineo-maven-plugin/lists"}