From b23c999d01e760e071e6f298f93ac65f3408ea71 Mon Sep 17 00:00:00 2001 From: Roman Bolshakov Date: Thu, 25 May 2017 10:39:19 +0300 Subject: [PATCH] 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. --- swagger-ui-dist-package/README.md | 9 +++++++-- swagger-ui-dist-package/deploy.sh | 2 +- swagger-ui-dist-package/index.js | 2 ++ swagger-ui-dist-package/package.json | 2 +- 4 files changed, 11 insertions(+), 4 deletions(-) create mode 100644 swagger-ui-dist-package/index.js diff --git a/swagger-ui-dist-package/README.md b/swagger-ui-dist-package/README.md index 07e45044..eff7655c 100644 --- a/swagger-ui-dist-package/README.md +++ b/swagger-ui-dist-package/README.md @@ -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. diff --git a/swagger-ui-dist-package/deploy.sh b/swagger-ui-dist-package/deploy.sh index e77f9e24..7e488509 100755 --- a/swagger-ui-dist-package/deploy.sh +++ b/swagger-ui-dist-package/deploy.sh @@ -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 diff --git a/swagger-ui-dist-package/index.js b/swagger-ui-dist-package/index.js new file mode 100644 index 00000000..f8b7191c --- /dev/null +++ b/swagger-ui-dist-package/index.js @@ -0,0 +1,2 @@ +module.exports.SwaggerUIBundle = require('./swagger-ui-bundle.js') +module.exports.SwaggerUIStandalonePreset = require('./swagger-ui-standalone-preset.js') diff --git a/swagger-ui-dist-package/package.json b/swagger-ui-dist-package/package.json index d22b2002..f4ddd7cf 100644 --- a/swagger-ui-dist-package/package.json +++ b/swagger-ui-dist-package/package.json @@ -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)",