Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

`Command` class violates design rule CA1010

Abierto
  • ¿Algo no está bien?
#2,751 1 comentario 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
45/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Estancado
Stack tecnológico
csharp
Área
cli

Línea de trabajo

Comienza en la declaración enlazada de src/System.CommandLine/Command.cs y reproduce CA1010 con AnalysisMode establecido en Recommended o All usando el ejemplo MyCommand. Se considera terminado cuando los comandos que heredan públicamente ya no emiten CA1010, manteniendo al mismo tiempo el comportamiento existente de los elementos secundarios de Command.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Summary

The System.CommandLine.Command class implements non-generic IEnumerable, but it does not implement IEnumerable<T>.

https://github.com/dotnet/command-line-api/blob/cf5fd8d696450a48d3cc75a7a1792d34b5303f88/src/System.CommandLine/Command.cs#L25

This causes classes inheriting from the Command class to violate design rule CA1010.
For projects with AnalysisMode set to Recommended or All, warning CA1010 will occur.

Build succeeded.

/home/smdn/temp/cli/Lib.cs(5,14): warning CA1010: Type 'MyCommand' directly or indirectly inherits 'IEnumerable' without implementing 'IEnumerable<T>'. Publicly-visible types should implement the generic version to broaden usability. (https://learn.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1010) [/home/smdn/temp/cli/cli.csproj]
    1 Warning(s)
    0 Error(s)

This simply triggers a warning and does not corrupt any functionality of System.CommandLine.
However, since the cause of the warning is not easy to find out and it may cause confusion, so I think this should be fixed.

Steps to reproduce

Set AnalysisMode to Recommended or All in the csproj file.

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

  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>net10.0</TargetFramework>
    <ImplicitUsings>enable</ImplicitUsings>
    <Nullable>enable</Nullable>

    <!-- Enable design rules including CA1010 -->
    <AnalysisMode>Recommended</AnalysisMode>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="System.CommandLine" Version="2.0.1" />
  </ItemGroup>

</Project>

Create a class that inherits from the Command class.

using System.CommandLine;

namespace MyLibrary;

// warning CA1010: Type 'MyCommand' directly or indirectly inherits 'IEnumerable' without implementing 'IEnumerable<T>'. Publicly-visible types should implement the generic version to broaden usability. (https://learn.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1010)
public class MyCommand(string name, string? description) : Command(name, description) { }

Workarounds

The following workarounds are available to avoid this warning.

Workaround 1: disable warning CA1010

#pragma warning disable CA1010
public class MyCommand(string name, string? description) : Command(name, description)
{
}
#pragma warning restore CA1010

Workaround 2: implement IEnumerator<Symbol>

public class MyCommand(string name, string? description) : Command(name, description)
{
    // Implement IEnumerator<Symbol> in order to suppress warning CA1010.
    public IEnumerator<Symbol> GetEnumerator() => Children.GetEnumerator();
}

Workaround 3: reduce AnalysisMode

    <!-- Reduce `AnalysisMode` to either `None`, `Default`, or `Minimum`. -->
    <AnalysisMode>Minimum</AnalysisMode>
Lenguaje dominante
C#
Estrellas
3.7k
Forks
434
Merge medio
6 h 27 min
PR fusionados (30 d)
2

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de dotnet/command-line-api

Todos los issues de dotnet/command-line-api

Issues similares

Más issues de C#

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.