orbit-lang/Bootstrap

Infrastructure - Extract & Review Error Messages & Warnings

Open

#3 opened on May 16, 2021

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Kotlin (0 forks)auto 404
Infrastructuregood first issue

Repository metrics

Stars
 (0 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

The compiler currently propagates nice error messages & warnings via the Invocation class. However, these errors are hardcoded strings inside the various phases & components that make up the compiler. It would be very nice if:

  • Error strings were extracted and moved to a separate (preferrably localised) package or similar; AND
  • There was a simpler, unified api for raising compiler errors & warnings

I would like to be able to do something like:

private val errorUtil: ErrorUtil by inject()
...
throw errorUtil.error<Lexer>(Errors.Lexer.NoMoreTokens, context, ...any other parameters needed for this specific error)
...

Contributor guide

Research direction
Locate the existing hardcoded error strings in compiler phases (e.g., Lexer, Parser), understand the Invocation class propagation mechanism, then design a localized error resource package and a unified API like ErrorUtil. Study examples from other compilers for inspiration.
Tech stack
kotlin
Domain
backendinfrastructure
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
KotlinCompiler concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35