Browse Source

packaging: fix swagger-ui-dist entry point

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.
bubble
Roman Bolshakov 7 years ago
committed by Kyle Shockey
parent
commit
b23c999d01
4 changed files with 11 additions and 4 deletions
  1. +7
    -2
      swagger-ui-dist-package/README.md
  2. +1
    -1
      swagger-ui-dist-package/deploy.sh
  3. +2
    -0
      swagger-ui-dist-package/index.js
  4. +1
    -1
      swagger-ui-dist-package/package.json

+ 7
- 2
swagger-ui-dist-package/README.md View File

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

+ 1
- 1
swagger-ui-dist-package/deploy.sh View File

@@ -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
- 0
swagger-ui-dist-package/index.js View File

@@ -0,0 +1,2 @@
module.exports.SwaggerUIBundle = require('./swagger-ui-bundle.js')
module.exports.SwaggerUIStandalonePreset = require('./swagger-ui-standalone-preset.js')

+ 1
- 1
swagger-ui-dist-package/package.json View File

@@ -1,7 +1,7 @@
{
"name": "swagger-ui-dist",
"version": "$$VERSION",
"main": "dist/swagger-ui.js",
"main": "index.js",
"repository": "git@github.com:swagger-api/swagger-ui.git",
"contributors": [
"(in alphabetical order)",


Loading…
Cancel
Save