Cryptic error messages on invalid shard.yml format about shards HOT 10 CLOSED

It should be

name: amethyst
version: 0.1.7

dependencies:
  mime:
    github: spalger/crystal-mime
    branch: master

We still need to better validate the format.

from shards.

Yes, but reporting correct error messages is hard. Here we'd have "config for github dependency must be a hash", which is better than "cast to X error" but still kinda weird.

Unless we can have the code that failed parsing and pointing arrows, like crystal compiler errors? Maybe the experimental yaml_mapping could help with that?

from shards.

Maybe we can track the rough section and provide generic error messages? Like

Invalid shard.yml: Invalid dependencies. Specifying dependencies should look like this:

dependencies:
  example:
    github: crystal-lang/example-shard
    version: 0.1.0

from shards.

👍 very good idea.

from shards.

Another idea is to use a pull parser, so you can access the line and column. I think the yaml format of shards is pretty simple and it could be done. With this, we can show errors like in the compiler. It shouldn't be that hard to do. If you want I can give it a try.

from shards.

Thanks @jhass

I also agree on more meaningful error message.

from shards.

Meanwhile does every shard.yml have to have name and description in it?

Doing this also fails

dependencies:
  mime:
    github: spalger/crystal-mime
    branch: master

from shards.

I think name and version is the minimum

from shards.

Yes, both name and version are required. Everything else is optional.

from shards.

Closing since 658da8a now displays nicer parse errors.

from shards.