eMoflon
/
model-modeling-language-cli
mirror of https://github.com/eMoflon/model-modeling-language-cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
24 Commits 4 Branches 0 Tags 467 KiB
Java 100%
Go to file
Janik 784e2c538e
Merge pull request #1 from eMoflon/feature/deserializer 
Feature/deserializer
 		2024-01-05 14:45:50 +01:00
src activated automatic tests 2024-01-03 13:55:51 +01:00
.gitignore added .gitignore 2023-12-14 19:32:20 +01:00
README.md updated README 2024-01-04 17:53:19 +01:00
dependency-reduced-pom.xml implemented automatic generator and serializer tests 2023-12-28 22:38:58 +01:00
pom.xml implemented automatic generator and serializer tests 2023-12-28 22:38:58 +01:00

README.md

Model Modeling Language CLI

The Model Modeling Language (MML) is a domain-specific modeling language implemented with the open-source language engineering tool Langium. This repository contains a CLI that serves as a link between the Javascript-based MML and the Java-based Eclipse Modeling Framework as well as the HiPE Pattern Matcher.

The CLI can be integrated directly in the VSCode plugin of MML in order to access individual functions directly from the user interface, but it can also be executed in the command line, in which case inputs must be available as a file.

ℹ️ The CLI requires at least Java 17!

How to build

  1. Make sure that a Java JDK is installed that fulfills the requirements
  2. Build the CLI using Maven 
    mvn package

Usage

Usage with the MML VSCode plugin

Install the MML VSCode plugin according to the corresponding instructions. Also build the CLI as a JAR file. Open the VSCode settings and navigate to the "Model Modeling Language" section under "Extensions". Enter the path to the Jar file in the field provided.

🎉 You can now use the Modeling Language to its full extent directly in VSCode!

Stand-alone use

The CLI can also be used independently of the VSCode plugin. In this case, input and output are usually via files, the path of which is also specified in the command.

In general, the CLI can be called by executing the JAR file.

java -jar ./target/model-modeling-language-cli-1.0-SNAPSHOT.jar

In the following we use the alias mmlcli.

Usage: mmlcli [-hV] [COMMAND]
            -h, --help Show this help message and exit.
            -V, --version Print version information and exit.

Generate

The generate command is used to generate Ecore and XMI files from the serialized MML format. By default, the input is via STDIN, the output is in the form of the generated files in a specified directory. Optionally, a file whose content is in serialized MML format can be specified instead of the STDIN input.

Usage: mmlcli generate [-f[=SERIALIZED]] <projectName> <outputDirectory>
            <projectName>           Name of the entire project/workspace
            <outputDirectory>       Path to the output directory
            -f, --file[=SERIALIZED] Path to the serialized workspace as json file

Serialize

The serialize command is used to serialize Ecore files into the MML format. The entry is made by specifying a path to an Ecore file. The output is via STDOUT by default, but optionally a path to an output file can also be specified in which the serialized model is to be saved.

Usage: mmlcli serialize [-o[=SERIALIZED]] <ecoreFile>
            <ecoreFile>             Path to an Ecore file
            -o, --out[=SERIALIZED]  Path to the output directory