Skip to content

buf docs #77

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 20, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
buf docs
  • Loading branch information
cr-ruhanmuzaffar committed Aug 16, 2024
commit 3d47fa95ff6b98c3e1af3fe7c3c04e550ee46db3
33 changes: 33 additions & 0 deletions docs/tools/buf.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: Buf
sidebar_label: Buf
description: CodeRabbit's guide to Buf.
---

[Buf](https://buf.build/) offers linting for Protobuf files.

## Files

Buf will run on files with the following extensions:

- `.proto`

## Configuration

Buf uses a YAML style configuration file. We look for the following file anywhere in the repository:

- `buf.yaml`

If no config file is found, CodeRabbit will consider the following categories of strictness based on the profile selected:

### Chill

- `MINIMAL`

### Assertive

- `BASIC`

## Links

- [Buf Configuration](https://buf.build/docs/configuration/v2/buf-yaml#lint)
2 changes: 2 additions & 0 deletions docs/tools/tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ Remove extraneous f prefix
| Typescript | [Biome][Biome] |
| YAML | [YamlLint][YamlLint] |
| Ruby | [Rubocop][Rubocop] |
| Buf | [Buf][Buf] |

[ShellCheck]: ./shellcheck.md
[Ruff]: ./ruff.md
Expand All @@ -75,3 +76,4 @@ Remove extraneous f prefix
[Checkov]: ./checkov.md
[Detekt]: ./detekt.md
[Rubocop]: ./rubocop.md
[Buf]: ./buf.md