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

lz-string is not declared as a peer dependency #737

Open
ross-moug opened this issue Nov 26, 2024 · 2 comments
Open

lz-string is not declared as a peer dependency #737

ross-moug opened this issue Nov 26, 2024 · 2 comments

Comments

@ross-moug
Copy link

Describe the bug
When you install @solarwinds/nova-bits you receive no warning / error that lz-string is required.

This dependency is required in the CodeSandboxService which is packaged into the built artefact.

This dependency must be marked as a peer dependency so consumers are informed that this was required by the nova-bits package.

To Reproduce
Steps to reproduce the behavior:

  1. In a fresh or existing Angular project
  2. npm i @solarwinds/nova-bits
  3. npm run start

Expected behaviour
The application can be served without error.

Actual Behaviour
The following error is received when serving the application:

Build at: 2024-11-26T08:29:15.733Z - Hash: 866a2cdac023ddc6 - Time: 1117ms

./node_modules/@nova-ui/bits/fesm2020/nova-ui-bits.mjs:96:0-45 - Error: Module not found: Error: Can't resolve 'lz-string' in '/Users/rossmoug/Git/project/node_modules/@nova-ui/bits/fesm2020'

✖ Failed to compile.

Environment (please complete the following information):

  • OS: MacOs
  • Browser: Chrome
  • Browser Version: 131.0.6778.86 (Official Build) (arm64)

Additional context

Temporary workaround is to install lz-string but it would be a better experience if this was declared as a peer dependency so consumers were informed that this was required.

@pavlo-poimanov
Copy link
Contributor

@ross-moug , can you create a PR

@pavlo-poimanov
Copy link
Contributor

@ross-moug , the actual plan is to get rid of this dependency to be required. Because this code should not be a part of production code. This module was needed only for dev testing purposes. The clients shouldn't be affected. It is a bug to solve.

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

No branches or pull requests

2 participants