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

Turn interface definition and compliance tests into devDependency #960

Merged
merged 2 commits into from
Jul 22, 2021

Conversation

robertkiel
Copy link
Contributor

Current situation

When installing latest version of js-libp2p, it installs libp2p-interfaces-compliance-tests@1.0.0 as dependency which itself install aegir@33 which is not needed for js-libp2p to run.

Problem

Installing aegir changes the way how some modules are resolved by Node.js, hence tools such as Typedoc fail while loading plugins.

Solution

Turn dependencies that are only needed for development or releasing NPM packages into devDependencies to make sure they are not installled when installing js-libp2p. This also reduces the footprint of js-libp2p as a dependency.

@vasco-santos
Copy link
Member

oh damn, thanks for the PR @robertkiel

package.json Outdated
@@ -151,6 +149,8 @@
"libp2p-delegated-peer-routing": "^0.10.0",
"libp2p-floodsub": "^0.27.0",
"libp2p-gossipsub": "^0.10.0",
"libp2p-interfaces": "^1.0.0",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

interfaces should be a dependency, but the compliance totally a devDep

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It could also make sense to turn aegir into devDependency within libp2p-interfaces-compliance-tests but haven't checked that

Copy link
Member

@vasco-santos vasco-santos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@vasco-santos vasco-santos merged commit 0701de4 into libp2p:master Jul 22, 2021
robertkiel pushed a commit to robertkiel/js-libp2p-mplex that referenced this pull request Jul 22, 2021
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.

2 participants