protolint
protolint documentation
- Version in Mega-Linter: 0.35.1
- Visit Official Web Site
- See How to configure protolint rules
- If custom
.protolintrc.ymlconfig file is not found, .protolintrc.yml will be used
- If custom
- See Index of problems detected by protolint
Configuration in Mega-Linter
- Enable protolint by adding
PROTOBUF_PROTOLINTin ENABLE_LINTERS variable - Disable protolint by adding
PROTOBUF_PROTOLINTin DISABLE_LINTERS variable
- Enable auto-fixes by adding
PROTOBUF_PROTOLINTin 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 |
{linter.cli_lint_mode} |
| PROTOBUF_PROTOLINT_FILE_EXTENSIONS | Allowed file extensions. "*" matches any extension, "" matches empty extension. Empty list excludes all filesEx: [".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 nameUse LINTER_DEFAULT to let the linter find it |
.protolintrc.yml |
| PROTOBUF_PROTOLINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then Mega-Linter 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 Mega-Linter !
| IDE | Extension Name | Install | |
|---|---|---|---|
| IDEA | Protocol Buffer Linter | ||
| Visual Studio Code | VsCode Protolint |  |
Mega-Linter Flavours
This linter is available in the following flavours
| Flavor | Description | Embedded linters | Info | |
|---|---|---|---|---|
 |
all | Default Mega-Linter Flavor | 94 |   |
| dart | Optimized for DART based projects | 41 |   |
|
| documentation | Mega-Linter for documentation projects | 40 |   |
|
| dotnet | Optimized for C, C++, C# or VB based projects | 47 |   |
|
| go | Optimized for GO based projects | 42 |   |
|
| java | Optimized for JAVA based projects | 42 |   |
|
| javascript | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 49 |   |
|
| php | Optimized for PHP based projects | 44 |   |
|
| python | Optimized for PYTHON based projects | 49 |   |
|
| ruby | Optimized for RUBY based projects | 41 |   |
|
| rust | Optimized for RUST based projects | 41 |   |
|
| salesforce | Optimized for Salesforce based projects | 43 |   |
|
| scala | Optimized for SCALA based projects | 41 |   |
|
| swift | Optimized for SWIFT based projects | 41 |   |
|
| terraform | Optimized for TERRAFORM based projects | 45 |   |
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:v0.35.1 as protolint
COPY --from=protolint /usr/local/bin/protolint /usr/bin/
Example success log
Results of protolint linter (version 0.26.0)
See documentation on https://nvuillam.github.io/mega-linter/descriptors/protobuf_protolint/
-----------------------------------------------
[SUCCESS] .automation/test/protobuf/protobuf_good_1.proto
Example error log
Results of protolint linter (version 0.26.0)
See documentation on https://nvuillam.github.io/mega-linter/descriptors/protobuf_protolint/
-----------------------------------------------
[ERROR] .automation/test/protobuf/protobuf_bad_1.proto
[.automation/test/protobuf/protobuf_bad_1.proto:8:1] The order of Import is invalid. Check if the file is ordered in the correct manner.
[.automation/test/protobuf/protobuf_bad_1.proto:18:5] Found an incorrect indentation style " ". " " is correct.
[.automation/test/protobuf/protobuf_bad_1.proto:19:5] Found an incorrect indentation style " ". " " is correct.
[.automation/test/protobuf/protobuf_bad_1.proto:20:5] Found an incorrect indentation style " ". " " is correct.
[.automation/test/protobuf/protobuf_bad_1.proto:21:5] Found an incorrect indentation style " ". " " is correct.
[.automation/test/protobuf/protobuf_bad_1.proto:24:5] Found an incorrect indentation style " ". " " is correct.
[.automation/test/protobuf/protobuf_bad_1.proto:26:5] Found an incorrect indentation style " ". " " is correct.
[.automation/test/protobuf/protobuf_bad_1.proto:28:5] Found an incorrect indentation style " ". " " is correct.
[.automation/test/protobuf/protobuf_bad_1.proto:25:5] Found an incorrect indentation style " ". " " is correct.
[.automation/test/protobuf/protobuf_bad_1.proto:27:7] Found an incorrect indentation style " ". " " is correct.
[.automation/test/protobuf/protobuf_bad_1.proto:29:5] Found an incorrect indentation style " ". " " is correct.
[.automation/test/protobuf/protobuf_bad_1.proto:30:5] Found an incorrect indentation style " ". " " is correct.
[.automation/test/protobuf/protobuf_bad_1.proto:31:5] Found an incorrect indentation style " ". " " is correct.
[.automation/test/protobuf/protobuf_bad_1.proto:34:5] Found an incorrect indentation style " ". " " is correct.
[.automation/test/protobuf/protobuf_bad_1.proto:47:5] Found an incorrect indentation style " ". " " is correct.
[.automation/test/protobuf/protobuf_bad_1.proto:3:1] The line length is 91, but it must be shorter than 80
[.automation/test/protobuf/protobuf_bad_1.proto:4:1] Package name "examplePb" must only contains lowercase letters, digits and/or periods.
[.automation/test/protobuf/protobuf_bad_1.proto:8:1] Imports are not sorted.
[.automation/test/protobuf/protobuf_bad_1.proto:9:1] Imports are not sorted.
[.automation/test/protobuf/protobuf_bad_1.proto:14:1] Imports are not sorted.
[.automation/test/protobuf/protobuf_bad_1.proto:15:1] Imports are not sorted.
[.automation/test/protobuf/protobuf_bad_1.proto:19:5] EnumField name "UNKNOWN" with zero value should have the suffix "UNSPECIFIED"
[.automation/test/protobuf/protobuf_bad_1.proto:17:1] Enum name "enumAllowingAlias" must be UpperCamelCase
[.automation/test/protobuf/protobuf_bad_1.proto:36:3] Field "inner_message" should avoid required for proto3
[.automation/test/protobuf/protobuf_bad_1.proto:37:3] Group "Result" should be avoided for proto3
[.automation/test/protobuf/protobuf_bad_1.proto:40:3] Group "Result" should be avoided for proto3
[.automation/test/protobuf/protobuf_bad_1.proto:43:3] Group "Regular" should be avoided for proto3
[.automation/test/protobuf/protobuf_bad_1.proto:29:5] Repeated field name "inner_message" must be pluralized name "inner_messages"
[.automation/test/protobuf/protobuf_bad_1.proto:40:3] Repeated group name "Result" must be pluralized name "Results"
[.automation/test/protobuf/protobuf_bad_1.proto:42:3] Repeated field name "paper" must be pluralized name "papers"
[.automation/test/protobuf/protobuf_bad_1.proto:43:3] Repeated group name "Regular" must be pluralized name "Regulars"
[.automation/test/protobuf/protobuf_bad_1.proto:23:1] Message name "outer" must be UpperCamelCase
[.automation/test/protobuf/protobuf_bad_1.proto:26:5] Message name "inner" must be UpperCamelCase
[.automation/test/protobuf/protobuf_bad_1.proto:47:5] RPC name "search" must be UpperCamelCase