README.md

vscode-protolint

vscode-protolint is a protocol buffer linter for Visual Studio Code that uses protolint to validate linting rules.

Example

Using the following .protolint.yaml configuration file

lint:
  rules:
    no_default: true

    add:
      - MESSAGE_NAMES_UPPER_CAMEL_CASE
      - SERVICE_NAMES_UPPER_CAMEL_CASE

Installation

This extension can be installed through the Visual Studio marketplace. Alternatively, a VSIX installer is available on the releases page.

Also ensure that:

• protolint is installed.

• Protobuf support is added to your Visual Studio Code. 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