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

Switch repo from NPM to yarn for improved dependency management #5084

Conversation

michaeljwiebe
Copy link

Description

I was attempting to use a customized version of the Swagger-UI package in my Swagger Editor but was unable to do so using npm. Switching over to yarn resolved the issue for me. Yarn doesn't require special flags to install locally like npm does (see --legacy-peer-deps).

Motivation and Context

Fixes #5000 - This PR allows me to link my local swagger-editor to a customized version of swagger-ui that I have locally using the local relative path to the repo as the version in my package.json. See package.json:
Screen Shot 2024-05-24 at 5 38 38 AM

How Has This Been Tested?

I ran yarn test and have built and ran locally and verified that the swagger-editor works and swagger-ui is importing correctly.

Screenshots (if appropriate):

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.

mjwiebe-C1 and others added 2 commits May 24, 2024 11:14
…g, bumped nvmrc to 20.12.2

Co-authored-by: FELIX HIDALGO <[email protected]>
Co-authored-by: JAMES SLATER <[email protected]>
Co-authored-by: RANGARAJAN LAKSHMINARAYNACHAR <[email protected]>
@char0n
Copy link
Member

char0n commented May 28, 2024

Hi @michaeljwiebe,

Thanks for the effort but we're not be changing the master branch to yarn. master branch contains SwaggerEditor v4 implementation which is considered (unofficially) obsolete at this point in time.

Please use https://editor-next.swagger.io/ and next branch of this repo to access SwaggerEditor v5.

@char0n char0n closed this May 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Swagger-Editor 4.12.1 failure when using latest swagger-ui (5.17.2) as a local dependency
3 participants