JKToolKit.TemplatePropertyGenerator 0.0.3

There is a newer version of this package available.
See the version list below for details.

dotnet add package JKToolKit.TemplatePropertyGenerator --version 0.0.3

NuGet\Install-Package JKToolKit.TemplatePropertyGenerator -Version 0.0.3

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="JKToolKit.TemplatePropertyGenerator" Version="0.0.3" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add JKToolKit.TemplatePropertyGenerator --version 0.0.3

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: JKToolKit.TemplatePropertyGenerator, 0.0.3"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

// Install JKToolKit.TemplatePropertyGenerator as a Cake Addin
#addin nuget:?package=JKToolKit.TemplatePropertyGenerator&version=0.0.3

// Install JKToolKit.TemplatePropertyGenerator as a Cake Tool
#tool nuget:?package=JKToolKit.TemplatePropertyGenerator&version=0.0.3

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

<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>

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

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
```
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
{
}
```

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

There are no supported framework assets in this package.

Learn more about Target Frameworks and .NET Standard.

.NETStandard 2.0
- Microsoft.CodeAnalysis.CSharp.Workspaces (>= 4.9.2)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last updated
0.0.4	116	7/8/2024
0.0.3	104	7/7/2024
0.0.1	107	7/7/2024