aolszowka/msbuildprojectreferencefixer

Utility for Fixing Project References

MsBuildProjectReferenceFixer

Utility for Fixing Project References in MSBuild Project System Files.

When To Use This Tool

This tool is intended to be used after you have done a massive source folder reorganization. The problem becomes now all of the relative paths to your Project Files are invalid in any MSBuild Project System File (IE *.CSPROJ) that used a Project Reference. In addition if you have done any renaming this would need to change too.

This is for 2 reasons as per the documentation Microsoft Docs: Common MSBuild Project Items - ProjectReference:

• The Include Attribute on the ProjectReference Tag is now most likely invalid.
  • This is a relative path, relative to the Project File which the tag resides in. If you have moved this project you would need to regenerate the relative path, therefore a simple find and replace is not fesible.
• The Name Tag (Child of ProjectReference) could possibly be out of date.
  • This is the File Name of the project (without the extension) to which you have reference.

While these items are documented as being optional in practice Visual Studio (at least as of Visual Studio 2017 15.8.7) will helpfully correct any out of date elements if it can find them. However after a massive source folder reorganization this is unlikely because chances are the relative paths are all broken or the project name has changed.

Previous to this tool you had to open each affected MSBuild Project System File and remove/re-add the project in question. This is tedious and error prone.

Operation

This tool will:

• Scan the Given Directory for MSBuild System Project Files
  • It will load up each project into a Lookup Dictionary that is keyed off of the ProjectGuid. If this is duplicated this utility will throw an InvalidOperationException. For help in identifying these conditions see https://github.com/aolszowka/MsBuildDuplicateProjectGuid to fix this condition see https://github.com/aolszowka/MsBuildSetProjectGuid.
• For Each MSBuild System Project File it will scan inside the file for ProjectReference Tags
  • If the ProjectReference tag is missing the (Optional) Project Child Element this utility will throw an InvalidOperationException for help in fixing this condition see https://github.com/aolszowka/MsBuildResyncProjectReferenceGuid
• For Each ProjectReference Tag, based on the Project Guid, it will regenerate the following:
  • Reset the Include attribute of ProjectReference to the Relative Path of the project found in the Lookup Dictionary
  • Reset the Name Child Element of ProjectReference to the file name of the project found in the Lookup Dictionary (without its file extension).

This tool will make no attempt to fix any Solution Files. See the sister project https://github.com/aolszowka/VisualStudioSolutionFixer for a way to fix those.

Usage

There are now two ways to run this tool:

1. (Compiled Executable) Invoke the tool via MsBuildProjectReferenceFixer and pass the arguments.
2. (Dotnet Tool) Install this tool using the following command dotnet tool install MsBuildProjectReferenceFixer (assuming that you have the nuget package in your feed) then invoke it via dotnet project-fixprojectreferences

In both cases the flags to the tooling are identical:

Usage: C:\ProjectDirectory\ [-validate]

Scans given directory for MsBuild Projects; Correcting their ProjectReference
tags.

This program will modify the specified Target Directory always returning an exit
code of zero, regardless of how many projects were fixed.

If you run this program with the validate argument, instead of modifying the
projects, the exit code will be equal to the number of projects that would have
been fixed.

In all cases the program will print out the projects that needed to be fixed.

               <>            The directory to spin though for Project Files
      --validate             Indicates if this tool should only be run in
                               validation mode
  -?, -h, --help             Show this message and exit

Hacking

The most likely change you will want to make is changing the supported project files. In theory this tool should support any MSBuild Project Format that utilizes a ProjectGuid.

See MsBuildProjectReferenceFixer.GetProjectsInDirectory(string) for the place to modify this.

The tool should also support those projects that utilize the same ProjectReference format as CSPROJ formats.

Contributing

Pull requests and bug reports are welcomed so long as they are MIT Licensed.

License

This tool is MIT Licensed.

Third Party Licenses

This project uses other open source contributions see LICENSES.md for a comprehensive listing.

msbuildprojectreferencefixer's Issues

Request: Utilize NDesk.Options For Options Parsing

tl;dr; Use http://www.ndesk.org/Options to perform our options parsing. Its MIT Licensed which is compatible with the license of this project and is extremely lightweight.

Currently we do a bunch of manual options parsing, however this makes it difficult to extend this program by forcing us to deal with command line parsing which isn't our goal. Rather we should spin this out into a library.

There are lots of options parsing libraries available to us, for example Microsoft provides https://github.com/dotnet/command-line-api. However if you look at the number of dependencies that has to carry around you nope out of that pretty quickly.

Rather I am going to suggest we use NDesk.Options for parsing, its a super lightweight dependency (just a single CS file), the usage is very straight forward, and is MIT Licensed.

The only downsides I can see is that it is not actively maintained (last updated back in 2008) and has some pretty gnarly LINQ in it to perform its magic. This probably means that there are some corner cases but at this point its better than rolling our own.

Request: Convert to .NET Core / Enable GitHub Actions

Convert this project to .NET Core

The reason is I would like to try and ship these tools as a .NET Core Tool (https://docs.microsoft.com/en-us/dotnet/core/tools/global-tools-how-to-create)