Morphir IR v4 (Draft)
The draft specification for Morphir IR format version 4 — not yet active and subject to change.
Open source Repository Open in the app JSON README (API)
About
# Morphir IR v4 (Draft)
Knowledge bundle for the **draft** specification of Morphir IR format version 4. Seeded from `docs/spec/draft/` in
[finos/morphir](https://github.com/finos/morphir) at commit `4d5e5c06`.
> **This is a draft.** Nothing here is settled, and shipping tooling still produces and consumes format version 3.
> Treat every concept in this bundle as a lead about where the format is going, not as a contract. For the active
> format see the sibling `morphir-ir-v3` bundle.
## Orientation
* [Morphir IR v4 Overview](/overview.md) - What Morphir IR v4 is trying to achieve, and how the draft specification is organized.
* [What's New in v4](/whats-new-in-v4.md) - The four headline changes in Morphir IR v4 against format version 3.
* [Migration from v3](/migration-from-v3.md) - What is known today about moving format version 3 IR to version 4, and what is not yet written.
## Identity and addressing
* [Naming](/naming.md) - Canonical string serialization for names, paths, qua
Details
- Kind
- OKF bundles
- Topic
- Version control
- Publisher
- finos
- Origin
- okf_github
- Category
- dados
- Version
- 0.2
- Stars
- 17
- Forks
- 28
- Open pull requests
- 12
- Last push
- 2026-09-10T01:06:48Z
- Repository state
- ativo
- Language
- Scala
- License
- Apache-2.0
- Added
- 2026-09-09 12:02:17
- Updated
- 2026-09-09 12:02:17
- Origin id
finos/morphir-scala:kb/bundles/morphir/morphir-ir-v4-draft/index.md
README
# Morphir
<a href="https://finosfoundation.atlassian.net/wiki/display/FINOS/Active">
<img src="https://cdn.jsdelivr.net/gh/finos/contrib-toolbox@master/images/badge-active.svg" />
</a>
<a href="https://github.com/finos/morphir-scala/actions">
<img src="https://github.com/finos/morphir-scala/workflows/CI/badge.svg" />
</a>
<a href="https://finos-lf.slack.com/messages/morphir/">
<img src="https://img.shields.io/badge/slack-@finos/morphir-green.svg?logo=slack" />
</a>
<a href="https://gitpod.io/#https://github.com/finos/morphir-scala">
<img src="https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod" />
</a>
[](https://javadoc.io/doc/org.finos.morphir/morphir-runtime_3/latest/index.html) []("https://index.scala-lang.org/finos/morphir-scala") [](https://oss.sonatype.org/content/repositories/releases/org/finos/morphir/morphir_3/) [](https://oss.sonatype.org/content/repositories/snapshots/org/finos/morphir/morphir_3/)
Morphir is a library of tools that works to capture business logic as data.
For the first time, business logic can be shared, stored, translated and visualised, all with the reliability of standardisation ensured in the Morphir framework.
## morphir-scala
Provides Scala language bindings and JVM based tooling for Morphir.
## Desktop and web UI
The Morphir desktop and web UI now lives at [finos/morphir-ui](https://github.com/finos/morphir-ui).
`morphir-scala` continues as the Scala implementation and capability provider behind it — for
example the Markdown tooling (`morphir/langkit/markdown`) and the GitHub connector
(`morphir/connector/github`) — and as the shared `morphir-ui` library (`morphir/ui`) behind the
local web host started by `morphir server`.
## Installation
You can install the `morphir-cli` in the following ways:
**Using Coursier**
```
cs install --channel https://raw.githubusercontent.com/finos/morphir-scala/main/coursier-channel.json morphir-cli
```
Then run the CLI:
```
morphir-cli setup
```
We also offer an insiders channel that grants access to snapshot releases of the CLI.
```
cs install --channel https://raw.githubusercontent.com/finos/morphir-scala/main/coursier-channel.json morphir-insiders-cli
```
Then run the CLI:
```
morphir-cli setup
```
NOTE: The main channel above (non-insiders), also offers insiders builds under the name `morphir-insiders-cli`:
```
cs install --channel https://raw.githubusercontent.com/finos/morphir-scala/main/coursier-channel.json morphir-insiders-cli
```
Then run the CLI:
```
morphir-insiders-cli setup
```
---
## Development
### Gitpod
Click the button below to start a new development environment and start contributing right away:
[](https://gitpod.io/#https://github.com/finos/morphir-scala)
### How to build and test
Morphir-jvm use [mill](https://com-lihaoyi.github.io/mill) as its build tool.
#### IntelliJ Setup for Linux
If you are using IntelliJ IDEA to edit morphir-jvm's Scala code, you can create the
IntelliJ project files via:
````bash
./mill mill.idea.GenIdea/idea
````
#### BSP Setup
If you are using Visual Studio Code, IntelliJ, or any of the Editors which support BSP you can also generate BSP config files via:
```
./mill mill.bsp.BSP/install
```
You can also try the following to use the `mill-contrib-bloop` plugin to install and use the Bloop based BSP setup.
> NOTE: The recommended BSP based setup for mill is to run: `./mill mill.bsp.BSP/install` as mentioned above.
#### Run Tests
```bash
./mill __.test
```
or in watch mode:
```bash
./mill -w __.test
```
> NOTE: When running tests you will want to ensure you have generated the MorphirIR for elm sources if you are running tests for the runtime. A simple way to do this is to use the `build.sh` helper script an invoke the `elm-build` option. `./build.sh elm-build`
For your convience, you can run the morphir-runtime tests using the following command:
```bash
./build.sh test-runtime-jvm
```
#### Test Coverage
Before checking test coverage, ensure that all tests have been run using the following command:
```bash
./mill __.test
```
##### HTML Coverage Report
To generate a human-readable coverage report, run the following command:
```bash
./mill scoverage.htmlReportAll
```
To view the resulting coverage report, open `out/scoverage/htmlReportAll.dest/index.html`
##### XML Coverage Report
To generate an XML coverage report, run the following command:
```bash
./mill scoverage.xmlReportAll
```
The report will be generated at this location `out/scoverage/xmlReportAll.dest/scoverage.xml`
#### Formatting Scala Code
Code needs to be formatted according to `scalafmt` rules. Mill owns the entrypoint:
```bash
./mill format --kind scala
```
For a few known files (preferred during iteration):
```bash
./mill format --paths path/to/File.scala
```
or git-touched paths:
```bash
./mill format --changed
```
See [CONTRIBUTING.md — Formatting](./CONTRIBUTING.md#formatting) for the full command table (`--sources`, `--check`, etc.).
#### Formatting Elm Code
Elm sources under `examples/morphir-elm-projects` and `morphir-elm` are formatted with the repo-pinned elm-format binary via Mill (no global `npm install -g elm-format`):
```bash
./mill format --kind elm
```
or a single project / path:
```bash
./mill format --kind elm --paths examples/morphir-elm-projects/evaluator-tests/src
```
More detail for the evaluator-tests Elm tree:
[examples/morphir-elm-projects/evaluator-tests/ReadMe.md](./examples/morphir-elm-projects/evaluator-tests/ReadMe.md)
#### IntelliJ Setup for Windows
Windows on ARM64 needs a native build JVM for Scala.js linking. Mill's managed JDK may resolve to an x64 build and
run under emulation, which makes the Closure phase of `fullLinkJS` much slower. Select the native Microsoft OpenJDK
and add the ignored local Mill override:
```powershell
scoop install microsoft-lts-jdk # only when it is not already installed
scoop reset microsoft-lts-jdk
Set-Content .mill-jvm-version system
.\mill.bat --no-server --version
```
The last command must report `os.arch: aarch64`. See the
[Windows ARM64 contributor setup](./CONTRIBUTING.md#windows-arm64) for the explanation and server command.
If you are using IntelliJ IDEA to edit morphir-scala's Scala code, you can create the
IntelliJ project files via or use the **BSP Setup** option (BSP is the recommended approach):
```
.\mill -i mill.scalalib.GenIdea/idea
```
#### BSP Setup
If you are using Visual Studio Code, IntelliJ, or any of the Editors which support BSP you can also generate BSP config files via:
```
.\mill mill.bsp.BSP/install
```
You can also try the following to use the `mill-contrib-bloop` plugin to install and use the Bloop based BSP setup.
> NOTE: The recommended BSP based setup for mill is to run: `.\mill mill.bsp.BSP/install` as mentioned above.
```
.\mill -i --import ivy:com.lihaoyi::mill-contrib-bloop: mill.contrib.bloop.Bloop/install
```
#### Run Tests
```
.\mill -i __.test
```
or in watch mode:
```
.\mill -i -w __.test
```
#### Elm Tests
Documentation for the elm tests are located at [examples/morphir-elm-projects/evaluator-tests/ReadMe.md](https://github.com/finos/morphir-scala/blob/main/examples/morphir-elm-projects/evaluator-tests/ReadMe.md)
#### Formatting Code
Code needs to be formatted according to `scalafmt` / elm-format rules. Prefer the Mill entrypoint:
```
.\mill -i format
```
Narrow selection during iteration:
```
.\mill -i format --changed
.\mill -i format --paths path\to\File.scala
```
See [CONTRIBUTING.md — Formatting](./CONTRIBUTING.md#formatting).
### Roadmap
Watch for updates.
### Contributing
1. Fork it (<https://github.com/finos/morphir-scala/fork>)
2. Create your feature branch (`git checkout -b feature/fooBar`)
3. Read our [contribution guidelines](CONTRIBUTING.md) and [Community Code of Conduct](https://www.finos.org/code-of-conduct)
4. Commit your changes (`git commit -am 'Add some fooBar'`)
5. Push to the branch (`git push origin feature/fooBar`)
6. Create a new Pull Request
_NOTE:_ Commits and pull requests to FINOS repositories will only be accepted from those contributors with an active, executed Individual Contributor License Agreement (ICLA) with FINOS OR who are covered under an existing and active Corporate Contribution License Agreement (CCLA) executed with FINOS. Commits from individuals not covered under an ICLA or CCLA will be flagged and blocked by the FINOS Clabot tool (or [EasyCLA](https://github.com/finos/community/blob/master/governance/Software-Projects/EasyCLA.md)). Please note that some CCLAs require individuals/employees to be explicitly named on the CCLA.
*Need an ICLA? Unsure if you are covered under an existing CCLA? Email [help@finos.org](mailto:help@finos.org)*
### License
Copyright 2022 FINOS
Distributed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
SPDX-License-Identifier: [Apache-2.0](https://spdx.org/licenses/Apache-2.0)
[Link-Slack]: https://finos-lf.slack.com/messages/morphir/
[Link-SonatypeReleases]: https://oss.sonatype.org/content/repositories/releases/org/finos/morphir/morphir-runtime_3/ "Sonatype Releases"
[Link-SonatypeSnapshots]: https://oss.sonatype.org/content/repositories/snapshots/org/finos/morphir/morphir-runtime_3/ "Sonatype Snapshots"
[Badge-CI]: https://github.com/finos/morphir-scala/workflows/CI/badge.svg
[Badge-Slack]: https://img.shields.io/badge/slack-@finos/morphir-green.svg?logo=slack
[Badge-SonatypeReleases]: https://img.shields.io/nexus/r/https/oss.sonatype.org/org.finos.morphir/morphir-runtime_3.svg "Sonatype Releases"
[Badge-SonatypeSnapshots]: https://img.shields.io/nexus/s/https/oss.sonatype.org/org.finos.morphir/morphir-runtime_3.svg "Sonatype Snapshots"
[Badge-Stage]: https://cdn.jsdelivr.net/gh/finos/contrib-toolbox@master/images/badge-incubating.svg
[Badge-Stage-Page]: https://finosfoundation.atlassian.net/wiki/display/FINOS/Incubating