microsoft/Terminal

JSON fails to parse with a trailing comment at the end of an array

Open

#11,545 opened on Oct 20, 2021

View on GitHub
 (7 comments) (0 reactions) (0 assignees)C++ (3,212 forks)batch import
Area-SettingsHelp WantedIssue-BugProduct-TerminalResolution-External

Repository metrics

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

Description

Windows Terminal version (or Windows build number)

1.10.2714.0

Other Software

No response

Steps to reproduce

In the settings file, put a comment at the end of an object with a comma after it.

This fails:

"actions": [
  {},
  // ...
],

Dropping either the , or the comment makes it work.

Expected Behavior

Should be parsed as usual since both terminating commas and comments are allowed, or forbid trailing commas (assuming that comments are a desired feature).

Actual Behavior

Settings could not be loaded from file. Check for syntax errors, including trailing commas.

Contributor guide

Research direction
Investigate the settings file parser, specifically how it handles comments and trailing commas. Check for syntax error detection logic that might incorrectly flag valid cases.
Tech stack
cpp
Domain
desktop
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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
C++Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75