Tool: CLI Support for TargetFramework and RuntimeIdentifier

Both: Support for PackagesProviderIconContentMaxSize Option

Author: loop8ack

PackScan.sln

@@ -12,19 +12,14 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 	ProjectSection(SolutionItems) = preProject
 		.editorconfig = .editorconfig
 		.gitignore = .gitignore
+		build.ps1 = build.ps1
 		Directory.Build.props = Directory.Build.props
 		global.json = global.json
 		LICENSE = LICENSE
 		nuget.config = nuget.config
-		pack.ps1 = pack.ps1
 		ReadMe.md = ReadMe.md
 	EndProjectSection
 EndProject
-Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".config", ".config", "{C20C1112-EF7A-48C1-9282-872163BBDFC4}"
-	ProjectSection(SolutionItems) = preProject
-		.config\dotnet-tools.json = .config\dotnet-tools.json
-	EndProjectSection
-EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "test", "test", "{B4BAADD5-BEF6-4D5B-9CB6-48C85D7D5D06}"
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "PackScan.Tool", "src\PackScan.Tool\PackScan.Tool.csproj", "{26685B24-B2D0-4C68-AE5F-230F9424DBF5}"
@@ -84,7 +79,6 @@ Global
 		HideSolutionNode = FALSE
 	EndGlobalSection
 	GlobalSection(NestedProjects) = preSolution
-		{C20C1112-EF7A-48C1-9282-872163BBDFC4} = {40512514-8795-4C6A-A58F-6AFC87C17B2F}
 		{26685B24-B2D0-4C68-AE5F-230F9424DBF5} = {1EF8F5B9-DD77-4162-A819-85A2B49FED7B}
 		{6A110BE4-B6E9-48A6-BFEB-1E3F2E90B84D} = {F9F7EE5C-DD30-439B-ABB0-33947D2C833B}
 		{9E8281F2-EC4E-404E-8D3C-72759FEC6D62} = {1EF8F5B9-DD77-4162-A819-85A2B49FED7B}
@@ -99,6 +93,8 @@ Global
 		SolutionGuid = {BB925338-FA98-438B-919B-EB37667CC9A9}
 	EndGlobalSection
 	GlobalSection(SharedMSBuildProjectFiles) = preSolution
+		src\PackScan.Shared\PackScan.Shared.projitems*{19e1358b-9100-4905-ba7b-a38a6c29e723}*SharedItemsImports = 5
+		src\PackScan.Shared\PackScan.Shared.projitems*{26685b24-b2d0-4c68-ae5f-230f9424dbf5}*SharedItemsImports = 5
 		src\PackScan.Shared\PackScan.Shared.projitems*{51c5972d-550e-4123-98dd-4ed087e44c5f}*SharedItemsImports = 5
 		src\PackScan.Shared\PackScan.Shared.projitems*{8f2e4832-2a8e-46cb-98f8-3ece0f45cf3d}*SharedItemsImports = 5
 		src\PackScan.Shared\PackScan.Shared.projitems*{9e8281f2-ec4e-404e-8d3c-72759fec6d62}*SharedItemsImports = 13

ReadMe.md

