Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/objectionary/eoc
Command-line toolkit for parsing, compiling, transpiling, optimizing, linking, dataizing, and running EOLANG programs
https://github.com/objectionary/eoc
command-line eolang java javascript maven toolkit
Last synced: 1 day ago
JSON representation
Command-line toolkit for parsing, compiling, transpiling, optimizing, linking, dataizing, and running EOLANG programs
- Host: GitHub
- URL: https://github.com/objectionary/eoc
- Owner: objectionary
- License: mit
- Created: 2022-05-06T11:03:50.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T22:14:42.000Z (15 days ago)
- Last Synced: 2024-10-29T22:41:51.358Z (15 days ago)
- Topics: command-line, eolang, java, javascript, maven, toolkit
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/eolang
- Size: 900 KB
- Stars: 17
- Watchers: 3
- Forks: 12
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Citation: CITATION.cff
Awesome Lists containing this project
README
# EOLANG Command Line Took-Kit
[](https://www.elegantobjects.org)
[](https://www.jetbrains.com/idea/)
[](https://github.com/objectionary/eoc/actions/workflows/grunt.yml)
[](https://www.npmjs.com/package/eolang)
[](http://www.0pdd.com/p?name=objectionary/eoc)
[](https://hitsofcode.com/view/github/objectionary/eoc)
[](https://github.com/objectionary/eoc/blob/master/LICENSE.txt)
First, you install [npm][npm-install] and [Java SE][java-se].
Then, you install [eolang][npm] package:
```bash
npm install -g [email protected]
```
Then, you write a simple [EO](https://www.eolang.org) program in `hello.eo` file
in the current directory:
```eo
# My first object in EO!
[args] > hello
QQ.io.stdout > @
"Hello, world!\n"
```
Then, you run it:
```bash
eoc dataize hello
```
That's it.
## Commands
You can also do many other things with `eoc` commands
(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,
and pulls foreign EO objects
* `transpile` converts `.xmir` files to the target programming
language (Java by default)
* `compile` converts target language sources (e.g., `.java`)
to binaries (e.g., `.class`)
* `link` puts all binaries together into a single executable binary
* `dataize` dataizes a single object from the executable binary
* `test` dataizes all visible unit tests
* `jeo:disassemble` converts Java `.class` files to `.xmir`
(via [jeo](https://github.com/objectionary/jeo-maven-plugin))
* `jeo:assemble` converts `.xmir` files to Java `.class` files
(via [jeo](https://github.com/objectionary/jeo-maven-plugin))
There are also commands that help manipulate with XMIR and EO sources
(the list is not completed, while some of them are not implemented as of yet):
* `audit` inspects all required packages and reports their status
* `foreign` inspects all objects found in the program after the `assemble` step
* `sodg` generates `.sodg` from `.xmir`, further rederable as XML or [Dot][dot]
* `phi` generates `.phi` files from `.xmir` files
* `unphi` generates `.xmir` files from `.phi` files
* `print` generates `.eo` files from `.phi` files
* ~~`translate` converts Java/C++/Python/etc. program to EO program~~
* ~~`demu` removes `cage` and `memory` objects~~
* ~~`dejump` removes `goto` objects~~
* ~~`infer` suggests object names where it's possible to infer them~~
* ~~`flatten` moves inner objects to upper level~~
This command line toolkit simply integrates other tools available in
the [@objectionary](https://github.com/objectionary) GitHub organization.
## How to Contribute
First, run `npm install`. Then, run `grunt`. All tests should pass.
If you want to run a single test:
```bash
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