PrismCommands.Fody 1.0.6

PrismCommands.Fody

PrismCommands.Fody is a Fody plugin that provides a simple way to replace methods with Prism DelegateCommand properties at compile time.

This is useful when using the Prism library to build applications with the Model-View-ViewModel (MVVM) architecture. DelegateCommand is a class provided by Prism that implements the ICommand interface and allows you to bind a command from the view to a method in the view model.

Installation

1. Install the PrismCommands.Fody NuGet package in your project.
2. Add <PrismCommands /> to your FodyWeavers.xml file in the project's root directory. This step is necessary for Fody to enable the PrismCommands.Fody plugin during the build process.
3. Add a [DelegateCommand] attribute to any method in your code that you want to replace with a DelegateCommand property.
4. Build your project. The methods with the [DelegateCommand] attribute will be replaced with DelegateCommand properties.

Example

public class MyViewModel
{
    [DelegateCommand]
    public void DoSomething()
    {
        // Do something here.
    }

    [DelegateCommand]
    public void DoSomethingWithArg(string arg)
    {
        // Do something with arg here.
    }
}

After building, each method marked with the [DelegateCommand] attribute will be replaced with a corresponding DelegateCommand property named using the "{MethodName}Command" pattern.

For example, if you have a MyViewModel class with methods named DoSomething and DoSomethingWithArg marked with the [DelegateCommand] attribute, after building, these methods will be replaced with properties named DoSomethingCommand and DoSomethingWithArgCommand.

public class MyViewModel
{
    public DelegateCommand DoSomethingCommand { get; }
    public DelegateCommand<string> DoSomethingWithArgCommand { get; }

    public MyViewModel()
    {
        DoSomethingCommand = new DelegateCommand(DoSomething);
        DoSomethingWithArgCommand = new DelegateCommand<string>(DoSomethingWithArg);
    }

    private void DoSomething()
    {
        // Do something here.
    }

    private void DoSomethingWithArg(string arg)
    {
        // Do something with arg here.
    }
}

Thus, you can use the DoSomethingCommand and DoSomethingWithArgCommand properties to bind the commands to the view.

Note that if you have a method with a name that matches the property name created by PrismCommands.Fody, this can lead to conflicts and build errors. To avoid this, avoid using strings in method names that match the "Command" string.

How it works

PrismCommands.Fody uses the Mono.Cecil library to modify the assembly at compile time. It scans the assembly for methods with the [DelegateCommand] attribute and replaces them with DelegateCommand properties.

The implementation details can be found in the ModuleWeaver class.

Contributing

Contributions are welcome! If you find a bug or have a feature request, please open an issue. If you want to contribute code, please fork the repository and submit a pull request.

License

PrismCommands.Fody is licensed under the MIT License.

Contributors

The following individuals have contributed to the development and maintenance of PrismCommands.Fody:

• Vitaly Kuzyaev (@vitkuz573): Developer of the plugin. Implemented the core functionality of the plugin, wrote the initial codebase, and provided ongoing maintenance and support.
• OpenAI ChatGPT (@openai/chatgpt): Provided assistance with code development and readme composition. Helped with code review, testing, and provided feedback and suggestions for improving the documentation and user experience.