cryspen/hax

When hax-engine's fails to parse stdin, make nicer error message

Open

#218 opened on Aug 18, 2023

View on GitHubContributor guide
 (7 comments) (0 reactions) (0 assignees)OCaml (61 forks)auto 404
clienginegood first issue

Repository metrics

Stars
 (456 stars)
PR merge metrics
 (PR metrics pending)

Description

Such an error means either:

  • the generated parser is broken (this almost never happens);
  • the generated parser is outdated (dune is supposed to regenerate it, but sometimes it doesn't).

The gory details about why the parser failed should be less visible, and we should print a message for the user telling him to reinstall properly things, maybe even to clean the engine folder with dune clean.

Note I tried to do something about that in PR #261, but that was not fully satisfactory.

Contributor guide

Research direction
Locate the code that handles parser failure from stdin, and modify the error message to suggest 'dune clean' or reinstalling.
Tech stack
None
Domain
developer experiencecli
Issue type
Feature
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.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitOCamldune
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65