Skip to content

Commit

Permalink
Clean up readme (#673)
Browse files Browse the repository at this point in the history
* Clean up readme to reference handling elm tests as well as an alternative way to run elm-format from the project root directory

* move
  • Loading branch information
alexsieland authored Aug 22, 2024
1 parent e569718 commit 14896e2
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion README.md
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

0 comments on commit 14896e2

Please sign in to comment.