dotnet/msbuild

Warn about WriteLinesToFile default behavior which is Append

Open

#11 927 ouverte le 29 mai 2025

Voir sur GitHub
 (6 commentaires) (0 réactions) (0 assignés)C# (1 364 forks)batch import
help wantedtriaged

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

WriteLinesToFile appends by default unless you specify Overwrite. This is highly non-intuitive and probably almost never what the user intends.

Since we can't change the behavior, I propose to introduce a new optional parameter Append, that defaults to false, and if it's not specified and Overwrite is not specified, warn about it (that you should specify one or the other).

Not sure if a warning or a message, perhaps build check?

Guide contributeur

Direction de recherche
Examinez l'implémentation existante de la tâche WriteLinesToFile dans le code source de MSBuild (probablement dans le répertoire 'src/Tasks'). Comprenez comment les paramètres de tâche sont définis et comment les avertissements sont émis. Proposez d'ajouter un paramètre 'Append' et implémentez un avertissement lorsque ni 'Append' ni 'Overwrite' ne sont définis. Envisagez d'utiliser l'infrastructure d'avertissement existante, telle que WarningTask ou TaskLoggingHelper.
Stack technique
csharp
Domaine
build system
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.
1-2 jours
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
C#MSBuild conceptsXML
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
35