Include file reference to types#522
Open
TristanFloch wants to merge 11 commits intopseudomuto:masterfrom
Open
Conversation
…o input files instead of grouping input files into one output file.
…les based on new flag.
…outputted when running plugin.
…umber (now 4). Also changed for loop to be more idiomatic.
Author
|
Pinging @pseudomuto as suggested in contributing guidelines 🙂 |
TristanFloch
force-pushed
the
feat/separate-files
branch
from
cc52d21 to
0b027e1
Compare
added 6 commits
July 18, 2023 11:20
This adds a `typeFile` member to message fields. Those will be empty if the separate file option is off.
Also add new services and messages in Customer.proto to ensure all cross protofile links are resolved by templates.
TristanFloch
force-pushed
the
feat/separate-files
branch
from
0b027e1 to
e316abe
Compare
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This PR builds on top of #492 (which is approved but not yet merged).
The later supports splitting the generated documentation into separate files. But when files import each other, the template has no way to know in which file a particular message is defined.
This PR adds the
TypeFilemember toMessageFieldtemplate objects, a string designing the file where the type is originally defined. Likewise for Request and Response types inServiceMethods.Those attributes allow templates to craft cross file links to type definitions.
Since this impacts performance, it is only enabled when the
separate_filesoption is enabled.If
separate_filesis disabled or the type has no particular file (literal types for instance), theTypeFilefield will be empty.