chakra-core/ChakraCore

Improve error messages

Open

#2,658 opened on Mar 9, 2017

View on GitHub
 (7 comments) (0 reactions) (0 assignees)JavaScript (9,000 stars) (1,374 forks)batch import
Dev ExperienceTaskhelp wanted

Description

In order to provide the best possible development experience, we should improve error messages to call out as much information as possible (which parameter, which field, actual/expected types, etc.) when something goes wrong.

Sub-issues:

Fixed

  • #424 (fixed)
  • #2901

Poor / difficult to understand messages

Nice-to-have improvements

  • Follow up issue #2411 and PR #2648 (improved by the PR but still needs more work)

Contributor guide

Tech stack
javascript
Domain
developer experience
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.
over 1 week
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.
needs investigation
Prerequisites
JavaScript knowledgeFamiliarity with ChakraCore codebase
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
10
Research direction
This meta issue tracks multiple sub issues for improving error messages. To contribute, first examine the listed sub issues such as #434 and #2872 for specific failing cases. Review existing PRs like #2648 to understand prior work. The codebase is in the chakra core/ChakraCore repository, with error handling likely in the runtime or parser directories.