kowainik / kowainik/stan

Implement check for the compile-time and runtime GHC version

Open
#381 4 comments 3 reactions 0 assignees View on GitHub
enhancement ghc
Dominant language
Haskell
Stars
597
Forks
53
PR merge metrics
No merged PRs in 30d

Description

Currently Stan panics when GHC versions are different. But it's possible to implement a check with a good error message. This check wouldn't be needed if the following GHC feature was implemented:

* https://gitlab.haskell.org/ghc/ghc/-/issues/18329

However, it doesn't look like it will be implemented soon, so providing a better UX is worth spending time on 🙂

For the implementation, we should use `ghc-check` by @pepeiborra. The package already does an excellent job on covering all tricky cases, and it's used in `ghcide`.

* http://hackage.haskell.org/package/ghc-check

Contributor guide

Open the contributing guide

Research direction

Start by reading the ghc-check package documentation and its use in ghcide, then inspect Stan's handling of GHC versions. Implement a check for differences between compile-time and runtime GHC versions and verify that Stan reports a useful error instead of panicking.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
devtools
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.