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

Since 2.1, @compodoc/ngd-transformer now requires Node >= 12.17.0 #68

Closed
gaetanmaisse opened this issue Oct 11, 2020 · 2 comments
Closed

Comments

@gaetanmaisse
Copy link

gaetanmaisse commented Oct 11, 2020

Describe the bug

The latest release of @compodoc/ngd-transformer includes 60dbb2a.
In this commit, viz.js has been replaced by @aduh95/viz.js (here).

Functionality speaking it looks ok however node requirement of @aduh95/viz.js is stricter than viz.js as it needs ^12.17.0 || >=13.2.0, see: https://github.com/aduh95/viz.js/blob/master/package.json#L24.

It can look irrelevant but as this was published in a minor release and as @compodoc/compodoc has a dependency on "@compodoc/ngd-transformer": "^2.0.0" (^2.1.0 for a few hours) it causes the following error when running yarn install with Node <12.17.0 :

error @aduh95/viz.js@3.1.0: The engine "node" is incompatible with this module. Expected version "^12.17.0 || >=13.2.0". Got "12.16.2"
error Found incompatible module.

And it's breaking some of the CI steps of Storybook for instance.

Expected behavior

Builds of @compodoc/compodoc users should not be broken because one of its dependency had a minor release.

Additional context

Options I have in mind:

  • Check with the maintainer of @aduh95/viz.js if current node requirement ("^12.17.0 || >=13.2.0") is correct. It has been bumped here but there is no info about the reason in the commit message.
  • Update Node compatibility and make major releases of @compodoc/ngd-transformer and @compodoc/compodoc and so on Storybook side we will safely use an old/fixed version of Compodoc for now.
@aduh95
Copy link

aduh95 commented Oct 17, 2020

I've published @aduh95/viz.js v3.2.0 which removes the engine restriction. PTAL.

@gaetanmaisse
Copy link
Author

Closing as everything is back to 🟢 with the 3.2.0 release of @aduh95/viz.js

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

No branches or pull requests

2 participants