dotnet/msbuild

WriteLinesToFile Does Not Support BOM Customization

Open

#6 168 ouverte le 17 févr. 2021

Voir sur GitHub
 (0 commentaires) (4 réactions) (0 assignés)C# (1 364 forks)batch import
help wantedneeds-designtriaged

Métriques du dépôt

Stars
 (5 062 stars)
Métriques de merge PR
 (Merge moyen 11j 7h) (125 PRs mergées en 30 j)

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.

Guide contributeur

Direction de recherche
Explorez les approches pour personnaliser le BOM dans la tâche WriteLinesToFile, comme l'ajout d'un paramètre facultatif ou la sélection d'encodages courants. Discutez des compromis et des stratégies de mise en œuvre.
Stack technique
csharp
Domaine
backendbuild systemdeveloper experience
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
MSBuildencoding
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
50