Skip to content

Commit

Permalink
packaging: fix swagger-ui-dist entry point
Browse files Browse the repository at this point in the history
Entry point was missing. This change allows importing SwaggerUIBundle
and SwaggerUIStandalonePreset directly from package. Correct entry point
is also needed for module bundlers like webpack to perform tree-shaking.
  • Loading branch information
roolebo authored and shockey committed May 26, 2017
1 parent 41d8089 commit b23c999
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 4 deletions.
9 changes: 7 additions & 2 deletions swagger-ui-dist-package/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
This module, `swagger-ui-dist`, exposes Swagger-UI's entire dist folder as a dependency-free npm module.
This module, `swagger-ui-dist`, exposes Swagger-UI's entire dist folder as a dependency-free npm module. Use `swagger-ui` instead, if you'd like to have npm install dependencies for you.

Use `swagger-ui` instead, if you'd like to have npm install dependencies for you.
`SwaggerUIBundle` and `SwaggerUIStandalonePreset` can be imported:
```javascript
import { SwaggerUIBundle, SwaggerUIStandalonePreset } from 'swagger-ui-dist'
```

For anything else, check the [Swagger-UI](https://github.com/swagger-api/swagger-ui) repository.
2 changes: 1 addition & 1 deletion swagger-ui-dist-package/deploy.sh
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ else
npm pack .
fi

find . -not -name .npmignore -not -name .npmrc -not -name deploy.sh -not -name package.json -not -name README.md -not -name *.tgz -delete
find . -not -name .npmignore -not -name .npmrc -not -name deploy.sh -not -name index.js -not -name package.json -not -name README.md -not -name *.tgz -delete
2 changes: 2 additions & 0 deletions swagger-ui-dist-package/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
module.exports.SwaggerUIBundle = require('./swagger-ui-bundle.js')
module.exports.SwaggerUIStandalonePreset = require('./swagger-ui-standalone-preset.js')
2 changes: 1 addition & 1 deletion swagger-ui-dist-package/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "swagger-ui-dist",
"version": "$$VERSION",
"main": "dist/swagger-ui.js",
"main": "index.js",
"repository": "[email protected]:swagger-api/swagger-ui.git",
"contributors": [
"(in alphabetical order)",
Expand Down

0 comments on commit b23c999

Please sign in to comment.