swagger-api / swagger-api/swagger-ui

missing files in dist folder

Open
#5,443 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

cat: documentation type: enhancement
Dominant language
JavaScript
Stars
29k
Forks
9.3k
Avg merge
2d 23h
Merged PRs (30d)
25

Description

Q&A (please complete the following information)
  • OS: [e.g. macOS]
    N/A
  • Browser: [e.g. chrome, safari]
    N/A
  • Version: [e.g. 22]
    N/A
  • Method of installation: [e.g. npm, dist assets]
    npm install swagger-ui
  • Swagger-UI version: [e.g. 3.10.0]
    3.23.0
  • Swagger/OpenAPI version: [e.g. Swagger 2.0, OpenAPI 3.0]
    N/A
Content & configuration

N/A

Describe the bug you're encountering

After installation, the dist folder contains the following files:

.../swagger-ui/node_modules/swagger-ui/dist$ ls -1
oauth2-redirect.html
swagger-ui.css
swagger-ui.css.map
swagger-ui.js
swagger-ui.js.map
swagger-ui-standalone-preset.js
swagger-ui-standalone-preset.js.map

As we learn from the installation documentation:

The module's contents mirrors the dist folder you see in the Git repository. The most useful file is swagger-ui-bundle.js, which is a build of Swagger-UI that includes all the code it needs to run in one file.

However these (essential!) files are missing.

index.html
swagger-ui-bundle.js
swagger-ui-bundle.js.map

After wgetting the raw versions from the Git repo everything is working fine.

To reproduce...

Steps to reproduce the behavior:

  1. npm install swagger-ui
  2. Go to node_modules/swagger-ui/dist
  3. ls
  4. See missing files :(
Expected behavior

The files

index.html
swagger-ui-bundle.js
swagger-ui-bundle.js.map

ought to be there.

Screenshots

N/A

Additional context or thoughts

( ... how can this happen at all in the age of sturdy development pipelines? )

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by installing swagger-ui version 3.23.0 with npm and inspecting the generated node_modules/swagger-ui/dist directory. Compare its contents with the documented files and the repository's dist assets, including index.html and the swagger-ui-bundle.js files. Done means the expected files are included after installation.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
build-system, frontend
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.