github/DotNetSolutionTools
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add TreatWarningsAsErrors to README for CLI

Browse Source
This commit is contained in:
Matthew Parker [SSW]
2024-01-21 14:39:54 +10:00
parent 933d11142e
commit a9f9aa1834
3 changed files with 25 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
DotNetSolutionTools.CLI/Commands/TreatWarningsAsErrorsCommand.cs
View File

@@ -24,37 +24,29 @@ public class TreatWarningsAsErrorsCommand : Command<TreatWarningsAsErrorsCommand
var solutionFile = SolutionProjectParity.ParseSolutionFileFromPath(pathToSolutionFile); var solutionFile = SolutionProjectParity.ParseSolutionFileFromPath(pathToSolutionFile);
if (solutionFile == null) if (solutionFile == null)
{ {
Console.WriteLine( Console.WriteLine("Failed to parse solution file. The file was either not found or malformed.");
"Failed to parse solution file. The file was either not found or malformed."
);
return 1; return 1;
} }
var cSharpProjects = SolutionProjectParity.GetCSharpProjectObjectsFromSolutionFile( var cSharpProjects = SolutionProjectParity.GetCSharpProjectObjectsFromSolutionFile(solutionFile);
solutionFile
);
Console.WriteLine($"Found {cSharpProjects.Count} C# Projects"); Console.WriteLine($"Found {cSharpProjects.Count} C# Projects");
Console.WriteLine("=================================================="); Console.WriteLine("==================================================");
// Get the list of projects // Get the list of projects
var projectsMissingImplicitUsings = WarningsAsErrors.FindCSharpProjectsMissingTreatWarningsAsErrors( var projectsMissingTreatWarningsAsErrors = WarningsAsErrors.FindCSharpProjectsMissingTreatWarningsAsErrors(
cSharpProjects cSharpProjects
); );
Console.WriteLine( Console.WriteLine(
$"{projectsMissingImplicitUsings.Count} C# Projects have missing Treat Warnings As Errors" $"{projectsMissingTreatWarningsAsErrors.Count} C# Projects have missing Treat Warnings As Errors"
); );
if (settings.AddMissing) if (settings.AddMissing)
{ {
Console.WriteLine("=================================================="); Console.WriteLine("==================================================");
Console.WriteLine("Adding missing Warnings As Errors"); Console.WriteLine("Adding missing Warnings As Errors");
WarningsAsErrors.AddMissingTreatWarningsAsErrors(projectsMissingImplicitUsings); WarningsAsErrors.AddMissingTreatWarningsAsErrors(projectsMissingTreatWarningsAsErrors);
var updatedProjects = SolutionProjectParity.GetCSharpProjectObjectsFromSolutionFile( var updatedProjects = SolutionProjectParity.GetCSharpProjectObjectsFromSolutionFile(solutionFile);
solutionFile var projectsWithMissing = WarningsAsErrors.FindCSharpProjectsMissingTreatWarningsAsErrors(updatedProjects);
);
var projectsWithMissing = WarningsAsErrors.FindCSharpProjectsMissingTreatWarningsAsErrors(
updatedProjects
);
Console.WriteLine( Console.WriteLine(
$"There are now {projectsWithMissing.Count} C# Projects missing Treat Warnings As Errors" $"There are now {projectsWithMissing.Count} C# Projects missing Treat Warnings As Errors"
); );

45
DotNetSolutionTools.Core/WarningsAsErrors.cs
View File

@@ -7,13 +7,9 @@ public static class WarningsAsErrors
public static List<string> FindCSharpProjectsMissingTreatWarningsAsErrors(string solutionFilePath) public static List<string> FindCSharpProjectsMissingTreatWarningsAsErrors(string solutionFilePath)
{ {
var solutionFile = SolutionFile.Parse(solutionFilePath); var solutionFile = SolutionFile.Parse(solutionFilePath);
var csprojList = SolutionProjectParity.GetCSharpProjectObjectsFromSolutionFile( var csprojList = SolutionProjectParity.GetCSharpProjectObjectsFromSolutionFile(solutionFile);
solutionFile
);
var projectsMissingImplicitUsings = FindCSharpProjectsMissingTreatWarningsAsErrors(csprojList); var projectsMissingImplicitUsings = FindCSharpProjectsMissingTreatWarningsAsErrors(csprojList);
var projectsMissingImplicitUsingsStringList = projectsMissingImplicitUsings var projectsMissingImplicitUsingsStringList = projectsMissingImplicitUsings.Select(x => x.FullPath).ToList();
.Select(x => x.FullPath)
.ToList();
return projectsMissingImplicitUsingsStringList; return projectsMissingImplicitUsingsStringList;
} }
@@ -26,8 +22,8 @@ public static class WarningsAsErrors
foreach (var project in projectList) foreach (var project in projectList)
{ {
var treatWarningsAsErrors = project.PropertyGroups var treatWarningsAsErrors = project
.SelectMany(x => x.Properties) .PropertyGroups.SelectMany(x => x.Properties)
.FirstOrDefault(x => x.Name == "TreatWarningsAsErrors"); .FirstOrDefault(x => x.Name == "TreatWarningsAsErrors");
if (treatWarningsAsErrors is null || treatWarningsAsErrors.Value is not "true") if (treatWarningsAsErrors is null || treatWarningsAsErrors.Value is not "true")
{ {
@@ -37,13 +33,11 @@ public static class WarningsAsErrors
return projectsMissingTreatWarningsAsErrors; return projectsMissingTreatWarningsAsErrors;
} }
public static void AddMissingTreatWarningsAsErrorsToSolution(string solutionFilePath) public static void AddMissingTreatWarningsAsErrorsToSolution(string solutionFilePath)
{ {
var solutionFile = SolutionFile.Parse(solutionFilePath); var solutionFile = SolutionFile.Parse(solutionFilePath);
var csprojList = SolutionProjectParity.GetCSharpProjectObjectsFromSolutionFile( var csprojList = SolutionProjectParity.GetCSharpProjectObjectsFromSolutionFile(solutionFile);
solutionFile
);
var projectsMissingImplicitUsings = FindCSharpProjectsMissingTreatWarningsAsErrors(csprojList); var projectsMissingImplicitUsings = FindCSharpProjectsMissingTreatWarningsAsErrors(csprojList);
AddMissingTreatWarningsAsErrors(projectsMissingImplicitUsings); AddMissingTreatWarningsAsErrors(projectsMissingImplicitUsings);
} }
@@ -51,36 +45,29 @@ public static class WarningsAsErrors
public static void RemoveAllTreatWarningsAsErrorsInSolution(string solutionFilePath) public static void RemoveAllTreatWarningsAsErrorsInSolution(string solutionFilePath)
{ {
var solutionFile = SolutionFile.Parse(solutionFilePath); var solutionFile = SolutionFile.Parse(solutionFilePath);
var csprojList = SolutionProjectParity.GetCSharpProjectObjectsFromSolutionFile( var csprojList = SolutionProjectParity.GetCSharpProjectObjectsFromSolutionFile(solutionFile);
solutionFile
);
RemoveTreatWarningsAsErrors(csprojList); RemoveTreatWarningsAsErrors(csprojList);
} }
public static void AddMissingTreatWarningsAsErrors( public static void AddMissingTreatWarningsAsErrors(List<ProjectRootElement> projectsMissingImplicitUsings)
List<ProjectRootElement> projectsMissingImplicitUsings
)
{ {
foreach (var project in projectsMissingImplicitUsings) foreach (var project in projectsMissingImplicitUsings)
{ {
if (ProjectIsMissingTreatWarningsAsErrors(project)) if (ProjectIsMissingTreatWarningsAsErrors(project))
{ {
project.AddProperty("TreatWarningsAsErrors", "true"); project.AddProperty("TreatWarningsAsErrors", "true");
project.Save(); project.Save();
FormatCsproj.FormatCsprojFile(project.FullPath); FormatCsproj.FormatCsprojFile(project.FullPath);
} }
} }
} }
public static void RemoveTreatWarningsAsErrors( public static void RemoveTreatWarningsAsErrors(List<ProjectRootElement> projectList)
List<ProjectRootElement> projectList
)
{ {
foreach (var project in projectList) foreach (var project in projectList)
{ {
var treatWarningsAsErrors = project.PropertyGroups var treatWarningsAsErrors = project
.SelectMany(x => x.Properties) .PropertyGroups.SelectMany(x => x.Properties)
.FirstOrDefault(x => x.Name == "TreatWarningsAsErrors"); .FirstOrDefault(x => x.Name == "TreatWarningsAsErrors");
if (treatWarningsAsErrors is not null) if (treatWarningsAsErrors is not null)
{ {
@@ -93,8 +80,8 @@ public static class WarningsAsErrors
private static bool ProjectIsMissingTreatWarningsAsErrors(ProjectRootElement project) private static bool ProjectIsMissingTreatWarningsAsErrors(ProjectRootElement project)
{ {
var implicitUsings = project.PropertyGroups var implicitUsings = project
.SelectMany(x => x.Properties) .PropertyGroups.SelectMany(x => x.Properties)
.FirstOrDefault(x => x.Name == "TreatWarningsAsErrors"); .FirstOrDefault(x => x.Name == "TreatWarningsAsErrors");
if (implicitUsings is null) if (implicitUsings is null)
{ {
@@ -107,7 +94,7 @@ public static class WarningsAsErrors
private static bool ProjectBuildSuccessfully(ProjectRootElement project) private static bool ProjectBuildSuccessfully(ProjectRootElement project)
{ {
// build the project // build the project
var buildProject = new Microsoft.Build.Evaluation.Project(project); var buildProject = new Microsoft.Build.Evaluation.Project(project);
// retrieve warnings // retrieve warnings
var buildResult = buildProject.Build(); var buildResult = buildProject.Build();
return buildResult; return buildResult;

6
README.md
View File

@@ -25,11 +25,9 @@ _options_
`-d|--enable-disabled` enables disabled implicit usings in all project files `-d|--enable-disabled` enables disabled implicit usings in all project files
`-a|--enable-all` enables implicit usings in all project files `-a|--enable-all` enables implicit usings in all project files
**warnings-as-errors** `<SolutionFilePath>` **NOT IMPLEMENTED IN CLI YET** Find projects in sln that don't have TreatWarningsAsErrors enabled. Optionally enables them. **warnings-as-errors** `<SolutionFilePath>` Find projects in sln that don't have TreatWarningsAsErrors enabled. Optionally enables them.
_options_ _options_
`-m|--add-missing` adds missing TreatWarningsAsErrors to all project files `-m|--add-missing` adds missing TreatWarningsAsErrors to all project files
`-d|--enable-disabled` enables disabled TreatWarningsAsErrors in all project files
`-a|--enable-all` enables TreatWarningsAsErrors in all project files
**clear-bin-obj** `<SolutionFolderPath>` **NOT IMPLEMENTED IN CLI YET** Deletes all bin and obj folders, and node_modules folders in the solution folder. **clear-bin-obj** `<SolutionFolderPath>` **NOT IMPLEMENTED IN CLI YET** Deletes all bin and obj folders, and node_modules folders in the solution folder.