effekt-lang / effekt-lang/effekt

Custom compiler crash/panic handler

Open
#576 2 comments 1 reaction 0 assignees View on GitHub
good first issue quality-of-life
Dominant language
Scala
Stars
469
Forks
41
Avg merge
1d 16h
Merged PRs (30d)
23

Description

## Motivation

Since we're planning on having a few more users soon, it would be nice to print more information when crashing so that the crash is easier to reproduce.

## Description

When the compiler crashes/panics, produce a slightly larger report with the necessary information one needs to report the crash, such as:
- where to report the crash
- Effekt compiler version
- Effekt config (esp. things like which backend was used)
- JVM info
- backend info (paths, versions of installed/used backends?)
- OS info
- the full stack trace

This could also be serialised into some file in `./out/` instead of / in addition to printing it.

### Context

The relevant code for handling a crash right now is here:
https://github.com/effekt-lang/effekt/blob/458fc9cb0cfbeed87fd98273cc5e23414ad5f0c7/effekt/jvm/src/main/scala/effekt/Driver.scala#L89-L102

Most of the info mentioned above is accessible via `System.getProperty` (or via `System.getenv`) or through the `EffektConfig`. :)

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.