Add SourceLink support to package

[matracey]

New features and updates

522be95 add debug symbols and explicit packable configuration to src/Directory.build.props
f1fd5d7 add explicit SourceLink.GitHub package reference
31bd648 add msbuild properties for SourceLink
e72126c upgrade packages to latest versions

Project structure enhancements

558b8cb move sln file up to project root
f616e41 add missing loose items to sln file
f4ef2d5 add recommended VS Code extensions to extensions.json
8cecd49 update gitignore using dotnet new gitignore
7b1e292 add global.json with SDK version configuration
d554044 add IsTestProject property to Directory.Build.props for test folder
5ea3667 update AssemblyVersion and FileVersion to use JsonDiffPatchPackageVersion

[matracey]

@weichch Are you still maintaining this package? Happy to take it over if not.

[weichch]

@weichch Are you still maintaining this package? Happy to take it over if not.

Hi @matracey yes I’m still maintaining this package. I’m on holiday for a few weeks will take a look once I’m back. Thanks for the PR btw.

[weichch]

Hi @matracey Thanks again for taking effort to contribute. Like I mentioned in the comments, can we please track the repository house-keeping changes in a separate issue?

It's a little hard to follow the actual changes in this PR with more than 100 files changed due to reformatting.

[weichch]

Why moved solution file here?

[matracey]

I thought it makes more sense to have the sln file at the root, since the src folder will contain the source for the library itself, and the test folder will contain the source code for the tests.

IMO, it's easier to find the sln file in the root, since many open source .NET repos follow this paradigm, and it makes more sense to reference like src\SystemTextJson.JsonDiffPatch\SystemTextJson.JsonDiffPatch.csproj & test\SystemTextJson.JsonDiffPatch.UnitTests\SystemTextJson.JsonDiffPatch.UnitTests.csproj rather than SystemTextJson.JsonDiffPatch\SystemTextJson.JsonDiffPatch.csproj & ..\test\SystemTextJson.JsonDiffPatch.UnitTests\SystemTextJson.JsonDiffPatch.UnitTests.csproj.

[weichch]

What's the purpose of adding this?

[matracey]

I added SourceLink because it provides a great source debugging experience for end users. It provides a lot of debug-time assistance, allowing to step into the source code of the compiled NuGet package by pulling the source from GitHub, rather than trying to use decompilation. SourceLink is supported by Microsoft and included in the .NET SDK for a variety of common source control providers, including GitHub, and adding it provides a quick win for a much improved package consumer experience.

[weichch]

I cherry picked some of the changes in this PR into #43 as co-authored commit. Let's keep this PR open for addressing VS Code support if you wish.

I also found Microsoft has added two new methods in .NET 8 JsonNode.DeepEquals and JsonNode.DeepClone. Those methods are conflicting with the extension methods in this package as per mentioned in #4, and I will take a look at how to address those. Meanwhile, those methods don't seem to exist in .NET 6 and .NET 7.