Minerals.CodeBuilder
0.1.1
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package Minerals.CodeBuilder --version 0.1.1
NuGet\Install-Package Minerals.CodeBuilder -Version 0.1.1
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="Minerals.CodeBuilder" Version="0.1.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Minerals.CodeBuilder --version 0.1.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Minerals.CodeBuilder, 0.1.1"
#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 Minerals.CodeBuilder as a Cake Addin #addin nuget:?package=Minerals.CodeBuilder&version=0.1.1 // Install Minerals.CodeBuilder as a Cake Tool #tool nuget:?package=Minerals.CodeBuilder&version=0.1.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Minerals.CodeBuilder
This small package provides functionalities for source code generation with management of code indentation.
Features
- Writes lines and code blocks with automatic indentation management.
- Iterates over sequences and write code within each iteration.
- Creates custom logic for iteration elements.
- Implements conditional code generation based on boolean values.
- Adds standard auto-generated headers and attributes.
Installation
Add the Minerals.CodeBuilder nuget package to your C# project using the following methods:
1. Project file definition
<PackageReference Include="Minerals.CodeBuilder" Version="0.1.1" />
2. dotnet command
dotnet add package Minerals.CodeBuilder
Usage
Write, WriteLine, OpenBlock, CloseBlock
var builder = new Minerals.CodeBuilder(); // Default Parameters: (int indentationSize = 4, int indentationLevel = 0)
builder.Write("namespace ExampleNamespace").OpenBlock();
builder.WriteLine("public class ExampleClass").OpenBlock();
builder.WriteLine("public int[] ExampleArray = new int[] { 1, 2, 3, 4, 5 };");
builder.CloseBlock().CloseBlock();
// or
builder.CloseAllBlocks();
Iteration
var builder = new CodeBuilder();
IEnumerable<string> enumerable = ["int a = 0;", "int b = 1;", "int c = 2;", "int d = 3;", "int e = 4;"];
builder.Write("public class ExampleClass").OpenBlock();
builder.WriteIteration(enumerable);
builder.CloseBlock();
Custom Iteration
var builder = new CodeBuilder();
IEnumerable<string> enumerable = ["a = 0;", "b = 1;", "c = 2;", "d = 3;", "e = 4;"];
builder.Write("public class ExampleClass").OpenBlock();
builder.WriteIteration(enumerable, (builder1, item, next) =>
{
builder1.WriteLine("int ").Write(item);
});
builder.CloseBlock();
Inline Conditions
var builder = new CodeBuilder();
var success = true;
builder.If(success)?.WriteLine("private bool _success = true;");
Extensions
var builder = new CodeBuilder();
builder.AddAutoGeneratedHeader(Assembly.GetExecutingAssembly());
// Output:
// <auto-generated>
// This code was generated by a tool.
// Name: {{AssemblyTitle}}
// Version: {{AssemblyInformationalVersion}}
// </auto-generated>
var builder = new CodeBuilder();
builder.AddAutoGeneratedAttributes(typeof(ClassDeclarationSyntax));
builder.Write("public class ExampleClass { }");
// Output:
[global::System.Diagnostics.DebuggerNonUserCode]
[global::System.Runtime.CompilerServices.CompilerGenerated]
[global::System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
public class ExampleClass { }
Versioning
We use SemVer for versioning. For the versions available, see the branches on this repository.
Authors
- Szymon Hałucha - Maintainer
See also the list of contributors who participated in this project.
License
This project is licensed under the MIT License - see the LICENSE file for details.
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. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.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.
Fixed namespaces