Fix bugs, fix nuget packaging, adjust readme

Author: loop8ack

.editorconfig

@@ -11,9 +11,6 @@ indent_style = space
 end_of_line = lf
 insert_final_newline = true
 tab_width = 4
-spelling_languages = en-us
-spelling_exclusion_path = .\spelling_exclusion.dic
-spelling_use_default_exclusion_dictionary = true
 
 [*.json]
 indent_size = 2

PackScan.sln

@@ -17,7 +17,6 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		LICENSE = LICENSE
 		nuget.config = nuget.config
 		ReadMe.md = ReadMe.md
-		spelling_exclusion.dic = spelling_exclusion.dic
 	EndProjectSection
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".config", ".config", "{C20C1112-EF7A-48C1-9282-872163BBDFC4}"

ReadMe.md

@@ -12,57 +12,72 @@ The included analyzer helps you ensure license compliance by identifying package
 Additionally, these tools offer optional configurations to generate code that provides access to icons, license texts, ReadMe content, release notes, and other package information.
 You can include these additional resources based on your specific needs.
 
-Key Features:
-* Generate code for easy access to package data
-* Analyze and enforce license compliance
-* Customizable configuration settings
-* Seamless integration with your projects
-* Possibility of use with CI/CD
+Currently, the project only supports C#, but it is designed in a way that allows for future support of VB.NET or F#.
 
-You have two options to choose from:
+### Key Features
 
