elm

elm copied to clipboard

Intended effect in the output of elm-test:

 > Tests
 > Squeaky Clean
-> 5
+> Task 5
 > Omit digits
 
     "1My2Finder3"
     ╷
     │ Expect.equal
     ╵
     "MyFinder"

Beware: if this is merged the test runner might need some adjustment as well.

I used to ignore the digits with unclear origin; the aim of this change is to make their meaning very clear.

Contributor to previous confusion: e.g. squeaky-clean has several tests named "Omit digits", in elm-test's output only distinguished by section number.

[no important files changed]

This PR touches files which potentially affect the outcome of the tests of an exercise. This will cause all students' solutions to affected exercises to be re-tested.

If this PR does not affect the result of the test (or, for example, adds an edge case that is not worth rerunning all tests for), please add the following to the merge-commit message which will stops student's tests from re-running. Please copy-paste to avoid typos.

[no important files changed]

For more information, refer to the documentation. If you are unsure whether to add the message or not, please ping @exercism/maintainers-admin in a comment. Thank you!

If going in this direction, some changes would need to happen in the test runner of elm-test-rs indeed. For information, the parsing of the description hierarchy and encoding of exercism-specific format happens in this module https://github.com/mpizenberg/elm-test-runner/blob/19ca6e228828e15714f8a307fae87714a4bfe6c3/src/ElmTestRunner/Reporter/Exercism.elm#L152

A new version of mpizenberg/elm-test-runner package needs publication and a new version of elm-test-rs, since the two go hand in hand (one version of elm-test-rs uses exactly one version of mpizenberg/elm-test-runner).

Maybe there is a way to just add "Task " in front of the task id in the test runner?

That wouldn't help those who run the tests locally.

The website interface is plenty clear already: Squeaky Clean editor.

I'm going to close this PR since we determined that it requires change in other repositories, and it's not clear that it is going to happen. We can open it again if it does happen.

My personal opinion is that the benefits ("Task 5" instead of "5" for local users) are not really worth the effort since concept exercises are really made to be used in the web editor (putting concept explanations right there in the UI, running the analyzer...).