JKToolKit.TemplatePropertyGenerator 0.0.1

<p align="center"> <a> <picture> <source media="(prefers-color-scheme: dark)" srcset="assets/logo/logo_small_128x128.png"> <img src="assetss/logo/logo_small_128x128.png" height="128"> </picture> <h1 align="center">TemplatePropertyGenerator</h1> </a> </p>

<p align="center"> <a href="https://www.nuget.org/packages/JKToolKit.TemplatePropertyGenerator/"><img src="https://img.shields.io/nuget/v/JKToolKit.TemplatePropertyGenerator" alt="NuGet"></a> <a href="https://www.nuget.org/packages/JKToolKit.TemplatePropertyGenerator/"><img src="https://img.shields.io/nuget/dt/JKToolKit.TemplatePropertyGenerator" alt="Nuget"></a> <a href="LICENSE"><img src="https://img.shields.io/github/license/JKamsker/JKToolKit.TemplatePropertyGenerator" alt="License"></a> <a href="https://github.com/JKamsker/JKToolKit.TemplatePropertyGenerator/pulls"><img src="https://img.shields.io/badge/PR-Welcome-blue" alt="PR"></a> <a href="https://github.com/JKamsker/JKToolKit.TemplatePropertyGenerator/actions/workflows/build-test.yml"><img src="https://img.shields.io/github/actions/workflow/status/JKamsker/JKToolKit.TemplatePropertyGenerator/build-test.yml?branch=master" alt="GitHub Workflow Status"></a> </p>

Overview

TemplatePropertyGenerator is a C# source generator that creates strongly-typed template properties from annotated classes. This allows for easy and safe string formatting by generating classes with methods to format predefined templates.

Features

• Define template properties with format strings using attributes.
• Auto-generate classes with methods to format the strings.
• Supports FormattableString for more complex formatting needs.

How to Use

1. Install the NuGet package:

   Ensure you have the NuGet package installed in your project. If not, you can install it via the NuGet Package Manager or the .NET CLI.

    dotnet add package JKToolkit.TemplatePropertyGenerator
   

2. Define your templates:

   Use the TemplateProperty attribute to define your template properties in a partial class. The attribute takes the name of the property and the format string as parameters.

   [TemplateProperty("Hello", "Hello {value}, {value}!")]
   [TemplateProperty("FooBar", "Foo {value}, Bar {value}")]
   public static partial class Consts
   {
   }
   

3. Use the generated code:

   Once the generator runs, it will produce a class with properties and methods to format your strings. You can use these in your code as shown below:

   private static void Main(string[] args)
   {
       Console.WriteLine(Consts.Hello.Template); // Output: Hello {value}, {value}!
       Console.WriteLine(Consts.Hello.Format("World")); // Output: Hello World, World!
       Console.WriteLine(Consts.FooBar.Format("Foo1", "Bar1")); // Output: Foo Foo1, Bar Bar1
   }
   

Contributing

Contributions are welcome! Please feel free to submit a pull request or open an issue to discuss any changes or improvements.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgements

• Source Generators in .NET
• Microsoft Roslyn