JSDoc fix root @exports for enum & interface #1999
Closed
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.
Fix Incomplete Type Definitions for .proto Files Without Package
Problem Description
When a package is not specified in the
.proto
file and types are generated usingpbts
,jsdoc
does not recognize the@exports
of the interfaces. This results in an incomplete type definition file.Steps to Reproduce
Clone the repository:
Navigate to the project directory:
cd protobuf.js-poc
Install the dependencies:
Generate the types:
Observe the generated files:
sample-root.d.ts
file is incomplete and missing theIPerson
interface.sample-root-fixed.d.ts
, which includes the complete type definitions.Solution
To fix this problem, the
@exports
annotation was removed so that Root enums/interfaces are correctly recognized byjsdoc
even when no package is specified in the.proto
file.