Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Export ./dist/swagger-ui.css #7878

Conversation

BenjaminNolan
Copy link
Contributor

Description

This PR corrects the CSS export in package.json from ./swagger-ui.css to ./dist/swagger-ui.css.

Motivation and Context

v4.6.0 has an incorrect export in package.json for ./dist/swagger-ui.css which causes the following error when importing the file:

Module not found: Error: Package path ./dist/swagger-ui.css is not exported from package
node_modules/swagger-ui (see exports field in node_modules/swagger-ui/package.json)

How Has This Been Tested?

This was tested in our Vue SPA which imports swagger-ui by switching to our fork and changing the export to the correct path for the CSS file. With the path in v4.6.0, the application doesn't build at all, whereas with the corrected path, it all works again.

Changing the import from import 'swagger-ui/dist/swagger-ui.css'; to import 'swagger-ui/swagger-ui.css'; results in Module not found: Error: Can't resolve 'swagger-ui/swagger-ui.css', whereas fixing the export in package.json results in the original import line working, thus I believe this is the correct fix for the issue.

Checklist

My PR contains...

  • No code changes (src/ is unmodified: changes to documentation, CI, metadata, etc.)
  • Dependency changes (any modification to dependencies in package.json)
  • Bug fixes (non-breaking change which fixes an issue)
  • Improvements (misc. changes to existing features)
  • Features (non-breaking change which adds functionality)

My changes...

  • are breaking changes to a public API (config options, System API, major UI change, etc).
  • are breaking changes to a private API (Redux, component props, utility functions, etc.).
  • are breaking changes to a developer API (npm script behavior changes, new dev system dependencies, etc).
  • are not breaking changes.

Documentation

  • My changes do not require a change to the project documentation.
  • My changes require a change to the project documentation.
  • If yes to above: I have updated the documentation accordingly.

Automated tests

  • My changes can not or do not need to be tested.
  • My changes can and should be tested by unit and/or integration tests.
  • If yes to above: I have added tests to cover my changes.
  • If yes to above: I have taken care to cover edge cases in my tests.
  • All new and existing tests passed.

(I don't think this really needs a test, since it's just a broken export.)

@tim-lai tim-lai merged commit eece9f5 into swagger-api:master Mar 2, 2022
@tim-lai
Copy link
Contributor

tim-lai commented Mar 2, 2022

@BenjaminNolan Thanks for the quick fix! Will get this merged PR released shortly.

@BenjaminNolan
Copy link
Contributor Author

You're welcome! :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants