openapi-generator icon indicating copy to clipboard operation
openapi-generator copied to clipboard

[Typescript] Fix Issue Directly Publishing Package

Open bootsie123 opened this issue 1 year ago • 3 comments

Addresses issue #19003 by modifying the package.mustache file in the typescript generator.

PR checklist

  • [x] Read the contribution guidelines.
  • [x] 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.
  • [x] Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh ./bin/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH) 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.
  • [x] File the PR against the correct branch: master (upcoming 7.6.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • [x] If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

bootsie123 avatar Jun 24 '24 02:06 bootsie123

please follow step 3 to update the samples

cc @TiFu (2017/07) @taxpon (2017/07) @sebastianhaas (2017/07) @kenisteward (2017/07) @Vrolijkx (2017/09) @macjohnny (2018/01) @topce (2018/10) @akehir (2019/07) @petejohansonxo (2019/11) @amakhrov (2020/02) @davidgamero (2022/03) @mkusaka (2022/04)

wing328 avatar Jun 24 '24 03:06 wing328

My apologies! The samples should be updated now

bootsie123 avatar Jun 24 '24 16:06 bootsie123

no need to sorry. we appreciate your contributions

wing328 avatar Jun 26 '24 08:06 wing328

Good question! That's related to how the npm publish command chooses what files to include and what to exclude. The full details are in the documentation here but the TLDR this:

If there is a .gitignore file but no .npmignore file, then everything included in the .gitignore file will be excluded from the package. This is the case here with the typescript generator. However, if it's the other way around or both exist (as is the case with typescript-fetch and typescript-axios), than only what's in the .npmignore file will be excluded.

There are also certain files which will be included regardless. These are package.json, README.md, and LICENSE.

While this could be fixed by adding a blank .npmignore file (this is what typescript-axios does), that would include the dist folder along with all of the source files. To be a bit more space efficient, I thought it would be better to only include the necessary files (dist, README.md, package.json)

bootsie123 avatar Jul 02 '24 14:07 bootsie123

Thanks for the explanation!

macjohnny avatar Jul 02 '24 16:07 macjohnny