[Feature Request]: `WriteLinesToFile` should support specifying a UTF8 encoding that doesn't write a BOM · dotnet/msbuild#10521

(12 评论) (0 反应) (0 负责人)C# (5,062 star) (1,364 fork)batch import

Feature RequestPriority:3help wantedtriaged

描述

Summary

WriteLinesToFile accepts an Encoding metadata that is a name that's passed to System.Text.Encoding.GetEncoding. There is no BCL name for UTF-8 with no BOM, so users cannot easily request files be written in this encoding.

Background and Motivation

BOMs are not generally considered good things to require these days, and many systems (especially those that interact with Linux hosts/tools) have moved away from them because said tools don't handle BOMs well.

We should at least have a supported and documented way to skip BOM emission.

Proposed Feature

We should support a string like UTF8-no-bom or similar for the Encoding metadata of the WriteLinesToFile Task so that users have an accepted way to write without BOMs. And/or the runtime should provide a named lookup that does the same.

Alternative Designs

No response

贡献者指南

技术栈: csharp
领域: build systemtooling
议题类型: feature
难度: 3
预计时间: 1-3 hours
活动状态: active
清晰度: clear
前置要求: C# programmingMSBuild tasksUTF 8 encoding
新手友好度: 65
研究方向: Implementing this feature requires modifying the WriteLinesToFile task in the MSBuild source code (e.g., src/Tasks/WriteLinesToFile.cs). The encoding metadata is passed to System.Text.Encoding.GetEncoding. To support UTF 8 without BOM, one must intercept the new encoding name (e.g., 'UTF8 no bom') and create an Encoding instance with BOM disabled. Consult the existing task code and possibly the .NET runtime's Encoding.UTF8 without preamble. Ensure to add documentation and tests.