Add index.html and missing 'dist' files to npm package
See original GitHub issueQ | A |
---|---|
Bug or feature request? | Bug? |
Which Swagger/OpenAPI version? | n/a |
Which Swagger-Editor version? | 3.1.7 |
How did you install Swagger-Editor? | yarn add swagger-editor |
Which broswer & version? | n/a |
Which operating system? | Windows 10 |
Demonstration API definition
n/a
Configuration (browser query string, constructor, config.yaml)
n/a
Expected Behavior
The npm package should contain the necessary files to load the Swagger Editor in a browser. In other words, if I add swagger-editor
as a node.js dependency in my project, I should be able to load the swagger-editor index.html file and have the editor render correctly.
Current Behavior
Currently the npm package contains:
- dist/swagger-editor.css
- dist/swagger-editor.css.map
- dist/swagger-editor.js
- dist/swagger-editor.js.map
- dist/validation.worker.js
- dist/validation.worker.js.map
However, cloning the repo and running npm run build
yields several more files in dist
:
- dist/swagger-editor-bundle.js
- dist/swagger-editor-bundle.js.map
- dist/swagger-editor-standalone-preset.js
- dist/swagger-editor-standalone-preset.js.map
- dist/favicon-16x16.png
- dist/favicon-32x32.png
Possible Solution
Adding the missing dist
files above, along with index.html
from the root of the project, should enable someone to add this project as a dependency and correctly render the swagger editor.
Context
I’d like to provide an easy way for my developers to add the swagger editor as a “dependency” of their Swagger JSON project and fire up a local editor to manipulate their API definition.
Issue Analytics
- State:
- Created 6 years ago
- Comments:6 (4 by maintainers)
@pofallon, I just merged #1492 which will include
index.html
in future releases ofswagger-editor-dist
. Thanks for bringing this to our attention!I’m going to close this since it seems like this is solved. If you have any lingering concerns, feel free to reply and I’ll reopen this ticket.
Awesome, thanks very much!