New feature: sorting of .proto files #20
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Ping @sebastienvermeille - would be great if this could be merged. Let me know if you need anything besides what's currently in the PR! |
|
Hi @S1artie I am very sorry for the very late notice, I will try to resurrect this project and dedicate time to it periodically. Should be good till end of the week. |
sebastienvermeille
requested changes
Sep 7, 2023
src/main/java/dev/cookiecode/maven/plugin/protobuf/AbstractProtocMojo.java
Show resolved
Hide resolved
S1artie
force-pushed
the
pullreq/fileSorting
branch
from
0872bf7 to
b7e14b9
Compare
The order in which .proto files are given to the compiler is file system dependent, and thus by extension also operating system dependent, which doesn't matter much for code generation, but can be critical for documentation generation (for which protoc plugins exist!). This commit adds an optional parameter "sortProtoFiles" which can be set to true (defaults to false) to have the .proto files be sorted lexicographically according to their path and file names.
S1artie
force-pushed
the
pullreq/fileSorting
branch
from
b7e14b9 to
97b1298
Compare
sebastienvermeille
approved these changes
Sep 8, 2023
Closed
|
@S1artie I released it: Might take a few hours till it's available on maven central 👍 |
Hey, thanks for releasing a new version! However, I still can't find it on Maven Central. Not even the older version seems to be there anymore...? [edit] Now it's there! |
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The order in which .proto files are given to the compiler is file system dependent, and thus by extension also operating system dependent, which doesn't matter much for code generation, but can be critical for documentation generation (for which protoc plugins exist). This commit adds an optional parameter "sortProtoFiles" which can be set to true (defaults to false) to have the .proto files be sorted lexicographically according to their path and file names.
The result has been successfully tested on Windows, macOS and Linux with the protoc-gen-doc plugin to generate identical, well-sorted documentation for a tree of .proto files.