Skip to content

Commit

Permalink
Update package information (#20)
Browse files Browse the repository at this point in the history
  • Loading branch information
Corniel authored Aug 2, 2024
1 parent 5b0d102 commit dc71707
Show file tree
Hide file tree
Showing 6 changed files with 56 additions and 26 deletions.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,12 @@
# Roslyn (Static) Code Analysis Test Tools
![Roslyn TestTools](design/package-icon.png)

[![License: MIT](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://opensource.org/license/lgpl-3-0)

| version | downloads | package |
|----------------------------------------------------------------------|-------------------------------------------------------------|-----------------------------------------------------------------|
|![v](https://img.shields.io/nuget/v/CodeAnalysis.TestTools?color=18C) |![v](https://img.shields.io/nuget/dt/CodeAnalysis.TestTools) |[Qowaiv](https://www.nuget.org/packages/CodeAnalysis.TestTools/) |

# Roslyn (Static) Code Analysis Test Tools
The package provides tooling to verify the behavior of [Diagnostic Analyzers](https://docs.microsoft.com/en-us/dotnet/api/microsoft.codeanalysis.diagnostics.diagnosticanalyzer),
and [Code Fix Providers](https://learn.microsoft.com/en-us/dotnet/api/microsoft.codeanalysis.codefixes.codefixprovider).
It does this by providing a (test) context builder, and a mechanism to define
Expand Down
7 changes: 7 additions & 0 deletions Roslyn.TestTools.sln
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,12 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "props", "props", "{8ACBEBEC
props\common.props = props\common.props
EndProjectSection
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "design", "design", "{EBB2ECB9-5B44-4061-A89B-BC0BB32597CF}"
ProjectSection(SolutionItems) = preProject
design\package-icon.png = design\package-icon.png
design\package-icon.psd = design\package-icon.psd
EndProjectSection
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Expand All @@ -56,6 +62,7 @@ Global
{5811F55D-6885-4288-8C7D-862CC2B43D7F} = {63109C67-1737-48B6-AF84-BCA0262A86F9}
{7C583E7B-BCA6-47E9-B89E-A546C94010A1} = {5811F55D-6885-4288-8C7D-862CC2B43D7F}
{8ACBEBEC-3FBE-49A6-833B-F34C22DF5CBD} = {63109C67-1737-48B6-AF84-BCA0262A86F9}
{EBB2ECB9-5B44-4061-A89B-BC0BB32597CF} = {63109C67-1737-48B6-AF84-BCA0262A86F9}
EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {59DFE69B-0C3B-4ADA-AB6A-4C72A52D5C08}
Expand Down
Binary file added design/package-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added design/package-icon.psd
Binary file not shown.
57 changes: 32 additions & 25 deletions src/CodeAnalysis.TestTools/CodeAnalysis.TestTools.csproj
Original file line number Diff line number Diff line change
@@ -1,49 +1,56 @@
<Project Sdk="Microsoft.NET.Sdk">

Check warning on line 1 in src/CodeAnalysis.TestTools/CodeAnalysis.TestTools.csproj

View workflow job for this annotation

GitHub Actions / build

Define the <IsPublishable> node explicitly. (https://dotnet-project-file-analyzers.github.io/rules/Proj0400.html)

Check warning on line 1 in src/CodeAnalysis.TestTools/CodeAnalysis.TestTools.csproj

View workflow job for this annotation

GitHub Actions / build

Define the <OutputType> node explicitly. (https://dotnet-project-file-analyzers.github.io/rules/Proj0010.html)

Check warning on line 1 in src/CodeAnalysis.TestTools/CodeAnalysis.TestTools.csproj

View workflow job for this annotation

GitHub Actions / build

Define the <Description> or <PackageDescription> node explicitly or define the <IsPackable> node with value 'false'. (https://dotnet-project-file-analyzers.github.io/rules/Proj0202.html)

Check warning on line 1 in src/CodeAnalysis.TestTools/CodeAnalysis.TestTools.csproj

View workflow job for this annotation

GitHub Actions / build

Define the <Authors> node explicitly or define the <IsPackable> node with value 'false'. (https://dotnet-project-file-analyzers.github.io/rules/Proj0203.html)

Check warning on line 1 in src/CodeAnalysis.TestTools/CodeAnalysis.TestTools.csproj

View workflow job for this annotation

GitHub Actions / build

Define the <PackageTags> node explicitly or define the <IsPackable> node with value 'false'. (https://dotnet-project-file-analyzers.github.io/rules/Proj0204.html)

Check warning on line 1 in src/CodeAnalysis.TestTools/CodeAnalysis.TestTools.csproj

View workflow job for this annotation

GitHub Actions / build

Define the <Copyright> node explicitly or define the <IsPackable> node with value 'false'. (https://dotnet-project-file-analyzers.github.io/rules/Proj0207.html)

Check warning on line 1 in src/CodeAnalysis.TestTools/CodeAnalysis.TestTools.csproj

View workflow job for this annotation

GitHub Actions / build

Use the .NET project file analyzers. (https://dotnet-project-file-analyzers.github.io/rules/Proj1000.html)

Check warning on line 1 in src/CodeAnalysis.TestTools/CodeAnalysis.TestTools.csproj

View workflow job for this annotation

GitHub Actions / build

Use Microsoft.CodeAnalysis.Analyzers to analyze Microsoft.CodeAnalysis. (https://dotnet-project-file-analyzers.github.io/rules/Proj1001.html)

Check warning on line 1 in src/CodeAnalysis.TestTools/CodeAnalysis.TestTools.csproj

View workflow job for this annotation

GitHub Actions / build

Add SonarAnalyzer.CSharp. (https://dotnet-project-file-analyzers.github.io/rules/Proj1003.html)

<Import Project="..\..\props\common.props" />

<PropertyGroup>
<TargetFrameworks>net6.0;net8.0</TargetFrameworks>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<Version>3.0.0</Version>
<PackageReleaseNotes>
v3.0.0
- Logging expected issues to the console only in DEBUG mode.
- Update dependency Buildalyzer 7.*. (breaking)
v2.0.0
- Drop .NET 7.0 support. (breaking)
- Update dependency Buildalyzer 6.*. (breaking)
v1.3.0
- Target .NET 8.0
v1.2.0
- Build with Buildalyzer.
- Don't try to read the NuGet V3 url from a config file.
v1.1.0
- Support additional files for projects.
v1.0.0
- Support verifying against projects.
v0.0.4
- Support for verifying code fix providers. (#7)
- Fix invalid cast for adding NuGet packages.
v0.0.3.1
- GuardedCollection AddRange failed to add items to the new collection. (#4)
v3.0.0
- Logging expected issues to the console only in DEBUG mode.
- Update dependency Buildalyzer 7.*. (breaking)
v2.0.0
- Drop .NET 7.0 support. (breaking)
- Update dependency Buildalyzer 6.*. (breaking)
v1.3.0
- Target .NET 8.0
v1.2.0
- Build with Buildalyzer.
- Don't try to read the NuGet V3 url from a config file.
v1.1.0
- Support additional files for projects.
v1.0.0
- Support verifying against projects.
v0.0.4
- Support for verifying code fix providers. (#7)
- Fix invalid cast for adding NuGet packages.
v0.0.3.1
- GuardedCollection AddRange failed to add items to the new collection. (#4)
</PackageReleaseNotes>
</PropertyGroup>

<PropertyGroup Label="Package info">
<PackageId>CodeAnalysis.TestTools</PackageId>
<EnablePackageValidation>true</EnablePackageValidation>
<IsPackable>true</IsPackable>
<PackageId>CodeAnalysis.TestTools</PackageId>
<PackageIcon>package-icon.png</PackageIcon>
<PackageIconUrl>https://github.com/Corniel/roslyn-test-tools/blob/master/design/package-icon.png</PackageIconUrl>
<PackageLicenseExpression>LGPL-3.0</PackageLicenseExpression>
<PackageLicenseExpression>LGPL-3.0-or-later</PackageLicenseExpression>
<PackageProjectUrl>https://github.com/Corniel/roslyn-test-tools</PackageProjectUrl>
<PackageReadmeFile>README.md</PackageReadmeFile>
<PackageValidationBaselineVersion>3.0.0</PackageValidationBaselineVersion>
<RepositoryType>git</RepositoryType>
<RepositoryUrl>https://github.com/Corniel/roslyn-test-tools</RepositoryUrl>
<DefineConstants>CONTRACTS_FULL</DefineConstants>
</PropertyGroup>

<PropertyGroup Condition="'$(CompileConfig)' == 'RELEASE'">

<ItemGroup Label="Package files">
<None Include="../../design/package-icon.png" Pack="true" PackagePath="" />
<None Include="README.md" Pack="true" PackagePath="" />
</ItemGroup>

<PropertyGroup Condition="'$(CompileConfig)' != 'DEBUG'">
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
</PropertyGroup>

Expand Down
8 changes: 8 additions & 0 deletions src/CodeAnalysis.TestTools/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Roslyn Test Tools
The package provides tooling to verify the behavior of [Diagnostic Analyzers](https://docs.microsoft.com/en-us/dotnet/api/microsoft.codeanalysis.diagnostics.diagnosticanalyzer),
and [Code Fix Providers](https://learn.microsoft.com/en-us/dotnet/api/microsoft.codeanalysis.codefixes.codefixprovider).
It does this by providing a (test) context builder, and a mechanism to define
expected issues in code (files).

## Further reading
More info can be found at https://github.com/Corniel/roslyn-test-tools.

0 comments on commit dc71707

Please sign in to comment.