https://github.com/HexaEngine/Hexa.NET.Protobuf

https://github.com/HexaEngine/Hexa.NET.Protobuf

codegenerator csharp protobuf roslyn-generator

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/HexaEngine/Hexa.NET.Protobuf
• Owner: HexaEngine
• License: mit
• Created: 2024-05-26T13:33:22.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-07-26T10:42:31.000Z (about 2 months ago)
• Last Synced: 2024-07-31T00:23:52.028Z (about 2 months ago)
• Topics: codegenerator, csharp, protobuf, roslyn-generator
• Language: C#
• Homepage:
• Size: 24.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• RSCG_Examples - Hexa.Protobuf

README

        
# Hexa.Protobuf

`Hexa.Protobuf` is a powerful inline code generator for Protobuf (work in progress), designed to work via Roslyn analyzers. It enables seamless generation and integration of Protobuf serialization code directly in your .NET projects, enhancing build-time type checking and reducing runtime errors. The library targets `netstandard2.0`, ensuring broad compatibility across different .NET implementations.

## Features

- **Inline Code Generation:** Generates Protobuf serialization code directly within your codebase without the need for external scripts or tools.

- **Build-Time Analysis:** Leverages Roslyn analyzers to provide immediate feedback on potential serialization issues at compile time.

- **Easy Integration:** Works out of the box with existing .NET projects using Protobuf, with minimal setup required.

- **Customizable:** Offers options to customize code generation to fit different project needs and constraints.

## Getting Started

### Prerequisites

Ensure you have the following installed:

- .NET SDK supporting `netstandard2.0` (e.g., .NET Core 2.0 or later, .NET Framework 4.6.1 or later)

- An IDE that supports Roslyn analyzers (e.g., Visual Studio, Visual Studio Code with OmniSharp)

### Installation

To install `Hexa.Protobuf`, add the NuGet package to your project:

```bash

dotnet add package Hexa.Protobuf