NuExt.Minimal.Mvvm.SourceGenerator

NuExt.Minimal.Mvvm.SourceGenerator is an extension for the lightweight MVVM framework NuExt.Minimal.Mvvm. This package includes a source generator that produces boilerplate code for your ViewModels at compile time, simplifying development and reducing routine work. By automating repetitive tasks, it helps you focus on implementing application-specific logic.

Features

• Automatically generates boilerplate code for ViewModels:
  • Generates properties with notification change support.
  • Creates command properties for appropriate methods.
  • Generates static localization classes from JSON files.
• Simplifies the development process by reducing repetitive coding tasks.
• Seamlessly integrates with the NuExt.Minimal.Mvvm framework.
• Enhances maintainability and readability of your codebase.

Commonly Used Types

• Minimal.Mvvm.NotifyAttribute: Generates a property for a backing field or a command for a method.
• Minimal.Mvvm.AlsoNotifyAttribute: Notifies additional properties when the annotated property changes.
• Minimal.Mvvm.LocalizeAttribute: Localizes the target class using the provided JSON file.
• Minimal.Mvvm.CustomAttributeAttribute: Specifies a fully qualified attribute name to be applied to a generated property.

Installation

You can install NuExt.Minimal.Mvvm.SourceGenerator via NuGet:

dotnet add package NuExt.Minimal.Mvvm.SourceGenerator

Or through the Visual Studio package manager:

1. Go to Tools -> NuGet Package Manager -> Manage NuGet Packages for Solution....
2. Search for NuExt.Minimal.Mvvm.SourceGenerator.
3. Click "Install".

Dependencies

To use this source generator effectively, you need to have any of these packages installed in your project: NuExt.Minimal.Mvvm, NuExt.Minimal.Mvvm.Windows, or NuExt.Minimal.Mvvm.MahApps.Metro. You can add them via NuGet as well:

For the base MVVM framework:

dotnet add package NuExt.Minimal.Mvvm

For Windows-specific extensions:

dotnet add package NuExt.Minimal.Mvvm.Windows

For MahApps.Metro integration:

dotnet add package NuExt.Minimal.Mvvm.MahApps.Metro

Usage Examples

Example using auto-generated property notifications

Given a user class such as:

using Minimal.Mvvm;
using System.Threading.Tasks;

public partial class PersonModel : BindableBase
{
    [Notify, AlsoNotify(nameof(FullName))]
    private string? _name;

    [Notify, AlsoNotify(nameof(FullName))]
    private string? _surname;

    [Notify, AlsoNotify(nameof(FullName))]
    private string? _middleName;

    public string FullName => $"{Surname} {Name} {MiddleName}";

    /// <summary>
    /// Shows information.
    /// </summary>
    [Notify("ShowInfoCommand", Setter = AccessModifier.Private)]
    [CustomAttribute("System.Text.Json.Serialization.JsonIgnore")]
    private async Task ShowAsync(string fullName)
    {
        await Task.Delay(1000);
    }
}

The generator could produce the following:

partial class PersonModel
{
    public string? Name
    {
        get => _name;
        set
        {
            if (SetProperty(ref _name, value))
            {
                RaisePropertyChanged("FullName");
            }
        }
    }

    public string? Surname
    {
        get => _surname;
        set
        {
            if (SetProperty(ref _surname, value))
            {
                RaisePropertyChanged("FullName");
            }
        }
    }

    public string? MiddleName
    {
        get => _middleName;
        set
        {
            if (SetProperty(ref _middleName, value))
            {
                RaisePropertyChanged("FullName");
            }
        }
    }

    private IAsyncCommand<string>? _showInfoCommand;
    /// <summary>
    /// Shows information.
    /// </summary>
    [System.Text.Json.Serialization.JsonIgnore]
    public IAsyncCommand<string>? ShowInfoCommand
    {
        get => _showInfoCommand;
        private set => SetProperty(ref _showInfoCommand, value);
    }
}

This example demonstrates how the source generator automatically creates properties with notification changes for fields and methods marked with the [Notify] attribute, thereby reducing boilerplate code.

Contributing

Contributions are welcome! Feel free to submit issues, fork the repository, and send pull requests. Your feedback and suggestions for improvement are highly appreciated.

License

Licensed under the MIT License. See the LICENSE file for details.