Skip to content

[typscript] change @export to @exports #21754

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

jckr
Copy link

@jckr jckr commented Aug 14, 2025

one of the typescript templates uses a @export tag which is incorrect - the right form is @exports (see https://jsdoc.app/tags-exports). As a result, the generated code may trigger linters.

This PR corrects the syntax.

fixes #21753

@TiFu @taxpon @sebastianhaas @kenisteward @Vrolijkx @macjohnny @topce @akehir @petejohansonxo @amakhrov @davidgamero @mkusaka @joscha

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in WSL)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@macjohnny
Copy link
Member

thanks!

@macjohnny
Copy link
Member

@jckr please re-generate the samples (see PR description)

@davidgamero
Copy link
Contributor

im debugging the same windows test failure too (unrelated to the samples afaict)

the grade Unknown command-line option '-b'. error

@jckr
Copy link
Author

jckr commented Aug 15, 2025

@macjohnny I have added a commit for the samples

@macjohnny
Copy link
Member

@jckr can you merge the most recent master? maybe that resolves the CI issues

@macjohnny
Copy link
Member

FYI this is superseded by #21776

@macjohnny
Copy link
Member

closing this in favor of #21776

@macjohnny macjohnny closed this Aug 20, 2025
@macjohnny macjohnny reopened this Aug 20, 2025
@macjohnny
Copy link
Member

oops, #21776 was for typescript-axios, while this one is for typescript, so reopened and waiting for merging in the latest master branch

@macjohnny
Copy link
Member

but it raises an interesting question: should the jsdoc be removed altogether, since the information is already present in typescript?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] [typescript] @export is not a valid jsdoc decorator
3 participants