dotnet/msbuild

WriteLinesToFile Does Not Support BOM Customization

Open

#6.168 aberto em 17 de fev. de 2021

Ver no GitHub
 (0 comments) (4 reactions) (0 assignees)C# (1.364 forks)batch import
help wantedneeds-designtriaged

Métricas do repositório

Stars
 (5.062 stars)
Métricas de merge de PR
 (Mesclagem média 11d 7h) (125 fundiu PRs em 30d)

Description

Context

The WriteLinesToFile task uses UTF-8 encoding without BOM (byte order mark) by default. This is not specified in the documentation and could be useful to have control over.

The difficulty is allowing control over the optional Encoding parameter and control over the BOM without adding a special case for every single encoding.

Some options I sent in the internal thread that started this issue:

  1. We pick a few encodings that are most common/popular/etc. and special case those and no others.
  2. We can pass an optional parameter to override whether s_defaultEncoding applies a BOM.

Let's discuss what potential solutions there are before implementing an improvement.

Guia do colaborador

Direção de pesquisa
Explore abordagens para personalizar o BOM na tarefa WriteLinesToFile, como adicionar um parâmetro opcional ou selecionar codificações comuns. Discuta compensações e estratégias de implementação.
Pilha de tecnologia
csharp
Domain
backendbuild systemdeveloper experience
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
MSBuildencoding
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
50