Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up readme #673

Merged
merged 2 commits into from
Aug 22, 2024
Merged

Clean up readme #673

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0cab2d4
Clean up readme to reference handling elm tests as well as an alterna…
alexsieland Aug 22, 2024
113b6f6
move
alexsieland Aug 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ For your convience, you can run the morphir-runtime tests using the following co
```


#### Formatting Code
#### Formatting Scala Code

Code needs to be formatted according to `scalafmt` rules. To run `scalafmt` on all the source code using:

Expand All @@ -148,6 +148,22 @@ or in watch mode to reformat changed files:
./mill -w mill.scalalib.scalafmt.ScalafmtModule/reformatAll __.sources
```

#### Formatting Elm Code

The evaluator tests utilize elm code. To reformat the elm code for those tests:

```bash
elm-format --elm-version=0.19 examples/morphir-elm-projects/evaluator-tests/src/Morphir/Examples/App/*.elm
```

If you don't have elm-format installed, you can either install it through npm or a different package manager like brew:

```bash
npm install -g elm-format
```

Alternatively, this can be done directly via `npm run format`, which is documented [here](https://github.com/finos/morphir-scala/blob/main/examples/morphir-elm-projects/evaluator-tests/ReadMe.md)

#### IntelliJ Setup for Windows

If you are using IntelliJ IDEA to edit morphir-scala's Scala code, you can create the
Expand Down Expand Up @@ -185,6 +201,10 @@ 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` rules. To run `scalafmt` on all the source code using:
Expand Down