Skip to content

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

@davidscoff

Description

@davidscoff
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.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions