Peponi.SourceGenerators
1.0.2
dotnet add package Peponi.SourceGenerators --version 1.0.2
NuGet\Install-Package Peponi.SourceGenerators -Version 1.0.2
<PackageReference Include="Peponi.SourceGenerators" Version="1.0.2" />
paket add Peponi.SourceGenerators --version 1.0.2
#r "nuget: Peponi.SourceGenerators, 1.0.2"
// Install Peponi.SourceGenerators as a Cake Addin #addin nuget:?package=Peponi.SourceGenerators&version=1.0.2 // Install Peponi.SourceGenerators as a Cake Tool #tool nuget:?package=Peponi.SourceGenerators&version=1.0.2
Peponi.SourceGenerators
1. Instruction
- This package is under MIT License.
- GitHub : Peponi
- Blog : Peponi
- Instruction & API information is on following section
1.1. About Peponi.SourceGenerators
Peponi.SourceGenerators is a package for generating codes.
Including generators are:
1. ICommand
2. Object injection
3. Method caller in property
4. INotifyPropertyChanged
5. Property
6. Raise can execute
7. Raise property changed
8. gRPC Client
9. gRPC Server
1.1.1. Peponi.SourceGenerators license
The MIT License (MIT)
Copyright (c) 2024 peponi
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
1.1.2. Peponi.SourceGenerators install
NuGet\Install-Package Peponi.SourceGenerators
2. Peponi.SourceGenerators
2.1. NotifyInterface
- Description
This is an attribute that creating
INotifyPropertyChanged
automatically.Partial type declaration is required for using this attribute.
Supports
class
,record
,struct
.Input and generated code looks like followings:
// Input [NotifyInterface] public partial class CodeTest { }
// Generated public partial class CodeTest : INotifyPropertyChanged { public event PropertyChangedEventHandler? PropertyChanged; protected virtual void OnPropertyChanged(PropertyChangedEventArgs e) { PropertyChanged?.Invoke(this, e); } protected void OnPropertyChanged([CallerMemberName] string? propertyName = null) { OnPropertyChanged(new PropertyChangedEventArgs(propertyName)); } }
2.2. Property
Members
Type Name Description string? CustomName Sets the custom name of property NotifyType NotifyType Sets the property's notification type Description
This attribute creates a property using given field as backing field.
Partial type declaration is required for using this attribute.
By default, Notify type is
NotifyType.Notify
.Input and generated code looks like followings:
// Input public partial class CodeTest { [Property] private bool _testBool = false; }
// Generated public partial class CodeTest { public bool TestBool { get => _testBool; set { if(_testBool != value) { _testBool = value; OnPropertyChanged(nameof(TestBool)); OnTestBoolChanged(); } } } partial void OnTestBoolChanged(); }
User could change property's name and its notification type.
// Input public partial class CodeTest { [Property(CustomName = "MyProp", NotifyType = NotifyType.None)] private bool _testBool = false; }
// Generated public partial class CodeTest { public bool MyProp { get => _testBool; set { if(_testBool != value) { _testBool = value; OnMyPropChanged(); } } } partial void OnMyPropChanged(); }
Finally, user could use
Property
attribute like followings:// Input public partial class CodeTest { [Property(CustomName = "MyProp", NotifyType = NotifyType.None)] [MethodCall("MyMethod", Section = PropertySection.Getter, Args = "TestBool, FieldA")] [MethodCall("OtherMethod", Args = "TestBool, FieldB")] [RaiseCanExecuteChanged("TestCommand")] [RaisePropertyChanged("TestParam")] private bool _testBool = false; }
// Generated public partial class CodeTest { public bool MyProp { get { MyMethod(TestBool, FieldA); return _testBool; } set { if(_testBool != value) { _testBool = value; OnMyPropChanged(); OtherMethod(TestBool, FieldB); TestCommand.RaiseCanExecuteChanged(); OnPropertyChanged(nameof(TestParam)); } } } partial void OnMyPropChanged(); }
2.3. MethodCall
Members
Type Name Description PropertySection Section Determine where is method<br/> PropertySection.Setter
is defaultstring Name Name of method string? Args Sets arguments of the method Methods
Return type Name Description MethodCallAttribute MethodCall(string) Default constructor Description
Inject methods on getter or setter of property.
2.2. Property is required to use this attribute.
Input and generated code looks like followings:
// Input public partial class CodeTest { [Property] [MethodCall("MyMethod")] private bool _testBool = false; }
// Generated public partial class CodeTest { public bool TestBool { get { return _testBool; } set { if(_testBool != value) { _testBool = value; OnPropertyChanged(nameof(TestBool)); OnTestBoolChanged(); MyMethod(); } } } partial void OnTestBoolChanged(); }
As a result, user could use
MethodCall
attribute like followings:// Input public partial class CodeTest { [Property] [MethodCall("MyMethod", Section = PropertySection.Getter, Args = "TestBool, FieldA")] [MethodCall("OtherMethod", Args = "TestBool, FieldB")] private bool _testBool = false; }
// Generated public partial class CodeTest { public bool TestBool { get { MyMethod(TestBool, FieldA); return _testBool; } set { if(_testBool != value) { _testBool = value; OnPropertyChanged(nameof(TestBool)); OnTestBoolChanged(); OtherMethod(TestBool, FieldB); } } } partial void OnTestBoolChanged(); }
2.4. RaiseCanExecuteChanged
Members
Type Name Description string CommandName Command's name that will be raised Methods
Return type Name Description RaiseCanExecuteChangedAttribute RaiseCanExecuteChanged(string) Default constructor Description
This is an attribute for raising whether certain command could execute or not.
2.2. Property is required to use this attribute.
Generated property will call
ICommandBase.RaiseCanExecuteChanged
at setter.Input and generated code looks like followings:
// Input public partial class CodeTest { [Property] [RaiseCanExecuteChanged("TestCommand")] private bool _testBool = false; }
// Generated public partial class CodeTest { public bool TestBool { get => _testBool; set { if(_testBool != value) { _testBool = value; OnPropertyChanged(nameof(TestBool)); OnTestBoolChanged(); TestCommand.RaiseCanExecuteChanged(); } } } partial void OnTestBoolChanged(); }
2.5. RaisePropertyChanged
Members
Type Name Description string PropertyName Property's name that will be raised Methods
Return type Name Description RaisePropertyChangedAttribute RaisePropertyChanged(string) Default constructor Description
This is an attribute for raising
INotifyPropertyChanged.PropertyChanged
for other property.2.2. Property is required to use this attribute.
Generated property will call
INotifyPropertyChanged.PropertyChanged
at setter.Input and generated code looks like followings:
// Input public partial class CodeTest { [Property] [RaisePropertyChanged("TestParam")] private bool _testBool = false; }
// Generated public partial class CodeTest { public bool TestBool { get => _testBool; set { if(_testBool != value) { _testBool = value; OnPropertyChanged(nameof(TestBool)); OnTestBoolChanged(); OnPropertyChanged(nameof(TestParam)); } } } partial void OnTestBoolChanged(); }
2.6. Command
Members
Type Name Description string? CustomName Sets the name of command<br/>Basically, generated backing member's name is target method's name with "Command" suffix string? CanExecute Sets the name of member that will be invoked to check whether command could executed<br/>The member have to return bool value Description
Use this attribute for generating
ICommand
members.Partial type declaration is required for using this attribute.
Generated method's name has "Command" suffix.
Input and generated code looks like followings:
// Input - Sync public partial class CodeTest { [Command] private void Test() { return; } }
// Generated public partial class CodeTest { private CommandBase? _testCommand; public ICommandBase TestCommand => _testCommand ??= new CommandBase(Test); }
// Input - Async public partial class CodeTest { [Command] private async Task Test() { return; } }
// Generated public partial class CodeTest { private CommandBase? _testCommand; public ICommandBase TestCommand => _testCommand ??= new CommandBase(async () => { await Test(); }); }
As a result, user could use
Command
attribute like followings:// Input public partial class CodeTest { [Command(CustomName = "MyCommand", CanExecute = "CanExe")] private void Test(int a) { return; } private bool CanExe() { return true; } }
// Generated public partial class CodeTest { private CommandBase<int>? _testCommand; public ICommandBase MyCommand => _testCommand ??= new CommandBase<int>(Test, _ => CanExe()); }
2.7. Inject
Members
Type Name Description Type Type Sets the type will be injected<br/>Class, record, struct types are supported InjectionType InjectionMode Sets the injecting mode<br/>Supports<br/> InjectionType.Dependency
<br/>InjectionType.Model
<br/>InjectionType.Dependency \| InjectionType.Model
string? CustomName Sets the name of injecting target<br/>Basically, generated member's name is same as injecting target Modifier Modifier Sets the modifier of injecting target NotifyType PropertyNotifyMode Sets the notify mode of injected target's member<br/>This is valid for InjectionType.Model
Methods
Return type Name Description InjectAttribute Inject(Type, InjectionType) Default constructor Description
Use this attribute for injecting members by the selected object.
Partial type declaration is required for using this attribute.
Using multiple attributes is allowed.
Class, record, struct types are supported.
Input and generated code looks like followings:
// Input public class BaseClass { public int TestIng = 0; public bool TestBool = false; public List<string> TestList = new(); } [Inject(typeof(BaseClass), InjectionType.Dependency)] public partial class CodeTest { }
// Generated public partial class CodeTest { public global::GeneratorTest.BaseClass BaseClass; public CodeTest(global::GeneratorTest.BaseClass BaseClass) { this.BaseClass = BaseClass; } }
As a result, user could use
Inject
attribute like followings:// Input public class BaseClass { public int TestInt = 0; public bool TestBool = false; public List<string> TestList = new(); } public record BaseRecord { public float TestFloat = 0; public string TestString = string.Empty; public Dictionary<string, string> TestDic = new(); } public struct BaseStruct { public double TestDouble; public char TestChar; public long TestLong; } [Inject(typeof(BaseClass), InjectionType.Dependency)] [Inject(typeof(BaseRecord), InjectionType.Model, CustomName = "ChangedRecord", Modifier = Modifier.Internal)] [Inject(typeof(BaseStruct), InjectionType.Dependency | InjectionType.Model, PropertyNotifyMode = NotifyType.None)] public partial class CodeTest { }
// Generated public partial class CodeTest { public global::GeneratorTest.BaseClass BaseClass; internal global::GeneratorTest.BaseRecord ChangedRecord; public float TestFloat { get => ChangedRecord.TestFloat; set { if(ChangedRecord.TestFloat != value) { ChangedRecord.TestFloat = value; OnPropertyChanged(nameof(TestFloat)); OnTestFloatChanged(); } } } public string TestString { get => ChangedRecord.TestString; set { if(ChangedRecord.TestString != value) { ChangedRecord.TestString = value; OnPropertyChanged(nameof(TestString)); OnTestStringChanged(); } } } public Dictionary<string, string> TestDic { get => ChangedRecord.TestDic; set { if(ChangedRecord.TestDic != value) { ChangedRecord.TestDic = value; OnPropertyChanged(nameof(TestDic)); OnTestDicChanged(); } } } partial void OnTestFloatChanged(); partial void OnTestStringChanged(); partial void OnTestDicChanged(); public global::GeneratorTest.BaseStruct BaseStruct; public double TestDouble { get => BaseStruct.TestDouble; set { if(BaseStruct.TestDouble != value) { BaseStruct.TestDouble = value; OnTestDoubleChanged(); } } } public char TestChar { get => BaseStruct.TestChar; set { if(BaseStruct.TestChar != value) { BaseStruct.TestChar = value; OnTestCharChanged(); } } } public long TestLong { get => BaseStruct.TestLong; set { if(BaseStruct.TestLong != value) { BaseStruct.TestLong = value; OnTestLongChanged(); } } } partial void OnTestDoubleChanged(); partial void OnTestCharChanged(); partial void OnTestLongChanged(); public CodeTest(global::GeneratorTest.BaseClass BaseClass, global::GeneratorTest.BaseStruct BaseStruct) { this.BaseClass = BaseClass; this.BaseStruct = BaseStruct; } }
2.8. gRPC Client
Members
Type Name Description GrpcClientMode GrpcClientMode Sets the Client mode<br/>Supports<br/> GrpcClientMode.Standalone
<br/>GrpcClientMode.ClientFactory
string Remote Sets the name of channel ( GrpcClientMode.Standalone
) or Uri (GrpcClientMode.ClientFactory
)string ProtoRootPath Sets the root path of *.proto
filesMethods
Return type Name Description GrpcClientAttribute GrpcClient(GrpcClientMode, string, string) Default constructor Description
Use this attribute for creating gRPC services.
Partial type declaration is required for using this attribute.
gRPC client generator will find all
*.proto
files underProtoRootPath
Input and generated code looks like followings:
// Helloworld.proto in "C:\Study\Peponi\Peponi.SourceGenerators\Peponi.SourceGenerators.Tests\GrpcGenerator\" syntax = "proto3"; package HelloWorld; service HelloWorldCommunication { rpc HelloRequest(CommunicationMessage) returns (CommunicationMessage); } message CommunicationMessage { string Sender = 1; string Message = 2; }
GrpcClientMode.Standalone
// Input [GrpcClient(GrpcClientMode.Standalone, nameof(_channel), @"C:\Study\Peponi\Peponi.SourceGenerators\Peponi.SourceGenerators.Tests\GrpcGenerator")] public partial class CodeTest { Channel _channel; }
// Generated using Grpc.Core; using HelloWorld; namespace GeneratorTest { public partial class CodeTest { private HelloWorldCommunication.HelloWorldCommunicationClient _HelloWorldCommunication private bool CreateServices() { bool rtn = true; try { _HelloWorldCommunication = new HelloWorldCommunication.HelloWorldCommunicationClient(_channel); } catch { rtn = false; } return rtn; } } }
GrpcClientMode.ClientFactory
// Input [GrpcClient(GrpcClientMode.ClientFactory, "https://localhost:9091", @"C:\Study\Peponi\Peponi.SourceGenerators\Peponi.SourceGenerators.Tests\GrpcGenerator")] public partial class CodeTest { }
// Generated using Microsoft.Extensions.DependencyInjection; using HelloWorld; namespace GeneratorTest { public partial class CodeTest { private IServiceCollection AddClientsFactory(IServiceCollection services) { services .AddGrpcClient<HelloWorldCommunication.HelloWorldCommunicationClient>(o => { o.Address = new Uri("https://localhost:9091"); }) ; return services; } } }
As a result, user could use
GrpcClient
attribute like followings:// GrpcClientMode.Standalone [GrpcClient(GrpcClientMode.Standalone, nameof(_channel), @"C:\Study\Peponi\Peponi.SourceGenerators\Peponi.SourceGenerators.Tests\GrpcGenerator")] public partial class CodeTest { Channel _channel; public CodeTest() { if(CreateServices()) { _HelloWorldCommunication.HelloRequestAsync(new HelloWorld.CommunicationMessage { Sender = "Client", Message = "Hello world from client" }); } } }
// GrpcClientMode.ClientFactory [GrpcClient(GrpcClientMode.ClientFactory, "https://localhost:9091", @"C:\Study\Peponi\Peponi.SourceGenerators\Peponi.SourceGenerators.Tests\GrpcGenerator")] public partial class CodeTest { public void ConfigureServices(IServiceCollection services) { services.AddGrpc(); services = AddClientsFactory(services); } } public class SayHelloClass { readonly HelloWorldCommunication.HelloWorldCommunicationClient _client; public SayHelloClass(HelloWorldCommunication.HelloWorldCommunicationClient client) { _client = client; } public void SayHello() { var reply = _client.HelloRequest(new HelloWorld.CommunicationMessage { Sender = "Client", Message = "Hello world from client" }); } }
2.9. gRPC Server
Members
Type Name Description GrpcServerMode GrpcServerMode Sets the Server mode<br/>Supports<br/> GrpcServerMode.Standalone
<br/>GrpcServerMode.ClientFactory
Methods
Return type Name Description GrpcServerAttribute GrpcServer(GrpcServerMode) Default constructor Description
Use this attribute for mapping gRPC services.
Static class
GrpcServerMapper
will be generated in namespacePeponi.SourceGenerators.Grpc
.User could use
GetStandaloneServices()
orMapClientFactoryServices(IEndpointRouteBuilder)
inGrpcServerMapper
Input and generated code looks like followings:
// Generated by Protobuf compiler namespace ServerContext { public static partial class HelloWorld { public static ServerServiceDefinition BindService(HelloWorldBase base) { } public abstract partial class HelloWorldBase { } } }
GrpcServerMode.Standalone
// Input namespace GeneratorTest { [GrpcServer(GrpcServerMode.Standalone)] public class CodeTest : HelloWorld.HelloWorldBase { } }
// Generated using Grpc.Core; namespace Peponi.SourceGenerators.Grpc; public static partial class GrpcServerMapper { public static List<ServerServiceDefinition> GetStandaloneServices() { List<ServerServiceDefinition> rtns = new(); rtns.Add(global::ServerContext.HelloWorld.BindService(new global::GeneratorTest.CodeTest())); return rtns; } }
GrpcServerMode.ClientFactory
// Input namespace GeneratorTest { [GrpcServer(GrpcServerMode.ClientFactory)] public class CodeTest : HelloWorld.HelloWorldBase { } }
// Generated using Microsoft.AspNetCore.Routing; namespace Peponi.SourceGenerators.Grpc; public static partial class GrpcServerMapper { public static IEndpointRouteBuilder MapClientFactoryServices(IEndpointRouteBuilder builder) { builder.MapGrpcService<global::GeneratorTest.CodeTest>(); return builder; } }
As a result, user could use
GrpcServer
attribute like followings:// GrpcServerMode.Standalone using Peponi.SourceGenerators.Grpc; public class Program { private static void Main(string[] args) { var server = new Server() { Ports = { new ServerPort("localhost", 9091, ServerCredentials.Insecure) } }; GrpcServerMapper.GetStandaloneServices().ForEach(server.Services.Add); server.Start(); } }
// GrpcServerMode.ClientFactory using Peponi.SourceGenerators.Grpc; public class Program { private static void Main(string[] args) { CreateHostBuilder().Build().Run(); } private static IHostBuilder CreateHostBuilder() => Host.CreateDefaultBuilder() .ConfigureWebHostDefaults(webBuilder => { // Configure kestrel ... webBuilder.UseStartUp<StartUp>(); }); } public class StartUp { public void ConfigureServices(IServiceCollection services) { services.AddGrpc(); } public void Configure(IApplicationBuilder app, IWebHostEnvironment env) { // Configure settings ... app.UseEndpoints(endpoints => { endpoints = GrpcServerMapper.MapClientFactoryServices(endpoints); }); } }
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- No dependencies.
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version 1.0.2:
- Add package icon
Version 1.0.1:
- Fix comments error
Version 1.0.0:
- Initial upload