Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions Directory.Packages.props
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
</PropertyGroup>
<ItemGroup>
<PackageVersion Include="BenchmarkDotNet" Version="0.15.8" />
<PackageVersion Include="Microsoft.CodeAnalysis.CSharp" Version="4.8.0" />
<PackageVersion Include="Microsoft.CodeAnalysis.CSharp.Workspaces" Version="4.8.0" />
<PackageVersion Include="Microsoft.CodeAnalysis.CSharp.Analyzer.Testing.XUnit" Version="1.1.2" />
<PackageVersion Include="Serde" Version="0.9.1" />
<PackageVersion Include="Spectre.Console" Version="0.54.0" />
<PackageVersion Include="StaticCs" Version="0.3.1" />
Expand Down
2 changes: 1 addition & 1 deletion bench/bench.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
</PropertyGroup>

<ItemGroup>
<ProjectReference Include="..\src\Serde.CmdLine.csproj" />
<ProjectReference Include="..\src\Serde.CmdLine\Serde.CmdLine.csproj" />
</ItemGroup>

<ItemGroup>
Expand Down
88 changes: 59 additions & 29 deletions cmdline.sln
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,19 @@ Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio Version 17
VisualStudioVersion = 17.0.31903.59
MinimumVisualStudioVersion = 10.0.40219.1
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "bench", "bench\bench.csproj", "{B16C946A-F5BA-47B7-A751-79EAEEE0296D}"
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{827E0CD3-B72D-47B6-A68D-7590B98EB39B}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Serde.CmdLine", "src\Serde.CmdLine.csproj", "{36E277D7-EA89-4A06-8AC2-A931C90347B5}"
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Serde.CmdLine", "src\Serde.CmdLine\Serde.CmdLine.csproj", "{DB38D678-1389-4C18-9BE2-D745C708FCCF}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Serde.CmdLine.Analyzers", "src\Serde.CmdLine.Analyzers\Serde.CmdLine.Analyzers.csproj", "{D8BA4FB3-519B-4D42-9803-CD775BEF29FD}"
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "test", "test", "{0C88DD14-F956-CE84-757C-A364CCF449FC}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Serde.CmdLine.Test", "test\Serde.CmdLine.Test.csproj", "{40480398-EDF1-4893-8491-3C47792F1608}"
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Serde.CmdLine.Test", "test\Serde.CmdLine.Test\Serde.CmdLine.Test.csproj", "{EC640983-252D-404F-9D36-52DDC421DBEF}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "bench", "bench\bench.csproj", "{B16C946A-F5BA-47B7-A751-79EAEEE0296D}"
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Serde.CmdLine.Analyzers.Test", "test\Serde.CmdLine.Analyzers.Test\Serde.CmdLine.Analyzers.Test.csproj", "{828B11A8-D042-4D5F-B9BE-208AFF11C437}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Expand All @@ -23,30 +27,6 @@ Global
Release|x86 = Release|x86
EndGlobalSection
GlobalSection(ProjectConfigurationPlatforms) = postSolution
{36E277D7-EA89-4A06-8AC2-A931C90347B5}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{36E277D7-EA89-4A06-8AC2-A931C90347B5}.Debug|Any CPU.Build.0 = Debug|Any CPU
{36E277D7-EA89-4A06-8AC2-A931C90347B5}.Debug|x64.ActiveCfg = Debug|Any CPU
{36E277D7-EA89-4A06-8AC2-A931C90347B5}.Debug|x64.Build.0 = Debug|Any CPU
{36E277D7-EA89-4A06-8AC2-A931C90347B5}.Debug|x86.ActiveCfg = Debug|Any CPU
{36E277D7-EA89-4A06-8AC2-A931C90347B5}.Debug|x86.Build.0 = Debug|Any CPU
{36E277D7-EA89-4A06-8AC2-A931C90347B5}.Release|Any CPU.ActiveCfg = Release|Any CPU
{36E277D7-EA89-4A06-8AC2-A931C90347B5}.Release|Any CPU.Build.0 = Release|Any CPU
{36E277D7-EA89-4A06-8AC2-A931C90347B5}.Release|x64.ActiveCfg = Release|Any CPU
{36E277D7-EA89-4A06-8AC2-A931C90347B5}.Release|x64.Build.0 = Release|Any CPU
{36E277D7-EA89-4A06-8AC2-A931C90347B5}.Release|x86.ActiveCfg = Release|Any CPU
{36E277D7-EA89-4A06-8AC2-A931C90347B5}.Release|x86.Build.0 = Release|Any CPU
{40480398-EDF1-4893-8491-3C47792F1608}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{40480398-EDF1-4893-8491-3C47792F1608}.Debug|Any CPU.Build.0 = Debug|Any CPU
{40480398-EDF1-4893-8491-3C47792F1608}.Debug|x64.ActiveCfg = Debug|Any CPU
{40480398-EDF1-4893-8491-3C47792F1608}.Debug|x64.Build.0 = Debug|Any CPU
{40480398-EDF1-4893-8491-3C47792F1608}.Debug|x86.ActiveCfg = Debug|Any CPU
{40480398-EDF1-4893-8491-3C47792F1608}.Debug|x86.Build.0 = Debug|Any CPU
{40480398-EDF1-4893-8491-3C47792F1608}.Release|Any CPU.ActiveCfg = Release|Any CPU
{40480398-EDF1-4893-8491-3C47792F1608}.Release|Any CPU.Build.0 = Release|Any CPU
{40480398-EDF1-4893-8491-3C47792F1608}.Release|x64.ActiveCfg = Release|Any CPU
{40480398-EDF1-4893-8491-3C47792F1608}.Release|x64.Build.0 = Release|Any CPU
{40480398-EDF1-4893-8491-3C47792F1608}.Release|x86.ActiveCfg = Release|Any CPU
{40480398-EDF1-4893-8491-3C47792F1608}.Release|x86.Build.0 = Release|Any CPU
{B16C946A-F5BA-47B7-A751-79EAEEE0296D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{B16C946A-F5BA-47B7-A751-79EAEEE0296D}.Debug|Any CPU.Build.0 = Debug|Any CPU
{B16C946A-F5BA-47B7-A751-79EAEEE0296D}.Debug|x64.ActiveCfg = Debug|Any CPU
Expand All @@ -59,12 +39,62 @@ Global
{B16C946A-F5BA-47B7-A751-79EAEEE0296D}.Release|x64.Build.0 = Release|Any CPU
{B16C946A-F5BA-47B7-A751-79EAEEE0296D}.Release|x86.ActiveCfg = Release|Any CPU
{B16C946A-F5BA-47B7-A751-79EAEEE0296D}.Release|x86.Build.0 = Release|Any CPU
{DB38D678-1389-4C18-9BE2-D745C708FCCF}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{DB38D678-1389-4C18-9BE2-D745C708FCCF}.Debug|Any CPU.Build.0 = Debug|Any CPU
{DB38D678-1389-4C18-9BE2-D745C708FCCF}.Debug|x64.ActiveCfg = Debug|Any CPU
{DB38D678-1389-4C18-9BE2-D745C708FCCF}.Debug|x64.Build.0 = Debug|Any CPU
{DB38D678-1389-4C18-9BE2-D745C708FCCF}.Debug|x86.ActiveCfg = Debug|Any CPU
{DB38D678-1389-4C18-9BE2-D745C708FCCF}.Debug|x86.Build.0 = Debug|Any CPU
{DB38D678-1389-4C18-9BE2-D745C708FCCF}.Release|Any CPU.ActiveCfg = Release|Any CPU
{DB38D678-1389-4C18-9BE2-D745C708FCCF}.Release|Any CPU.Build.0 = Release|Any CPU
{DB38D678-1389-4C18-9BE2-D745C708FCCF}.Release|x64.ActiveCfg = Release|Any CPU
{DB38D678-1389-4C18-9BE2-D745C708FCCF}.Release|x64.Build.0 = Release|Any CPU
{DB38D678-1389-4C18-9BE2-D745C708FCCF}.Release|x86.ActiveCfg = Release|Any CPU
{DB38D678-1389-4C18-9BE2-D745C708FCCF}.Release|x86.Build.0 = Release|Any CPU
{D8BA4FB3-519B-4D42-9803-CD775BEF29FD}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{D8BA4FB3-519B-4D42-9803-CD775BEF29FD}.Debug|Any CPU.Build.0 = Debug|Any CPU
{D8BA4FB3-519B-4D42-9803-CD775BEF29FD}.Debug|x64.ActiveCfg = Debug|Any CPU
{D8BA4FB3-519B-4D42-9803-CD775BEF29FD}.Debug|x64.Build.0 = Debug|Any CPU
{D8BA4FB3-519B-4D42-9803-CD775BEF29FD}.Debug|x86.ActiveCfg = Debug|Any CPU
{D8BA4FB3-519B-4D42-9803-CD775BEF29FD}.Debug|x86.Build.0 = Debug|Any CPU
{D8BA4FB3-519B-4D42-9803-CD775BEF29FD}.Release|Any CPU.ActiveCfg = Release|Any CPU
{D8BA4FB3-519B-4D42-9803-CD775BEF29FD}.Release|Any CPU.Build.0 = Release|Any CPU
{D8BA4FB3-519B-4D42-9803-CD775BEF29FD}.Release|x64.ActiveCfg = Release|Any CPU
{D8BA4FB3-519B-4D42-9803-CD775BEF29FD}.Release|x64.Build.0 = Release|Any CPU
{D8BA4FB3-519B-4D42-9803-CD775BEF29FD}.Release|x86.ActiveCfg = Release|Any CPU
{D8BA4FB3-519B-4D42-9803-CD775BEF29FD}.Release|x86.Build.0 = Release|Any CPU
{EC640983-252D-404F-9D36-52DDC421DBEF}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{EC640983-252D-404F-9D36-52DDC421DBEF}.Debug|Any CPU.Build.0 = Debug|Any CPU
{EC640983-252D-404F-9D36-52DDC421DBEF}.Debug|x64.ActiveCfg = Debug|Any CPU
{EC640983-252D-404F-9D36-52DDC421DBEF}.Debug|x64.Build.0 = Debug|Any CPU
{EC640983-252D-404F-9D36-52DDC421DBEF}.Debug|x86.ActiveCfg = Debug|Any CPU
{EC640983-252D-404F-9D36-52DDC421DBEF}.Debug|x86.Build.0 = Debug|Any CPU
{EC640983-252D-404F-9D36-52DDC421DBEF}.Release|Any CPU.ActiveCfg = Release|Any CPU
{EC640983-252D-404F-9D36-52DDC421DBEF}.Release|Any CPU.Build.0 = Release|Any CPU
{EC640983-252D-404F-9D36-52DDC421DBEF}.Release|x64.ActiveCfg = Release|Any CPU
{EC640983-252D-404F-9D36-52DDC421DBEF}.Release|x64.Build.0 = Release|Any CPU
{EC640983-252D-404F-9D36-52DDC421DBEF}.Release|x86.ActiveCfg = Release|Any CPU
{EC640983-252D-404F-9D36-52DDC421DBEF}.Release|x86.Build.0 = Release|Any CPU
{828B11A8-D042-4D5F-B9BE-208AFF11C437}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{828B11A8-D042-4D5F-B9BE-208AFF11C437}.Debug|Any CPU.Build.0 = Debug|Any CPU
{828B11A8-D042-4D5F-B9BE-208AFF11C437}.Debug|x64.ActiveCfg = Debug|Any CPU
{828B11A8-D042-4D5F-B9BE-208AFF11C437}.Debug|x64.Build.0 = Debug|Any CPU
{828B11A8-D042-4D5F-B9BE-208AFF11C437}.Debug|x86.ActiveCfg = Debug|Any CPU
{828B11A8-D042-4D5F-B9BE-208AFF11C437}.Debug|x86.Build.0 = Debug|Any CPU
{828B11A8-D042-4D5F-B9BE-208AFF11C437}.Release|Any CPU.ActiveCfg = Release|Any CPU
{828B11A8-D042-4D5F-B9BE-208AFF11C437}.Release|Any CPU.Build.0 = Release|Any CPU
{828B11A8-D042-4D5F-B9BE-208AFF11C437}.Release|x64.ActiveCfg = Release|Any CPU
{828B11A8-D042-4D5F-B9BE-208AFF11C437}.Release|x64.Build.0 = Release|Any CPU
{828B11A8-D042-4D5F-B9BE-208AFF11C437}.Release|x86.ActiveCfg = Release|Any CPU
{828B11A8-D042-4D5F-B9BE-208AFF11C437}.Release|x86.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
EndGlobalSection
GlobalSection(NestedProjects) = preSolution
{36E277D7-EA89-4A06-8AC2-A931C90347B5} = {827E0CD3-B72D-47B6-A68D-7590B98EB39B}
{40480398-EDF1-4893-8491-3C47792F1608} = {0C88DD14-F956-CE84-757C-A364CCF449FC}
{DB38D678-1389-4C18-9BE2-D745C708FCCF} = {827E0CD3-B72D-47B6-A68D-7590B98EB39B}
{D8BA4FB3-519B-4D42-9803-CD775BEF29FD} = {827E0CD3-B72D-47B6-A68D-7590B98EB39B}
{EC640983-252D-404F-9D36-52DDC421DBEF} = {0C88DD14-F956-CE84-757C-A364CCF449FC}
{828B11A8-D042-4D5F-B9BE-208AFF11C437} = {0C88DD14-F956-CE84-757C-A364CCF449FC}
EndGlobalSection
EndGlobal
3 changes: 3 additions & 0 deletions src/Serde.CmdLine.Analyzers/AnalyzerReleases.Shipped.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
; Shipped analyzer releases
; https://github.com/dotnet/roslyn-analyzers/blob/main/src/Microsoft.CodeAnalysis.Analyzers/ReleaseTrackingAnalyzers.Help.md

8 changes: 8 additions & 0 deletions src/Serde.CmdLine.Analyzers/AnalyzerReleases.Unshipped.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
; Unshipped analyzer releases
; https://github.com/dotnet/roslyn-analyzers/blob/main/src/Microsoft.CodeAnalysis.Analyzers/ReleaseTrackingAnalyzers.Help.md

### New Rules

Rule ID | Category | Severity | Notes
--------|----------|----------|-------
SERDECMD001 | Design | Error | CommandParameterAndGroupAnalyzer, [Documentation](https://github.com/serdedotnet/cmdline)
80 changes: 80 additions & 0 deletions src/Serde.CmdLine.Analyzers/CommandParameterAndGroupAnalyzer.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
using System.Collections.Immutable;
using System.Linq;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.Diagnostics;

namespace Serde.CmdLine.Analyzers;

[DiagnosticAnalyzer(LanguageNames.CSharp)]
public sealed class CommandParameterAndGroupAnalyzer : DiagnosticAnalyzer
{
public const string DiagnosticId = "SERDECMD001";

private static readonly LocalizableString Title =
"CommandParameter and CommandGroup cannot be used together";

private static readonly LocalizableString MessageFormat =
"Type '{0}' has both [CommandParameter] and [CommandGroup] attributes. These cannot be combined on the same type.";

private static readonly LocalizableString Description =
"A command type cannot have both positional parameters and subcommands. Move parameters to the subcommand types instead.";

private const string Category = "Design";

private static readonly DiagnosticDescriptor Rule = new DiagnosticDescriptor(
DiagnosticId,
Title,
MessageFormat,
Category,
DiagnosticSeverity.Error,
isEnabledByDefault: true,
description: Description);

public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics =>
ImmutableArray.Create(Rule);

public override void Initialize(AnalysisContext context)
{
context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None);
context.EnableConcurrentExecution();

context.RegisterSymbolAction(AnalyzeNamedType, SymbolKind.NamedType);
}

private static void AnalyzeNamedType(SymbolAnalysisContext context)
{
var namedType = (INamedTypeSymbol)context.Symbol;

bool hasCommandParameter = false;
bool hasCommandGroup = false;

foreach (var member in namedType.GetMembers())
{
if (!(member is IPropertySymbol || member is IFieldSymbol))
continue;

foreach (var attribute in member.GetAttributes())
{
var attrName = attribute.AttributeClass?.Name;

if (attrName == "CommandParameterAttribute" || attrName == "CommandParameter")
{
hasCommandParameter = true;
}
else if (attrName == "CommandGroupAttribute" || attrName == "CommandGroup")
{
hasCommandGroup = true;
}
}
}

if (hasCommandParameter && hasCommandGroup)
{
// Report on the type itself
var location = namedType.Locations.Length > 0 ? namedType.Locations[0] : Location.None;
var diagnostic = Diagnostic.Create(Rule, location, namedType.Name);

context.ReportDiagnostic(diagnostic);
}
}
}
21 changes: 21 additions & 0 deletions src/Serde.CmdLine.Analyzers/Serde.CmdLine.Analyzers.csproj
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFramework>netstandard2.0</TargetFramework>
<RootNamespace>Serde.CmdLine.Analyzers</RootNamespace>
<Nullable>enable</Nullable>
<LangVersion>latest</LangVersion>
<EnforceExtendedAnalyzerRules>true</EnforceExtendedAnalyzerRules>
<IsRoslynComponent>true</IsRoslynComponent>
</PropertyGroup>

<ItemGroup>
<PackageReference Include="Microsoft.CodeAnalysis.CSharp" PrivateAssets="all" />
</ItemGroup>

<ItemGroup>
<AdditionalFiles Include="AnalyzerReleases.Shipped.md" />
<AdditionalFiles Include="AnalyzerReleases.Unshipped.md" />
</ItemGroup>

</Project>
File renamed without changes.
4 changes: 2 additions & 2 deletions src/CmdLine.cs → src/Serde.CmdLine/CmdLine.cs
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ public sealed record Help(IReadOnlyList<ISerdeInfo> HelpInfos) : ParsedArgsOrHel
public static ParsedArgsOrHelpInfos<T> ParseRawWithHelp<T>(string[] args)
where T : IDeserializeProvider<T>
{
var deserializer = new Deserializer(args, handleHelp: true);
using var deserializer = new Deserializer(args, handleHelp: true);
try
{
var cmd = T.Instance.Deserialize(deserializer);
Expand Down Expand Up @@ -54,9 +54,9 @@ public static ParsedArgsOrHelpInfos<T> ParseRawWithHelp<T>(string[] args)
/// </summary>
public static T ParseRaw<T>(string[] args) where T : IDeserializeProvider<T>
{
var deserializer = new Deserializer(args, handleHelp: false);
try
{
using var deserializer = new Deserializer(args, handleHelp: false);
return T.Instance.Deserialize(deserializer);
}
catch (DeserializeException e)
Expand Down
Loading