Skip to content
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

[BUG][JAVASCRIPT] dist folder is not published when publishing typescript-axios generated client with npm publish #3224

Closed
davidscoff opened this issue Jun 26, 2019 · 2 comments · Fixed by #5850

Comments

@davidscoff
Copy link

Description

When publishing a generated typescript-axios client the dist folder is not published as it is included in the .gitignore file in the project. This means that when you try to include the generated client as a dependency in another project npm will be unable to resolve the module.

openapi-generator version

4.0.2

OpenAPI declaration file content or url

Any project generated using the typescript-axios generator will suffer from this issue.

Command line used for generation

I'm using the openapi-generator cli installed through homebrew.

Steps to reproduce
  1. Generate a client using the typescript-axios generator.
  2. Note that the .gitignore file generated includes the dist folder.
  3. Run npm publish. You can see in the output that the tarball does not include dist folder.
  4. npm install the published tarball in another project. You will see an error complaining that the module can't be found.
Suggest a fix

An .npmignore file can be included in the generated project by default which will override the .gitignore file. Or alternatively the files property can be populated in package.json to ensure the dist directory is published. See more here.

@tripleplayj
Copy link

I'm sure there's a bit of overlap here, but I am also noticing that both my files and publishConfig sections are missing when the new package.json. I'm sure this is related to your problem?

@louis-lau
Copy link

I was really confused there until I found this issue, I thought I was doing something wrong but I followed the instructions (of which there aren't a lot) to the letter. This does not sound hard to fix?

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