search

tweag / sparkle

Haskell on Apache Spark.
BSD 3-Clause "New" or "Revised" License
447 stars 30 forks source link

Improve overall dev experience and make it easier to use #170

Open mputz86 opened 1 year ago

mputz86 commented 1 year ago

Is your feature request related to a problem? Please describe. Currently I am trying to evaluate if sparkle is a valid approach for some data science stuff. I have a hard time to get a dev-env set-up which helps to develop an app.

Describe the solution you'd like There could be a multiple step approach: 1) Just descripe (in detail) how you develop apps: Which tools, how to find doc (a maintainer probably does not need it :)) 2) Add haddocks generation to be able to browser the API easily 3) Add haskell-language-server support (or just ghcid?) to be able to have short dev-cycles (maybe I just did it wrong)

Describe alternatives you've considered Not using sparkle :).

Additional context I tried some things, but all broke; surely due to inexperience with bazel. Close this issue, if there is no interest in others joining and this is a too disturbing issue for you :), no harm done, just testing what's the state of this project is (next issue would be about upgrading all dependencies :)).

facundominguez commented 1 year ago

Hello @mputz86!

  1. Just descripe (in detail) how you develop apps: Which tools, how to find doc

I think you will need to be familiar at least with the following two:

rules_haskell: https://haskell.build/ bazel: https://bazel.build/

We could add these to the readme if they are what you are after.

  1. Add haddocks generation to be able to browser the API easily

Probably documenting a target to generate haddock would be helpful here. I haven't tried generating the haddock documentation ever.

  1. Add haskell-language-server support (or just ghcid?) to be able to have short dev-cycles (maybe I just did it wrong)

I don't use HLS or ghcid myself, but if you want to contribute documentation for it we could consider including it or linking it.