Skip to content

ReadMe.md

Latest commit

 

History

History
61 lines (49 loc) · 2.77 KB

ReadMe.md

File metadata and controls

61 lines (49 loc) · 2.77 KB

About

The Ubiquity.NET.CodeAnalysis.Utils contains support for building Roslyn analyzers, fixers, and source generator. As such it specifically targets .NET Standard 2.0 and has no dependencies on anything targeting a later runtime. If an analyzer (or any Roslyn extension) depends on this package the dependencies for the package must be included in the extension's package.

Key support

  • Support for caching of generation scan results (via IEquatable<T>)
  • Debug diagnostic asserts for class vs. struct trade-offs
  • Capturing symbol information in a cacheable fashion
  • Generation of diagnostics for issues detected in a generator1
  • Create a SourceText from a StringBuilder to allow generation to remain independent of the Roslyn CodeAnalysis types.

Dependencies

Name Version Description
Microsoft.Bcl.HashCode 6.0.0 Poly fill library for HashCode support
Microsoft.CodeAnalysis.Analyzers 4.14.0 Roslyn Analyzer library
Microsoft.CodeAnalysis.CSharp 5.0.0 Roslyn library specifically for C#

Microsoft.CodeAnalysis.* is assumed already present for a Roslyn component and therefor is not required in the package.

Full documentation of the support provided by this package is available in the online documentation.

Example of use

<Project Sdk="Microsoft.NET.Sdk">

  <!-- ... -->

  <PackageReference Include="Microsoft.Bcl.HashCode" PrivateAssets="all" GeneratePathProperty="true">
    <__AssemblyPath>$(PkgMicrosoft_Bcl_HashCode)\lib\$(TargetFramework)\*.dll</__AssemblyPath>
  </PackageReference>

  <Target Name="GetDependencyTargetPaths" BeforeTargets="GetTargetPath">
    <ItemGroup>
      <TargetPathWithTargetPlatformMoniker Condition="'%(PackageReference.__AssemblyPath)' != ''" Include="%(PackageReference.__AssemblyPath)" IncludeRuntimeDependency="false" />
    </ItemGroup>

    <!-- Pack all PackageReferences with _AssemblyPath metadata -->
    <ItemGroup>
      <None Condition="'%(PackageReference.__AssemblyPath)' != ''" Include="%(PackageReference.__AssemblyPath)" Visible="false" Pack="true" PackagePath="analyzers/dotnet/cs" />
    </ItemGroup>
  </Target>
</project>

1 Generators creating diagnostics is generally not recommended. The official Incremental Generators cook book recommends against it. A generator should normally ignore invalid input and fail silently by ignoring the problem. An analyzer can produce the diagnostics for problems. At most a generator can use this support to report critical problems that prevent the generator from running at all.