microsoft/Terminal

We should expose the actual line from the settings that caused a warning

Open

#11,288 opened on Sep 20, 2021

View on GitHub
 (0 comments) (0 reactions) (0 assignees)C++ (3,212 forks)batch import
Area-SettingsHelp WantedIssue-TaskProduct-Terminal

Repository metrics

Stars
 (35,764 stars)
PR merge metrics
 (Avg merge 27d 19h) (24 merged PRs in 30d)

Description

From #11225 originally.

It would be helpful if the error message showed either the actions or the keybindings causing the error. Otherwise the user has to guess.

We do this already for some types of serialization error, but not all. Maybe we could expose the action name? Or the line that the action is on, to at least point them in the right direction.

Contributor guide

Research direction
Investigate the settings serialization code to identify where warnings are generated and modify the error messages to include the corresponding line number from the settings file.
Tech stack
cpp
Domain
backend
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
C++Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65