Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/amis92/recordgenerator
C# immutable records generator
https://github.com/amis92/recordgenerator
amadevus code-generation code-generator csharp csharp-library dotnet immutability immutable nuget records roslyn-analyzer
Last synced: about 1 month ago
JSON representation
C# immutable records generator
- Host: GitHub
- URL: https://github.com/amis92/recordgenerator
- Owner: amis92
- License: mit
- Created: 2017-03-17T10:13:54.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-04-08T13:23:20.000Z (over 4 years ago)
- Last Synced: 2024-10-12T14:21:43.621Z (about 1 month ago)
- Topics: amadevus, code-generation, code-generator, csharp, csharp-library, dotnet, immutability, immutable, nuget, records, roslyn-analyzer
- Language: C#
- Homepage: https://amis92.github.io/RecordGenerator/
- Size: 1.06 MB
- Stars: 72
- Watchers: 9
- Forks: 10
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Amadevus.RecordGenerator
> ℹ This is for v0.6 of RecordGenerator.
Documentation available at [amis92.github.io/RecordGenerator](https://amis92.github.io/RecordGenerator) (or in [docs folder](docs/README.md)).
## Description
[Description]: #description
C# Record Generator makes creating **immutable** record types a breeze! Just adorn your data class with `[Record]` attribute
and keep your code clean and simple. The backing code is generated on build-time, including IntelliSense support
(just save the file, Visual Studio will make a build in background).
[](https://gitter.im/amis92/RecordGenerator?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://github.com/amis92/RecordGenerator/blob/master/LICENSE)
[](https://www.nuget.org/packages/Amadevus.RecordGenerator/)
[](https://www.nuget.org/packages/Amadevus.RecordGenerator/)
[](https://www.myget.org/feed/amadevus/package/nuget/Amadevus.RecordGenerator)
[](https://github.com/amis92/RecordGenerator/actions?query=workflow%3A%22.NET+Core+CI%22+branch%3Amaster)
[](https://dev.azure.com/amadevus/RecordGenerator/_build/latest?definitionId=1&branchName=master)
---
## Demo
Installation, usage, examples and all other docs available at [amis92.github.io/RecordGenerator](https://amis92.github.io/RecordGenerator)
```csharp
using System;
using Amadevus.RecordGenerator;
namespace QuickDemo
{
[Record(Features.Default | Features.Equality)]
public sealed partial class Contact
{
public int Id { get; }
public string Name { get; }
public string Email { get; }
public DateTime? Birthday { get; }
}
public static class Program
{
public static void Main()
{
var adam = new Contact.Builder
{
Id = 1,
Name = "Adam Demo",
Email = "[email protected]"
}.ToImmutable();
var adamWithBday = adam.WithBirthday(DateTime.UtcNow);
Console.WriteLine("Pretty display: " + adamWithBday);
// Pretty display: { Id = 1, Name = Adam Demo, Email = [email protected], Birthday = 06.01.2020 23:17:06 }
Console.WriteLine("Check equality: " + adam.Equals(adamWithBday));
// Check equality: False
Console.WriteLine("Check equality: " + adam.Equals(new Contact(1, "Adam Demo", "[email protected]", null)));
// Check equality: True
}
}
}
```
The above is taken from [QuickDemo sample](samples/QuickDemo/Program.cs)
## Development
[Development]: #development
To build the solution, .NET Core SDK v3.1.100 is required, as specified in [`global.json`](global.json).
## Credits
[Credits]: #credits
`Amadevus.RecordGenerator` wouldn't work if not for @AArnott [AArnott's CodeGeneration.Roslyn](https://github.com/AArnott/CodeGeneration.Roslyn).
Analyzers in `Amadevus.RecordGenerator.Analyzers` were inspired by [xUnit.net's analyzers](https://github.com/xunit/xunit.analyzers).
## Contributions
[Contributions]: #contributions
All contributions are welcome, as well as critique. If you have any issues, problems or suggestions -
please open an issue.
Visual Studio logo ™ Microsoft Corporation, used without permission.
RecordGenerator logo (on top) © 2017 Amadeusz Sadowski, all rights reserved.