@@ -240,6 +240,10 @@ Default value: `None`
 Determines if and from where the release notes should be loaded. [Here](#content-load-mode), you will find the supported values.</br>
 Default value: `None`</br>
 
+- **PackagesProviderIconContentMaxSize**</br>
+Specifies the maximum size in "\<width>x\<height>" format to which the icon should be resized.</br>
+Default value: `512x512`</br>
+
 ### Project Items
 
 - **AllowedLicense**</br>
@@ -291,7 +295,9 @@ Default value: `%temp%/PackScan.PackagesProvider.Writer/DownloadCache`
 
 ### CLI Parameters
 
-- **-p, --project-path** | The path to the project folder or project file. Default value: The current working directory
+- **-f, --target-framework** | Specifies the target framework for the project. Default value: The current target framework of the project.
+- **-ri, --runtime-identifier** | Defines the runtime identifier for the project. Default value: The current runtime identifier of the project.
+- **-p, --project-path** | The path to the project folder or project file. Default value: The current working directory.
 - **-l, --language** | Sets the programming language to be used. Default value: The language based on the project file extension.
 - **--clear-output** | Determines whether the output folder should be emptied before execution (true) or not (false). Default value: `false`
 - **-o, --output** | Overrides the project property **PackagesProviderOutputPath**.
@@ -304,6 +310,7 @@ Default value: `%temp%/PackScan.PackagesProvider.Writer/DownloadCache`
 - **--add-project-file** | Overrides the project property **PackagesProviderGenerateProjectFile**.
 - **--load-mode** | Overwrites the default values of the following load-mode values. [Here](#content-load-mode), you will find the supported values. Default value: \<empty>
 - **--icon-load-mode** | Overrides the project property **PackagesProviderIconContentLoadMode**.
+- **--icon-max-size** | Specifies the maximum size in "\<width>x\<height>" format to which the icon should be resized.
 - **--license-load-mode** | Overrides the project property **PackagesProviderLicenseContentLoadMode**.
 - **--readme-load-mode** | Overrides the project property **PackagesProviderReadMeContentLoadMode**.
 - **--release-notes-load-mode** | Overrides the project property **PackagesProviderReleaseNotesContentLoadMode**.
@@ -352,6 +359,12 @@ If you would like to contribute code, please fork the repository and create a pu
 
 # ChangeLog
 
+## [v0.3.0 - 2023-11-13](https://github.com/loop8ack/PackScan/releases/tag/v0.3.0)
+### Added
+- PackScan.Tool parameter to specify the target framework for the project.
+- PackScan.Tool parameter to define the runtime identifier for the project.
+- Functionality to specify the maximum size for downloaded icons in "<width>x<height>" format.
+
 ## [v0.2.1 - 2023-11-06](https://github.com/loop8ack/PackScan/releases/tag/v0.2.1)
 ### Fixed
 - Resolved a bug that caused issues with specific platform versions, such as those used in MAUI projects.

build.ps1

@@ -0,0 +1,4 @@
+dotnet pack -o artifacts -c Release ./src/PackScan.Analyzer
+dotnet pack -o artifacts -c Release ./src/PackScan.Defaults
+dotnet pack -o artifacts -c Release ./src/PackScan.Tool
+dotnet pack -o artifacts -c Release ./src/PackScan.PackagesProvider.Abstractions

pack.ps1

@@ -1,11 +1,7 @@
 <Project>
 
   <PropertyGroup>
-    <PackageOutputPath>../../artifacts</PackageOutputPath>
-  </PropertyGroup>
-
-  <PropertyGroup>
-    <Version>0.2.1</Version>
+    <Version>0.3.0</Version>
     <Authors>Loop8ack</Authors>
     <PackageReadmeFile>ReadMe.md</PackageReadmeFile>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>

src/NuGet.Metadata.props

@@ -1,4 +1,5 @@
 using System.Collections.Immutable;
+using System.Drawing;
 
 using Microsoft.CodeAnalysis;
 
@@ -16,6 +17,7 @@ private enum Id
         OptionNotParsedEnum,
         OptionNoParsedBool,
         OptionNoParsedValue,
+        OptionNoParsedSize,
 
         // Licenses Analyzer
         LicenseNotAllowed = 200,
@@ -111,6 +113,23 @@ public static Diagnostic Create(string optionName, string value, string typeName
         }
     }
 
+    public static class OptionNotParsedSize
+    {
+        public static DiagnosticDescriptor Descriptor { get; }
+            = new DiagnosticDescriptor(
+                id: $"{Prefix}{(int)Id.OptionNoParsedSize:000}",
+                title: "Not supported value",
+                messageFormat: "Could not parse '{0}' value '{1}' as size. Supported format: <width>x<height>",
+                category: Category,
+                DiagnosticSeverity.Error,
+                isEnabledByDefault: true);
+
+        public static Diagnostic Create(string optionName, string value)
+        {
+            return Diagnostic.Create(Descriptor, Location.None, optionName, value);
+        }
+    }
+
     public static class LicenseNotAllowed
     {
         public static DiagnosticDescriptor Descriptor { get; }

src/PackScan.Analyzer/Core/Diagnostics.cs

@@ -1,5 +1,7 @@
 using Microsoft.CodeAnalysis.Diagnostics;
 
+using SixLabors.ImageSharp;
+
 namespace PackScan.Analyzer.Core.Options;
 
 internal static class AnalyzerConfigOptionsExtensions
@@ -49,6 +51,21 @@ public static OptionValue<TEnum> GetOptionEnum<TEnum>(this AnalyzerConfigOptions
         return new(name, Diagnostics.OptionNotFound.Create(name));
     }
 
+    public static OptionValue<Size?> GetOptionNullableSKSize(this AnalyzerConfigOptions options, string name)
+    {
+        if (options.TryGetValue(Prefix + name, out string? str))
+        {
+            if (string.IsNullOrEmpty(str))
+                return new(name, (Size?)null);
+
+            return Utils.TryParseImageSharpSize(str, out Size? value)
+                ? new(name, value)
+                : new(name, Diagnostics.OptionNotParsedSize.Create(name, str));
+        }
+
+        return new(name, (Size?)null);
+    }
+
     public static OptionValue<TValue> GetOptionValue<TValue>(this AnalyzerConfigOptions options, string name, string typeName, IReadOnlyDictionary<string, TValue> valueMapping)
     {
         if (options.TryGetValue(Prefix + name, out string? str))

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

@@ -11,6 +11,8 @@
 using PackScan.PackagesProvider.Generator.Info;
 using PackScan.PackagesReader.Abstractions;
 
+using SixLabors.ImageSharp;
+
 using CodeGenerator = PackScan.PackagesProvider.Generator.PackagesProviderGenerator;
 
 namespace PackScan.Analyzer.Core.Services;
@@ -27,6 +29,7 @@ internal record class PackagesProviderGeneratorService
     private OptionValue<bool> NullableAnnotations { get; set; }
     private OptionValue<bool> LoadContentParallel { get; set; }
     private OptionValue<ContentLoadMode> IconContentLoadMode { get; set; }
+    private OptionValue<Size?> IconContentMaxSize { get; set; }
     private OptionValue<ContentLoadMode> LicenseContentLoadMode { get; set; }
     private OptionValue<ContentLoadMode> ReadMeContentLoadMode { get; set; }
     private OptionValue<ContentLoadMode> ReleaseNotesContentLoadMode { get; set; }
@@ -43,6 +46,7 @@ public PackagesProviderGeneratorService(AnalyzerConfigOptions options)
         NullableAnnotations = options.GetOptionBool("PackagesProviderNullableAnnotations");
         LoadContentParallel = options.GetOptionBool("PackagesProviderLoadContentsParallel");
         IconContentLoadMode = options.GetOptionEnum<ContentLoadMode>("PackagesProviderIconContentLoadMode");
+        IconContentMaxSize = options.GetOptionNullableSKSize("PackagesProviderIconContentMaxSize");
         LicenseContentLoadMode = options.GetOptionEnum<ContentLoadMode>("PackagesProviderLicenseContentLoadMode");
         ReadMeContentLoadMode = options.GetOptionEnum<ContentLoadMode>("PackagesProviderReadMeContentLoadMode");
         ReleaseNotesContentLoadMode = options.GetOptionEnum<ContentLoadMode>("PackagesProviderReleaseNotesContentLoadMode");
@@ -79,6 +83,7 @@ private IReadOnlyList<Diagnostic> ValidateOptions()
         NullableAnnotations.Validate(diagnostics);
         LoadContentParallel.Validate(diagnostics);
         IconContentLoadMode.Validate(diagnostics);
+        IconContentMaxSize.Validate(diagnostics);
         LicenseContentLoadMode.Validate(diagnostics);
         ReadMeContentLoadMode.Validate(diagnostics);
         ReleaseNotesContentLoadMode.Validate(diagnostics);
@@ -101,6 +106,7 @@ private void CoreGenerate(SourceProductionContext context)
             GenerateProjectFile = false,
             ContentWriteMode = ContentWriteMode.InCode,
             IconContentLoadMode = IconContentLoadMode,
+            IconContentMaxSize = IconContentMaxSize,
             LicenseContentLoadMode = LicenseContentLoadMode,
             ReadMeContentLoadMode = ReadMeContentLoadMode,
             ReleaseNotesContentLoadMode = ReleaseNotesContentLoadMode,

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

@@ -1,5 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
+  <Import Project="..\PackScan.Shared\PackScan.Shared.projitems" Label="Shared" />
+
   <Import Project="../NuGet.Metadata.props" />
 
   <PropertyGroup>
@@ -9,6 +11,7 @@
     <DevelopmentDependency>true</DevelopmentDependency>
     <IsRoslynComponent>true</IsRoslynComponent>
     <NoWarn>$(NoWarn);NU5128</NoWarn>
+    <DefineConstants>$(DefineConstants);PackScan_Analyzer</DefineConstants>
   </PropertyGroup>
 
   <ItemGroup>

src/PackScan.Analyzer/PackScan.Analyzer.csproj

@@ -2,16 +2,16 @@
 
   <Import Project="$(MSBuildThisFileDirectory)\PackScan.Defaults.targets"
           Condition="Exists('$(MSBuildThisFileDirectory)\PackScan.Defaults.targets')"/>
-  
+
   <ItemGroup>
-    
+
     <!-- Core -->
     <CompilerVisibleProperty Include="Language" />
     <CompilerVisibleProperty Include="TargetFramework" />
     <CompilerVisibleProperty Include="RuntimeIdentifier" />
     <CompilerVisibleProperty Include="MSBuildProjectDirectory" />
     <CompilerVisibleProperty Include="BaseIntermediateOutputPath" />
-    
+
     <!-- Reader -->
     <CompilerVisibleProperty Include="_KnownPackageIds" />
 
@@ -36,7 +36,8 @@
     <CompilerVisibleProperty Include="PackagesProviderReleaseNotesContentLoadMode" />
     <CompilerVisibleProperty Include="PackagesProviderDownloadCacheFolder" />
     <CompilerVisibleProperty Include="PackagesProviderWorkingDirectory" />
+    <CompilerVisibleProperty Include="PackagesProviderIconContentMaxSize" />
 
   </ItemGroup>
-  
+
 </Project>