protolint

protolint documentation

• Version in MegaLinter: 0.38.2
• Visit Official Web Site
• See How to configure protolint rules
  • If custom .protolintrc.yml config file is not found, .protolintrc.yml will be used
• See Index of problems detected by protolint

Configuration in MegaLinter

• Enable protolint by adding PROTOBUF_PROTOLINT in ENABLE_LINTERS variable
• Disable protolint by adding PROTOBUF_PROTOLINT in DISABLE_LINTERS variable

• Enable auto-fixes by adding PROTOBUF_PROTOLINT in APPLY_FIXES variable

Variable	Description	Default value
PROTOBUF_PROTOLINT_ARGUMENTS	User custom arguments to add in linter CLI call Ex: -s --foo "bar"
PROTOBUF_PROTOLINT_FILTER_REGEX_INCLUDE	Custom regex including filter Ex: (src\|lib)	Include every file
PROTOBUF_PROTOLINT_FILTER_REGEX_EXCLUDE	Custom regex excluding filter Ex: (test\|examples)	Exclude no file
PROTOBUF_PROTOLINT_CLI_LINT_MODE	Override default CLI lint mode - file: Calls the linter for each file - list_of_files: Call the linter with the list of files as argument - project: Call the linter from the root of the project	file
PROTOBUF_PROTOLINT_FILE_EXTENSIONS	Allowed file extensions. "*" matches any extension, "" matches empty extension. Empty list excludes all files Ex: [".py", ""]	[".proto"]
PROTOBUF_PROTOLINT_FILE_NAMES_REGEX	File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files Ex: ["Dockerfile(-.+)?", "Jenkinsfile"]	Include every file
PROTOBUF_PROTOLINT_PRE_COMMANDS	List of bash commands to run before the linter	None
PROTOBUF_PROTOLINT_POST_COMMANDS	List of bash commands to run after the linter	None
PROTOBUF_PROTOLINT_CONFIG_FILE	protolint configuration file name Use LINTER_DEFAULT to let the linter find it	.protolintrc.yml
PROTOBUF_PROTOLINT_RULES_PATH	Path where to find linter configuration file	Workspace folder, then MegaLinter default rules
PROTOBUF_PROTOLINT_DISABLE_ERRORS	Run linter but consider errors as warnings	false
PROTOBUF_PROTOLINT_DISABLE_ERRORS_IF_LESS_THAN	Maximum number of errors allowed	0

IDE Integration

Use protolint in your favorite IDE to catch errors before MegaLinter !

	IDE	Extension Name	Install
	IDEA	Protocol Buffer Linter
	Visual Studio Code	VsCode Protolint

MegaLinter Flavours

This linter is available in the following flavours

	Flavor	Description	Embedded linters	Info
	all	Default MegaLinter Flavor	101
	documentation	MegaLinter for documentation projects	42
	dotnet	Optimized for C, C++, C# or VB based projects	50
	go	Optimized for GO based projects	44
	java	Optimized for JAVA based projects	44
	javascript	Optimized for JAVASCRIPT or TYPESCRIPT based projects	51
	php	Optimized for PHP based projects	46
	python	Optimized for PYTHON based projects	50
	ruby	Optimized for RUBY based projects	43
	rust	Optimized for RUST based projects	43
	salesforce	Optimized for Salesforce based projects	45
	swift	Optimized for SWIFT based projects	43
	terraform	Optimized for TERRAFORM based projects	48

Behind the scenes

How are identified applicable files

• File extensions: .proto

How the linting is performed

• protolint is called one time by identified file

Example calls

protolint lint myfile.proto

protolint lint --config_path .protolintrc.yml myfile.proto

protolint lint -fix --config_path .protolintrc.yml myfile.proto

Help content

Usage of lint:
  -config_dir_path string
      path/to/the_directory_including_protolint.yaml
  -config_path string
      path/to/protolint.yaml. Note that if both are set, config_dir_path is ignored.
  -fix
      mode that the command line can automatically fix some of the problems
  -no-error-on-unmatched-pattern
      exits with 0 when no file is matched
  -output_file string
      path/to/output.txt
  -plugin value
      plugins to provide custom lint rule set. Note that it's necessary to specify it as path format'
  -reporter value
      formatter to output results in the specific format. Available reporters are "plain"(default), "junit", "json", and "unix".
  -v  verbose output that includes parsing process details

Installation on mega-linter Docker image

• Dockerfile commands :

FROM yoheimuta/protolint:latest as protolint
COPY --from=protolint /usr/local/bin/protolint /usr/bin/