tshm/elm-doctest

doctest runner against Elm-lang source files

elm-doctest's Issues

Running on all file saves

It'd be great if elm-doctest was run on all file saves, and that a user got feedback just like a regular elm compiler error. Don't know if it'd be better to tie in with elm-reactor or latch onto/plug into elm, but I think getting errors inline in one's editor would be the slickest.

Unexpected token > in JSON at position 0

Hi 👋

First of all, thanks for this tool, good stuff!
Secondly, I wanted to ask you about this intermittent error that I'm having.
I can't seem to figure out where it is coming from.

Here's what I'm doing:

⚡ make test
> Run tests
Starting elm-doctest ...

 processing: src/App/Sources/Crypto/Hex.elm
Examples: 14  Failures: 0

 processing: src/App/Sources/Crypto/Hmac.elm
evaluation failed: Unexpected token > in JSON at position 0
Unexpected token > in JSON at position 0
make: *** [test] Error 1

~/Projects/ongaku-ryoho 12.67s master            
⚡ make test
> Run tests
Starting elm-doctest ...

 processing: src/App/Sources/Crypto/Hex.elm
Examples: 14  Failures: 0

 processing: src/App/Sources/Crypto/Hmac.elm
Examples: 2  Failures: 0

~/Projects/ongaku-ryoho 13.47s master  

So yeah, sometimes it fails and sometimes it doesn't.
Any ideas?

Thanks!

PS. You can find the source code here. I'm calling elm-doctest in the Makefile.

does not work on elm source with view (eg. with import "html")

seems that elm-repl does not like it.

does not work on Elm1.7.0 projects

running test fails for Elm1.7.0 projects.

• syntax changes (eg. port module...)
• changes on port handling.

alternative implementation

You might be interested in https://github.com/stoeffel/elm-doc-test.
I used a different approach than you. It creates elm-tests from your doc-tests and you can run them using node-test-runner. It supports {-, multiline tests, you get nice compiler messages and because of it's dependency to elm-test you get nice assertion messages.

Please close this issue when you see it, it's not an bug. I just didn't know how to contact you differently. We might profit from each others work. Would be awesome to hear what you think of my approach. Hope it's okay that I opened this issue. Thanks for the inspiration.

Screenshots

passing doc-test

failing doc-test

broken doc-test (doesn't compile)

v0.1.7 requires virtual-dom package explicitly.

It won't run with out explicit dependency included in
elm-package.json.

Valid file with no tests raises a SyntaxError exception immediately after "Starting elm-doctest ..."

Using:

http://elm-lang.org/examples/random

$ elm-doctest Random.elm
Starting elm-doctest ...

processing: /tmp/Random.elm
undefined:1
> > > > | | > 
^

SyntaxError: Unexpected token > in JSON at position 0
    at Object.parse (native)
    at Array.app.ports.evaluate.subscribe.resource (/home/user/projects/trustedexpert/projects/brokedown-web/node_modules/elm-doctest/src/bridge.js:103:40)
    at Function.onEffects [as func] (/home/user/projects/trustedexpert/projects/brokedown-web/node_modules/elm-doctest/distribution/index.js:3456:12)
    at A3 (/home/user/projects/trustedexpert/projects/brokedown-web/node_modules/elm-doctest/distribution/index.js:98:11)
    at onMessage (/home/user/projects/trustedexpert/projects/brokedown-web/node_modules/elm-doctest/distribution/index.js:3241:12)
    at Object.callback (/home/user/projects/trustedexpert/projects/brokedown-web/node_modules/elm-doctest/distribution/index.js:3283:11)
    at step (/home/user/projects/trustedexpert/projects/brokedown-web/node_modules/elm-doctest/distribution/index.js:2921:32)
    at Timeout.work [as _onTimeout] (/home/user/projects/trustedexpert/projects/brokedown-web/node_modules/elm-doctest/distribution/index.js:2963:15)
    at tryOnTimeout (timers.js:232:11)
    at Timer.listOnTimeout (timers.js:202:5)

Looks like its having an issue parsing the JSON at bridge.js line 103.

it should support standard documentation format for elm

Elm requires to put documentation between {-| and -}.
Currently elm-doctest can not support it.

misses runtime dependency

It should depends on minimist / chokidar in runtime dependencies.