Hacktoberfest 2026：维护者为十月标记出来的 issue，仍然开放、适合新手。 浏览 Hacktoberfest issue

Name validation is stricter than VS and MSBuild

未关闭
  • 哪里不对？
#151 0 条评论 0 个 reaction 已指派 1 人 在 GitHub 查看

@richardstanton 已经在做这个了。

开始于 2026年6月4日。

评估

这个 Issue 还没有评估数据。

描述

Parsing a valid .sln file with a solution folder named CI/CD throws SolutionException because ValidateName rejects the / character. More broadly, the library rejects / ? : * " < > | and DOS reserved names (CON, AUX, LPT4, etc.) in folder names, project names, and configuration names — even though these are filesystem concerns that don't apply to display names stored in .sln files.

How other parsers handle this

We surveyed two other .sln parsers to understand established behavior:

VS's original parser (src/env/vscore/package/Solutions/SolutionPersistence.cs):

  • Display names: no character validation at all during read. On write, project names are truncated at the first \r, \n, or \t — that's the only sanitization.
  • No reserved name checks (CON, AUX, etc.).
  • Solution folder names are treated as plain display strings with no special validation.

MSBuild's parser (src/Build/Construction/Solution/SolutionFile.cs):

  • Display names: zero character validation. ParseFirstProjectLine regex-extracts the name and assigns it directly. Empty names get a synthesized placeholder; that's the only special handling.
  • Project relative paths: validated against Path.GetInvalidPathChars() (control characters only), not GetInvalidFileNameChars().
  • Configuration names: only structural validation — BuildType|Platform must split into exactly two parts on |. No character validation on the individual parts.
  • When names need to become MSBuild XML identifiers, MakeIntoSafeItemName and CleanseProjectName transform invalid characters to _ rather than rejecting them.
  • No reserved name checks.

This library (Microsoft.VisualStudio.SolutionPersistence):

  • ValidateName (used for solution folder names only — via CreateFolder, AddFolder, and the Name setter) rejects / ? : \ * " < > |, control characters, DOS reserved names, ., .., and names over 260 characters.
  • The same validation is shared for configuration names (AddBuildType, AddPlatform).
  • Project display names are not validated by ValidateName — they only get duplicate-name checking.
Summary
Concern VS original MSBuild This library
/ ? : * " < > | in display names Allowed Allowed Rejected
\ (backslash) in display names Allowed Allowed Rejected
DOS reserved names (CON, AUX, etc.) Allowed Allowed Rejected
. and .. as names Allowed Allowed Rejected
Control characters Stripped on write Rejected in paths only Rejected
Configuration name characters No validation Only | split must yield 2 parts Rejected: / ? : \ * " < > |

The key principle in both VS and MSBuild is that display names are arbitrary strings, not filesystem paths. Filesystem-invalid characters and reserved names are only relevant when a name maps to something on disk (like a project's relative path), not for logical names like solution folders or build configurations.

Considerations

ValidateName is only called for solution folder names — the one type of name that is purely virtual and never touches the filesystem. Ironically, project display names (which do derive from filesystem paths) skip this validation entirely.

The \ restriction is the one character that has a structural justification in this library's model, since the folder path format (/Folder/Subfolder/) normalizes backslashes. The / restriction is also structurally motivated for configuration names, since it's the folder-path segment delimiter, and | is the BuildType|Platform separator.

The remaining restrictions (? : * " < >, DOS reserved names, ./..) have no structural justification in the model — they are carried over from filesystem naming rules that don't apply to display names.

主要语言
C#
星标
213
派生
14
30 天内没有已合并 PR

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

microsoft/vs-solutionpersistence 的其他 Issue

查看 microsoft/vs-solutionpersistence 的全部 Issue

相似的 Issue

更多 C# Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。