Support and enforce peerDependencies #292
Comments
eladb
pushed a commit
to aws/aws-cdk
that referenced
this issue
Nov 6, 2018
Adds "peerDependencies" to all modules for all dependencies that include types that are used in the module's public API. Also, add "@aws-cdk/cdk" to "peerDependencies" for the typescript library cdk-init template. This will be enforced by jsii when aws/jsii#292 is introduced. Prerequisite for #272 Fixes #979
eladb
pushed a commit
to aws/aws-cdk
that referenced
this issue
Nov 6, 2018
Adds "peerDependencies" to all modules for all dependencies that include types that are used in the module's public API. Also, add "@aws-cdk/cdk" to "peerDependencies" for the typescript library cdk-init template. This will be enforced by jsii when aws/jsii#292 is introduced. Prerequisite for #272 Fixes #979
|
Fixed by #294 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
When a module's API includes types from another dependency, the right way to ensure that a consumer actually passes in objects that are semantically compatible is by ensuring that the object was instantiated from the exact same version, as long as it's semantically compatible.
The jsii compiler should emit warnings if a module's API includes types of other modules but those other modules are not defined also under
peerDependenciesof the package.json file.We should also provide a tool to help "fix" package.json files by inspecting the jsii spec.
Related: aws/aws-cdk#979
The text was updated successfully, but these errors were encountered: