OpenAPITools / OpenAPITools/openapi-generator
[BUG] typescript-rxjs generated code contains a .gitignore which is picked up by npm publish
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Bug Report Checklist
- Have you provided a full/minimal spec to reproduce the issue?
- Have you validated the input using an OpenAPI validator?
- Have you tested with the latest master to confirm the issue still exists?
- Have you searched for related issues/PRs?
- What's the actual output vs expected output?
- [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description
The generated code from typescript-txjs contains a .gitgnore with the entry "dist". When publishing using npm publish, the compiled code will be ignored, resulting in a corrupt package.
openapi-generator version
7.16
OpenAPI declaration file content or url
Generation Details
Steps to reproduce
cd dist/xxx-rxjs-client && npm install && npm run build && npm publish --dry-run
then observe the .gitignore
Related issues/PRs
Suggest a fix
Either provide a .npmignore or remove dist from .gitignore
My quick fix:
cd dist/xxx-rxjs-client && printf "\n!/dist/\n" >> .gitignore && npm install && npm run build && npm publish --dry-run
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Reproduce the issue in dist/xxx-rxjs-client with npm install, npm run build, and npm publish --dry-run, then inspect the generated .gitignore. Compare the package contents with the expected compiled dist/ output; done means npm's dry run includes the compiled files without the workaround described in the report.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- node.js, typescript
- Domain
- build-system, tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100