Kysect.DotnetProjectSystem 0.1.16

Kysect.DotnetProjectSystem

DotnetProjectSystem is a nuget package for working with .sln, .csproj and .props files: parsing, modifying and generating.

Generating

This code samples:

var factory = new SolutionFileStructureBuilderFactory(_fileSystem, _syntaxFormatter);

factory
    .Create(solutionName)
    .AddProject(
        new ProjectFileStructureBuilder("Project")
            .SetContent("<Project></Project>"))
    .AddFile(new SolutionFileInfo(["Directory.Build.props"], "<Project></Project>"))
    .Save("C:\\Repositories\\");

will create this file structure:

- ./
    - Project/
        - Project.csproj
    - MySolution.sln
    - Directory.Build.props

Parsing

Nuget provide API for parsing .sln and .csproj files:

string solutionFilePath = ...;
DotnetSolutionParser parser = new DotnetSolutionParser(_fileSystem, logger);
DotnetSolutionDescriptor result = parser.ParseContent(solutionFilePath);

// result.FilePath == C:\Solution\Solution.sln
// result.Projects ==
// {
//    { "C:\Solution\Project.csproj", <DotnetProjectFile> }
// }

Modification

Nuget provide API for modification of parsed solution. Sample of modification;

syntaxFormatter = new XmlDocumentSyntaxFormatter();
DotnetSolutionModifier solutionModifier = solutionModifierFactory.Create("Solution.sln");

solutionModifier
    .GetOrCreateDirectoryPackagePropsModifier()
    .SetCentralPackageManagement(true);

solutionModifier.Save(syntaxFormatter)

This code will add <ManagePackageVersionsCentrally> to Directory.Package.props file.

For this modification was introduces strategy that describe modification:

public class SetTargetFrameworkModifyStrategy(string value) : IXmlProjectFileModifyStrategy<XmlElementSyntax>
{
    public IReadOnlyCollection<XmlElementSyntax> SelectNodeForModify(XmlDocumentSyntax document)
    {
        document.ThrowIfNull();

        return document
            .GetNodesByName("TargetFramework")
            .OfType<XmlElementSyntax>()
            .ToList();
    }

    public SyntaxNode ApplyChanges(XmlElementSyntax syntax)
    {
        syntax.ThrowIfNull();

        XmlTextSyntax content = SyntaxFactory.XmlText(SyntaxFactory.XmlTextLiteralToken(value, null, null));
        return syntax.ReplaceNode(syntax.Content.Single(), content);
    }
}

And this strategy applied to solutions:

DotnetSolutionModifier solutionModifier = solutionModifierFactory.Create("Solution.sln");

foreach (DotnetProjectModifier solutionModifierProject in solutionModifier.Projects)
    solutionModifierProject.File.UpdateDocument(new SetTargetFrameworkModifyStrategy("net9.0"));

solutionModifier.Save(syntaxFormatter);