如何让JetBrains Rider与Visual Studio用户共享自定义词典？

问题背景 #

团队同时使用Visual Studio和Rider，希望共享自定义词典以保持一致的拼写检查体验，但两者的词典管理机制存在差异：

• Visual Studio可通过.editorconfig配置指定自定义词典，示例配置如下：

spelling_error_severity = warning
spelling_exclusion_path = .\custom-dictionary.DIC
spelling_checkable_types = strings,identifiers,comments

• Rider支持两种词典存储方式，但存在局限：
  • solution-shared层的XML词典文件无法被Visual Studio识别（VS仅支持单词列表文件）
  • 单词列表文件属于用户级设置，需每位Rider用户手动通过File/Settings/Editor/Spelling添加，无法自动共享

我们需要实现要么让Rider识别.editorconfig配置，要么将Rider配置纳入版本控制系统（VCS）实现默认同步。

可行解决方案 #

1. 利用Rider对.editorconfig的原生支持（推荐） #

从Rider 2022.2版本开始，官方已经支持读取.editorconfig中的拼写相关配置，包括spelling_exclusion_path指定的词典文件。操作步骤：

• 在解决方案根目录维护好包含拼写配置的.editorconfig文件，确保spelling_exclusion_path指向共享的.DIC单词列表文件
• 将.editorconfig和custom-dictionary.DIC一同提交到VCS
• 要求团队所有Rider用户升级至2022.2或更高版本，打开解决方案后会自动加载配置，无需手动操作

2. 通过Rider解决方案共享配置同步词典（兼容旧版本） #

如果团队存在使用Rider旧版本的成员，可通过以下步骤将词典配置纳入解决方案级共享：

1. 将custom-dictionary.DIC放在解决方案根目录并提交到VCS
2. 任意一位Rider用户手动添加该词典到拼写设置中
3. 找到该用户的Rider拼写配置文件spelling.xml，路径通常为：%APPDATA%\JetBrains\<Rider版本>\settings\spelling.xml（Windows）或~/.config/JetBrains/<Rider版本>/settings/spelling.xml（Linux/macOS）
4. 将spelling.xml复制到解决方案的.idea/settingsSync目录（若无则创建），并重命名为spelling.solutionShared.xml
5. 修改文件中的词典路径为相对路径，例如$PROJECT_DIR$/custom-dictionary.DIC，避免绝对路径导致的适配问题
6. 将.idea/settingsSync/spelling.solutionShared.xml提交到VCS，其他用户打开解决方案时会自动加载该共享配置

3. 脚本自动配置词典（兜底方案） #

若上述方案均无法落地，可通过脚本统一配置Rider的词典路径：

• 确保custom-dictionary.DIC已提交到VCS
• 编写PowerShell/Shell脚本，自动修改Rider用户配置目录下的spelling.xml，添加共享词典的相对路径
• 将脚本放在解决方案根目录，要求用户首次打开解决方案时运行一次，后续无需重复操作

内容的提问来源于stack exchange，提问作者Steve Dunn