search

fsprojects / FSharp.Data.GraphQL

FSharp implementation of Facebook GraphQL query language.
http://fsprojects.github.io/FSharp.Data.GraphQL/
MIT License
395 stars 72 forks source link

Readme and docs should clearly state no support for Fable #291

Open MargaretKrutikova opened 4 years ago

MargaretKrutikova commented 4 years ago

Description

FSharp.Data.GraphQL doesn't work for Fable. There is nothing about it mentioned in the readme and the docs say the opposite, that it is supported.

After sitting with it for a couple of hours to at least make it compile I tried to run it and got a lot of exceptions. Searching through the issues I discovered that there is no support for Fable in the latest version, the issue is 2 years old.

Repro steps

Steps to reproduce the problem

  1. Create a Fable project
  2. Add FSharp.Data.GraphQL, configure schema, create provider, make your queries etc
  3. Run the project.

Expected behaviour

Either the library works for Fable, or it clearly states that it doesn't.

Actual behavior

Fails runtime with various different exceptions. The docs says Fable is supported, the readme is silent about it.

Please, clearly indicate in the readme, and especially in the official docs that it doesn't work for Fable. It can save people a lot of time, especially those who are new (like me) to Fable. Also, please, point to the great and only solution for working with graphql and Fable right now - Snowflaqe.

Thank you!

jberzy commented 4 years ago

Hi @MargaretKrutikova,

Yes, the documentation is out of date and we should address that so people are not confused. At one point the TypeProvider did actually work with Fable, but that was long ago.

Thanks for bringing it to our attention. John

tylerhartwig commented 4 years ago

Please update this, spent a lot of time on this tonight! Thanks

xperiandri commented 9 months ago

Feel free to submit a PR