-**[PackScan.Tool](https://www.nuget.org/packages/PackScan.Tool)**
+1. **Generate Package Data:**</br>
+Generate simple and easily accessible code to retrieve detailed information about the packages installed in your project.
+With this code, you can easily access package versions, dependencies, licenses, and other data.
+
+3. **Check License Compliance:**</br>
+The included analyzer helps you ensure compliance with licensing requirements.
+Identify packages that contain licenses not compatible with your project or company policies, enabling you to address potential licensing issues early on.
+
+5. **Customizable Configuration:**</br>
+Tailor the behavior of the tool to perfectly match your requirements.
+Adjust the configuration to change how package contents are loaded, code is generated, and license analyses are performed.
+
+7. **Seamless Project Integration:**</br>
+The project can be seamlessly integrated into your existing projects.
+Install the required NuGet packages and configure the settings accordingly. Accessing package data and license information is straightforward through the generated code.
+
+9. **Possible Use with CI/CD:**</br>
+The .NET Tool allows integration into CI/CD processes, automating package analysis and management in your continuous integration and deployment workflows.
+
+### **[PackScan.Tool](https://www.nuget.org/packages/PackScan.Tool)**
 
 The .NET Tool provides integration into CI/CD processes and supports different ways of depositing content files.
 
-**[PackScan.Analyzer](https://www.nuget.org/packages/PackScan.Analyzer)**
+### **[PackScan.Analyzer](https://www.nuget.org/packages/PackScan.Analyzer)**
 
 The Analyzer can be configured directly in your project and supports checking which packages and licenses are allowed.
 
 # Installation
 
-For both options, you need to install the NuGet package [PackScan.PackagesProvider.Abstractions](https://www.nuget.org/packages/PackScan.PackagesProvider.Abstractions) in those projects in which you want to use the generated code.</br>
-You can install it using the NuGet package manager or add the following lines to your project:
+### Analyzer
+
+Install the analyzer:
 
 ```
-<ItemGroup>
-    <PackageReference Include="PackScan.PackagesProvider.Abstractions" Version="x.x.x" /> <!-- use the latest version -->
-</ItemGroup>
+dotnet add package --prerelease PackScan.Analyzer
 ```
 
-## .NET Tool
+Additionally, you need to install the following package in all projects where you want to use the code:
+
+```
+dotnet add package --prerelease PackScan.PackagesProvider.Abstractions
+```
 
-To install the .NET Tool, run [dotnet tool install](https://learn.microsoft.com/de-de/dotnet/core/tools/dotnet-tool-install) with "PackScan.Tool".
+### .NET Tool
 
-It is also recommended to install the following package to have all the standard configurations:
+Install the .NET Tool:
 
 ```
-<ItemGroup>
-    <PackageReference Include="PackScan.Defaults" Version="x.x.x" /> <!-- use the latest version -->
-</ItemGroup>
+dotnet tool install --prerelease --global PackScan.Tool
 ```
 
-## Analyzer
-
-To install the analyzer, use the NuGet package manager or add the following lines to your project:
+It is also necessary to install the following package to enable all configuration features:
 
 ```
-<ItemGroup>
-    <PackageReference Include="PackScan.Analyzer" Version="x.x.x" /> <!-- use the latest version -->
-</ItemGroup>
+dotnet add package --prerelease PackScan.Defaults
 ```
 
-Both options offer similar benefits and can be selected and configured based on your specific needs and requirements.
+Additionally, you need to install the following package in all projects where you want to use the code:
+
+```
+dotnet add package --prerelease PackScan.PackagesProvider.Abstractions
+```
 
 # Generated Result
 
@@ -75,7 +90,9 @@ Here's how you can use the generated code:
 var serilog = Packages.GetPackageById("Serilog");
 
 foreach (var package in Packages.GetPackages())
+{
     Console.WriteLine($"{package.Id} | {package.Version.Value} | {package.License?.Expression}");
+}
 
 // or with an instance
 
@@ -84,7 +101,9 @@ IPackagesProvider instance = new Packages();
 var serilog = instance.GetPackageById("Serilog");
 
 foreach (var package in instance.GetPackages())
+{
     Console.WriteLine($"{package.Id} | {package.Version.Value} | {package.License?.Expression}");
+}
 
 // or with dependency injection
 
@@ -96,7 +115,9 @@ var packagesProvider = services.GetRequiredService<IPackagesProvider>();
 var serilog = instance.GetPackageById("Serilog");
 
 foreach (var package in instance.GetPackages())
+{
     Console.WriteLine($"{package.Id} | {package.Version.Value} | {package.License?.Expression}");
+}
 
 ```
 
@@ -141,26 +162,6 @@ dotnet package-tools generate-packages-provider --output PackagesProvider --load
 
 ### Project Properties
 
-- **IncludeWellKnownPackageIds**</br>
-Specifies whether to include the default set of KnownPackageId entries (`true`) or not (`false`).</br>
-Default value: `true`</br>
-Well-known package id values:
-  - **System** | Owner: Microsoft, Product: .NET
-  - **runtime** | Owner: Microsoft, Product: .NET Runtime
-  - **NETStandard** | Owner: Microsoft, Product: .NET Standard
-  - **Microsoft** | Owner: Microsoft
-  - **Microsoft.Maui** | Owner: Microsoft, Product: MAUI
-  - **Microsoft.Azure** | Owner: Microsoft, Product: Azure
-  - **Microsoft.AspNetCore** | Owner: Microsoft, Product: ASP.NET Core
-  - **Microsoft.EntityFrameworkCore** | Owner: Microsoft, Product: Entity Framework
-
-- **IncludeWellKnownAllowedLicenses**</br>
-Specifies whether to include the default set of allowed licenses by expression or owner (`true`) or not (`false`).</br>
-Default value: `true`</br>
-Well-known licenses:
-  - By expression: MIT
-  - By owner: Microsoft
-
 - **AllowedLicensesAnalyzationEnabled**</br>
 Determines whether to check the licenses of the installed packages (`true`) or not (`false`).</br>
 This option should be preferred over disabling all warnings since it does not require package data to be loaded.</br>
@@ -226,13 +227,24 @@ A list of all allowed licenses or license expressions.</br>
 - **AllowedLicenseByOwner**</br>
 A list of all explicitly allowed package owners to be excluded from the license check.</br>
 Please note that you need to map the owners manually as they cannot be automatically extracted.</br>
+Default values: `Microsoft`
 
 - **AllowedLicenseByPackage**</br>
 A list of all explicitly allowed packages to be excluded from the license check.</br>
+Default values: `MIT` `Apache-2.0`
 
 - **KnownPackageId**</br>
 Allows registering known package ID prefixes along with their corresponding owners and products.
 For each package, the last matching prefix is used to determine the associated data.</br>
+Default values: </br>
+  - **System** | Owner: Microsoft, Product: .NET
+  - **runtime** | Owner: Microsoft, Product: .NET Runtime
+  - **NETStandard** | Owner: Microsoft, Product: .NET Standard
+  - **Microsoft** | Owner: Microsoft
+  - **Microsoft.Maui** | Owner: Microsoft, Product: MAUI
+  - **Microsoft.Azure** | Owner: Microsoft, Product: Azure
+  - **Microsoft.AspNetCore** | Owner: Microsoft, Product: ASP.NET Core
+  - **Microsoft.EntityFrameworkCore** | Owner: Microsoft, Product: Entity Framework
 
 ## .NET Tool
 

spelling_exclusion.dic

@@ -5,7 +5,7 @@
   </PropertyGroup>
 
   <PropertyGroup>
-    <Version>0.1.0</Version>
+    <Version>0.1.0-alpha</Version>
     <Authors>Loop8ack</Authors>
     <PackageReadmeFile>ReadMe.md</PackageReadmeFile>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
@@ -15,12 +15,12 @@
     <PackageTags>msbuild;package;generator</PackageTags>
     <NeutralLanguage>en</NeutralLanguage>
     <Copyright>Copyright $([System.DateTime]::Now.ToString(yyyy)) $(Authors)</Copyright>
-    <Description>Simplify package information retrieval and license compliance in your .NET projects. Access comprehensive package details, including dependencies, icons, license texts, ReadMe content, and release notes directly from your code.</Description>
+    <Description>Simplify package information retrieval and license compliance in your .NET projects. Access comprehensive package details, including dependencies, icons, license texts, ReadMe content, release notes and more directly from your code.</Description>
   </PropertyGroup>
 
   <ItemGroup>
-    <Content Include="$(MSBuildThisFileDirectory)\..\LICENSE" PackagePath="\" InProject="false" Visible="false" Pack="true" />
-    <Content Include="$(MSBuildThisFileDirectory)\..\ReadMe.md" PackagePath="\" InProject="false" Visible="false" Pack="true" />
+    <Content Include="$(MSBuildThisFileDirectory)\..\LICENSE" PackagePath="\" Visible="false" Pack="true" />
+    <Content Include="$(MSBuildThisFileDirectory)\..\ReadMe.md" PackagePath="\" Visible="false" Pack="true" />
   </ItemGroup>
 
 </Project>

src/NuGet.Metadata.props

@@ -151,7 +151,7 @@ public static class EmptyLicenseIsNotAllowed
             = new DiagnosticDescriptor(
                 id: $"{Prefix}{(int)Id.EmptyLicenseIsNotAllowed:000}",
                 title: "Packages without a license are not allowed",
-                messageFormat: "Empty licenses are not allowed. Possibly the license could not be read. Consider allowing the package directly (AllowedLicenseByPackage) or empty licenses (AllowEmptyLicense). Affected packages: {0}",
+                messageFormat: "Empty licenses are not allowed. Possibly the license could not be read. Consider allowing the package directly (AllowedLicenseByPackage) or empty licenses (AllowEmptyLicenses). Affected packages: {0}",
                 category: Category,
                 DiagnosticSeverity.Warning,
                 isEnabledByDefault: true);

src/PackScan.Analyzer/Core/Diagnostics.cs

@@ -9,8 +9,8 @@ internal static class KnownOptions
     private static readonly IReadOnlyDictionary<string, Language> _languageValueMapping =
         new Dictionary<string, Language>(StringComparer.OrdinalIgnoreCase)
         {
-            ["C#"] = Language.CSharp,
-            ["F#"] = Language.FSharp,
+            ["C"] = Language.CSharp,
+            ["F"] = Language.FSharp,
             ["VB"] = Language.VisualBasic,
         };
 

src/PackScan.Analyzer/Core/Options/KnownOptions.cs

@@ -45,7 +45,10 @@ public IReadOnlyCollection<IPackageData> Read()
 
         IEnumerable<KnownPackageId> knownPackageIds = ParseKnownPackageIds(KnownPackageIds.Value).ToArray();
 
-        IPackageDataReader reader = new PackageDataReader(assetsFilePath, TargetFramework, RuntimeIdentifier, knownPackageIds);
+        IPackageDataReader reader = new PackageDataReader(assetsFilePath, TargetFramework, RuntimeIdentifier)
+        {
+            KnownPackageIds = ParseKnownPackageIds(KnownPackageIds.Value).ToArray()
+        };
 
         return reader.Read();
     }

src/PackScan.Analyzer/Core/Services/PackageDataReaderService.cs

@@ -6,17 +6,21 @@
     <TargetFramework>netstandard2.0</TargetFramework>
     <EnforceExtendedAnalyzerRules>true</EnforceExtendedAnalyzerRules>
     <BuildOutputTargetFolder>analyzers/dotnet/cs</BuildOutputTargetFolder>
-    <SuppressDependenciesWhenPacking>true</SuppressDependenciesWhenPacking>
     <DevelopmentDependency>true</DevelopmentDependency>
     <IsRoslynComponent>true</IsRoslynComponent>
+    <NoWarn>$(NoWarn);NU5128</NoWarn>
   </PropertyGroup>
 
   <ItemGroup>
+    <Content Include="PackScan.Analyzer.props" PackagePath="build\$(PackageId).props" />
     <Content Include="PackScan.Analyzer.targets" PackagePath="build\$(PackageId).targets" />
+
+    <Content Include="..\PackScan.Defaults\PackScan.Defaults.props" PackagePath="build\%(Filename)%(Extension)" Visible="False" Pack="true" />
+    <Content Include="..\PackScan.Defaults\PackScan.Defaults.targets" PackagePath="build\%(Filename)%(Extension)" Visible="False" Pack="true" />
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.Bcl.HashCode" Version="1.1.1" />
+    <PackageReference Include="Microsoft.Bcl.HashCode" Version="1.1.1" PrivateAssets="all" />
     <PackageReference Include="Microsoft.CodeAnalysis.Analyzers" Version="3.3.4" PrivateAssets="all" />
     <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.5.0" PrivateAssets="all" />
     <PackageReference Include="IsExternalInit" Version="1.0.3" PrivateAssets="all" />
@@ -25,9 +29,9 @@
   </ItemGroup>
 
   <ItemGroup>
-    <ProjectReference Include="..\PackScan.PackagesProvider.Abstractions\PackScan.PackagesProvider.Abstractions.csproj" />
-    <ProjectReference Include="..\PackScan.PackagesProvider.Generator\PackScan.PackagesProvider.Generator.csproj" />
-    <ProjectReference Include="..\PackScan.PackagesReader\PackScan.PackagesReader.csproj" />
+    <ProjectReference Include="..\PackScan.PackagesProvider.Abstractions\PackScan.PackagesProvider.Abstractions.csproj" PrivateAssets="all" />
+    <ProjectReference Include="..\PackScan.PackagesProvider.Generator\PackScan.PackagesProvider.Generator.csproj" PrivateAssets="all" />
+    <ProjectReference Include="..\PackScan.PackagesReader\PackScan.PackagesReader.csproj" PrivateAssets="all" />
   </ItemGroup>
 
   <!-- Embed referenced dlls so that they can be loaded at runtime  -->
@@ -63,5 +67,5 @@
       </EmbeddedResource>
     </ItemGroup>
   </Target>
-  
+
 </Project>

src/PackScan.Analyzer/PackScan.Analyzer.csproj

@@ -0,0 +1,6 @@
+<Project>
+
+  <Import Project="$(MSBuildThisFileDirectory)\PackScan.Defaults.props"
+          Condition="Exists('$(MSBuildThisFileDirectory)\PackScan.Defaults.props')"/>
+  
+</Project>