https://github.com/plexsystems/vscode-protolint

A protobuf linter for visual studio code
https://github.com/plexsystems/vscode-protolint

linter protobuf protobuf3 vscode

Last synced: 5 months ago
JSON representation

A protobuf linter for visual studio code

• Host: GitHub
• URL: https://github.com/plexsystems/vscode-protolint
• Owner: plexsystems
• License: mit
• Created: 2019-06-14T17:53:56.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2024-06-16T10:59:52.000Z (almost 2 years ago)
• Last Synced: 2026-01-14T15:59:51.715Z (5 months ago)
• Topics: linter, protobuf, protobuf3, vscode
• Language: TypeScript
• Homepage:
• Size: 411 KB
• Stars: 58
• Watchers: 5
• Forks: 12
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# vscode-protolint [![License](https://img.shields.io/:license-mit-blue.svg)](https://github.com/plexsystems/vscode-protolint/blob/master/LICENSE) [![GitHub release](https://img.shields.io/github/release/plexsystems/vscode-protolint.svg)](https://github.com/plexsystems/vscode-protolint/releases)

vscode-protolint is a protocol buffer linter for [Visual Studio Code](https://code.visualstudio.com/) that uses [protolint](https://github.com/yoheimuta/protolint) to validate linting rules.

## Example

Using the following `.protolint.yaml` configuration file

```yaml

lint:

  rules:

    no_default: true

    add:

      - MESSAGE_NAMES_UPPER_CAMEL_CASE

      - SERVICE_NAMES_UPPER_CAMEL_CASE

```

![protobuflintexample](img/protolint_demo.gif)

## Installation

This extension can be installed through the Visual Studio [marketplace](https://marketplace.visualstudio.com/items?itemName=Plex.vscode-protolint). Alternatively, a VSIX installer is available on the [releases](https://github.com/plexsystems/vscode-protolint/releases) page.

Also ensure that:

- [protolint](https://github.com/yoheimuta/protolint) is installed.

- Protobuf support is added to your Visual Studio Code. [vscode-proto3](https://github.com/zxh0/vscode-proto3) works well.

## Configuration

- `protolint.path`: The location of the `protolint` binary. Default: `System PATH`.

## Local Development

Before running any of the below commands, make sure you have installed the required dependencies with `npm install`

- To compile the solution locally run `npm run compile`

- To run the unit tests run `npm run test`

- To run the extension in a Visual Studio Code development environment press `F5` in Visual Studio Code