protolint-bin

This package contains the pre-compiled binaries. Home-page: https://github.com/yoheimuta/protolint/ Author: yohei yoshimuta Maintainer: yohei yoshimuta License: MIT Project-URL: Official Website, https://github.com/yoheimuta/protolint/ Project-URL: Source Code, https://github.com/yoheimuta/protolint.git Project-URL: Issue Tracker, https://github.com/yoheimuta/protolint/issues Classifier: Development Status :: 5 - Production/Stable Classifier: Environment :: Console Classifier: Intended Audience :: Developers Classifier: License :: OSI Approved :: MIT License Classifier: Natural Language :: English Classifier: Operating System :: MacOS Classifier: Operating System :: Microsoft :: Windows Classifier: Operating System :: POSIX :: Linux Classifier: Programming Language :: Go Classifier: Topic :: Software Development :: Pre-processors Classifier: Topic :: Utilities Requires-Python: >= 3.0 Description-Content-Type: text/rst License-File: LICENSE

protolint

protolint is the pluggable linting/fixing utility for Protocol Buffer files (proto2+proto3)

• Runs fast because this works without compiler.

• Easy to follow the official style guide. The rules and the style guide correspond to each other exactly.

  • Fixer automatically fixes all the possible official style guide violations.

• Allows to disable rules with a comment in a Protocol Buffer file.

  • It is useful for projects which must keep API compatibility while enforce the style guide as much as possible.
  • Some rules can be automatically disabled by inserting comments to the spotted violations.

• Loads plugins to contain your custom lint rules.

• Undergone testing for all rules.

• Many integration supports.

  • protoc plugin
  • Editor integration
  • GitHub Action
  • CI Integration

  .. rubric:: Usage in python projects :name: usage-in-python-projects

You can use protolint as a linter within your python projects, the wheel protolint-bin on pypi <https://pypi.org>__ contains the pre-compiled binaries for various platforms. Just add the desired version to your pyproject.toml or requirements.txt.

The wheels downloaded will contain the compiled go binaries for protolint and protoc-gen-protolint. Your platform must be compatible with the supported binary platforms.

You can add the linter configuration to the tools.protolint package in pyproject.toml.

More information

You will find more information on the projects homepage <https://github.com/yoheimuta/protolint>__.