https://github.com/kinneko-de/sample-protobuf-tutorial-styleguide

Template repository with samples of most things that can go wrong with protobuf. Can be used to evaluate protobuf code editor and to train the style guide.
https://github.com/kinneko-de/sample-protobuf-tutorial-styleguide

format lint protobuf protocol-buffers styleguide styleguide-protobuf styleguides template tutorial

Last synced: 2 months ago
JSON representation

Template repository with samples of most things that can go wrong with protobuf. Can be used to evaluate protobuf code editor and to train the style guide.

• Host: GitHub
• URL: https://github.com/kinneko-de/sample-protobuf-tutorial-styleguide
• Owner: KinNeko-De
• License: mit
• Created: 2024-12-05T20:38:19.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-12-29T20:09:12.000Z (over 1 year ago)
• Last Synced: 2025-06-14T11:43:30.739Z (10 months ago)
• Topics: format, lint, protobuf, protocol-buffers, styleguide, styleguide-protobuf, styleguides, template, tutorial
• Homepage:
• Size: 211 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
![Bug with a proto sign](header.jpg)

# Motivation

This repository was established for the purpose of investigating the potential of protobuf editor extensions. It is expected that the extension will be capable of detecting all errors within proto files.

# Supported syntax

The repository only covers syntax [proto3](https://protobuf.dev/programming-guides/proto3/) of protobuf.

# Structure

There are several samples with simple proto definitions. Each of these proto definitions has at least one error. I haeve grouped the samples by context:

| Sample | Context  |

|--------|----------|

| s0xx   | File     |

| s1xx   | Message  |

| s2xx   | Field    |

| s3xx   | Package  |

| s4xx   | Import   |

| s5xx   | Enum     |

| s6xx   | Oneof    |

| s7xx   | Repeated |