microsoft/Terminal

Warn if settings.json is not UTF-8 (at least in key binding)

Open

#10,330 创建于 2021年6月4日

在 GitHub 查看
 (2 评论) (0 反应) (0 负责人)C++ (3,212 fork)batch import
Area-SettingsHelp WantedIssue-FeatureProduct-Terminal

仓库指标

Star
 (35,764 star)
PR 合并指标
 (平均合并 27天 19小时) (30 天内合并 24 个 PR)

描述

Description of the new feature/enhancement

If settings.json is encoded in e.g. Windows-1252 rather than UTF-8, then Terminal should warn about that, rather than silently substitute U+FFFD replacement characters in strings. This would help users who edit settings.json with Visual Studio, which saves in the ANSI code page by default if the file does not appear to be UTF-8 already. The silent substitution is especially hard to diagnose if the only non-ASCII character is in a key binding that then just does not work.

Proposed technical implementation details (optional)

Apply settings.json as much as possible, but then pop up a message saying that the encoding is wrong.

AFAICT, jsoncpp gives the raw bytes of JSON string values to Terminal if there is are no backslash escapes. These bytes are UTF-8 if the file was correctly encoded. In Terminal, ConversionTrait<KeyChord>::FromJson calls til::u8u16, which calls MultiByteToWideChar without the MB_ERR_INVALID_CHARS flag. There are more til::u8u16 calls in other ConversionTrait specializations.

https://github.com/microsoft/terminal/blob/2531454bcd46eadc14273ca85acc76231b8810cb/src/cascadia/TerminalSettingsModel/KeyChordSerialization.cpp#L332 https://github.com/microsoft/terminal/blob/2531454bcd46eadc14273ca85acc76231b8810cb/src/cascadia/TerminalSettingsModel/JsonUtils.h#L161 https://github.com/microsoft/terminal/blob/2531454bcd46eadc14273ca85acc76231b8810cb/src/inc/til/u8u16convert.h#L282

贡献者指南