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

[Feature] Add value sanitizers to [ObservableProperty]

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

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
25/100
Tipo de issue
Nueva funcionalidad
Claridad
Necesita aclaración
Estado de actividad
Estancado
Stack tecnológico
csharp
Área
tooling

Línea de trabajo

Comienza por el generador de código fuente [ObservableProperty] y su setter generado, usando los ejemplos de este issue como referencia de comportamiento. Primero resuelve la API de sanitizer, las operaciones compatibles y el alcance de setter/getter; se considera terminado cuando el diseño acordado admite los casos de sanitizer solicitados y las propiedades generadas los aplican correctamente.

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

Descripción

feature request :mailbox_with_mail:
Overview

In many of my properties I must Clamp, Round, Max or Min the setter value.
This auto defeats the [ObservableProperty] which make me implement the raw property.
Example:

public double TimeoutSeconds
{
    get;
    set => SetProperty(ref field, Math.Round(
        Math.Clamp(value, 0, 10000),
        2,
        MidpointRounding.AwayFromZero)
    );
} = 5000;

Example of what I would like:

[ObservableProperty]
[ObservablePropertySetterClamp(0, 10000)]
[ObservablePropertySetterRound(2, MidpointRounding.AwayFromZero)]
public partial double TimeoutSeconds { get; set; }
API breakdown

Not sure how to make the API but I provide a sample of generated code:

[global::System.CodeDom.Compiler.GeneratedCode("CommunityToolkit.Mvvm.SourceGenerators.ObservablePropertyGenerator", "8.4.0.0")]
[global::System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
public partial global::System.Double TimeoutSeconds
{
    get => field;
    set
    {
        // The new sanitizer magic here
        value = Math.Clamp(value, 0, 10000);
        value = Math.Round(value, 2, MidpointRounding.AwayFromZero);
        // End

        // Current implementation, unchanged.
        if (!global::System.Collections.Generic.EqualityComparer<global::System.Double>.Default.Equals(field, value))
        {
            OnLastExecutedDateTimeChanging(value);
            OnLastExecutedDateTimeChanging(default, value);
            field = value;
            OnLastExecutedDateTimeChanged(value);
            OnLastExecutedDateTimeChanged(default, value);
            OnPropertyChanged(global::CommunityToolkit.Mvvm.ComponentModel.__Internals.__KnownINotifyPropertyChangedArgs.LastExecutedDateTime);
        }
    }
}
Usage example
[ObservableProperty]
[ObservablePropertySetterClamp(0, 10000)]
[ObservablePropertySetterRound(2, MidpointRounding.AwayFromZero)]
public partial double TimeoutSeconds { get; set; }

[ObservableProperty]
[ObservablePropertySetterMin(0)]
public partial int LapCount { get; set; }

[ObservableProperty]
[ObservablePropertySetterStringTrim]
[ObservablePropertySetterStringUpperCase]
public partial string Country { get; set; }

[ObservableProperty]
[ObservablePropertySetterCustom(MyStaticSanitizerCallback)]
public partial string MySecretString { get; set; }
Breaking change?

No

Alternatives

The team can find a better way and/or names to do such, right now I don't see another alternative than using atributes.

Additional context
  • Also implement other sanitizers useful to other uses and types
  • If doing for setter we can also do for getter side?
Help us help you

Yes, I'd like to be assigned to work on this item

Lenguaje dominante
C#
Estrellas
3.8k
Forks
401
Sin PR fusionados en 30 d

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 CommunityToolkit/dotnet

Todos los issues de CommunityToolkit/dotnet

Issues similares

Más issues de C#

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.