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

Add peer dependencies between packages #1003

Merged
merged 1 commit into from
Dec 5, 2022
Merged

Conversation

Gudahtt
Copy link
Member

@Gudahtt Gudahtt commented Dec 2, 2022

Packages now list peerDependencies to represent the expectation that a specific package version is setup with the controller messenger. This ensures that projects using these packages get a warning upon install if they are using incompatible package versions.

This lets us safely make breaking changes to controller messenger events and actions.

The constraints needed adjustment to allow the same dependency to be declared both in dependencies and peerDependencies. The constraint now ensures packages aren't listed both in dependencies and devDependencies instead.

  • FIXED:

    • The following packages now warn if a required package is not present:
      • assets-controllers
      • gas-fee-controller
      • permission-controller

Checklist

  • Tests are included if applicable
  • Any added code is fully documented

@Gudahtt Gudahtt force-pushed the add-peer-dependencies branch 2 times, most recently from ce1fd3d to ad5a6f8 Compare December 3, 2022 00:03
@Gudahtt Gudahtt changed the title WIP This is a test; please ignore Dec 3, 2022
@Gudahtt

This comment was marked as outdated.

@github-actions

This comment was marked as outdated.

@Gudahtt Gudahtt force-pushed the add-peer-dependencies branch from ad5a6f8 to 0e20a86 Compare December 3, 2022 00:45
@Gudahtt Gudahtt changed the title This is a test; please ignore Add peer dependencies between packages Dec 3, 2022
Packages now list `peerDependencies` to represent the expectation that
a specific package version is setup with the controller messenger. This
ensures that projects using these packages get a warning upon install
if they are using incompatible package versions.

This lets us safely make breaking changes to controller messenger
events and actions.

The constraints needed adjustment to allow the same dependency to be
declared both in `dependencies` and `peerDependencies`. The constraint
now ensures packages aren't listed both in `dependencies` and
`devDependencies` instead.
@Gudahtt Gudahtt force-pushed the add-peer-dependencies branch from 0e20a86 to 88b9611 Compare December 3, 2022 00:46
@Gudahtt Gudahtt marked this pull request as ready for review December 3, 2022 00:49
@Gudahtt Gudahtt requested a review from a team as a code owner December 3, 2022 00:49
Copy link
Contributor

@mcmire mcmire left a comment

Choose a reason for hiding this comment

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

Seems like a good solution. LGTM.

@Gudahtt Gudahtt merged commit 856d004 into main Dec 5, 2022
@Gudahtt Gudahtt deleted the add-peer-dependencies branch December 5, 2022 17:29
gantunesr pushed a commit that referenced this pull request Dec 8, 2022
Packages now list `peerDependencies` to represent the expectation that a
specific package version is setup with the controller messenger. This
ensures that projects using these packages get a warning upon install if
they are using incompatible package versions.

This lets us safely make breaking changes to controller messenger events
and actions.

The constraints needed adjustment to allow the same dependency to be
declared both in `dependencies` and `peerDependencies`. The constraint
now ensures packages aren't listed both in `dependencies` and
`devDependencies` instead.

- FIXED:

- The following packages now warn if a required package is not present:
    - `assets-controllers`
    - `gas-fee-controller`
    - `permission-controller`

**Checklist**

- [x] Tests are included if applicable
- [x] Any added code is fully documented
MajorLift pushed a commit that referenced this pull request Oct 11, 2023
Packages now list `peerDependencies` to represent the expectation that a
specific package version is setup with the controller messenger. This
ensures that projects using these packages get a warning upon install if
they are using incompatible package versions.

This lets us safely make breaking changes to controller messenger events
and actions.

The constraints needed adjustment to allow the same dependency to be
declared both in `dependencies` and `peerDependencies`. The constraint
now ensures packages aren't listed both in `dependencies` and
`devDependencies` instead.

- FIXED:

- The following packages now warn if a required package is not present:
    - `assets-controllers`
    - `gas-fee-controller`
    - `permission-controller`

**Checklist**

- [x] Tests are included if applicable
- [x] Any added code is fully documented
MajorLift pushed a commit that referenced this pull request Oct 11, 2023
Packages now list `peerDependencies` to represent the expectation that a
specific package version is setup with the controller messenger. This
ensures that projects using these packages get a warning upon install if
they are using incompatible package versions.

This lets us safely make breaking changes to controller messenger events
and actions.

The constraints needed adjustment to allow the same dependency to be
declared both in `dependencies` and `peerDependencies`. The constraint
now ensures packages aren't listed both in `dependencies` and
`devDependencies` instead.

- FIXED:

- The following packages now warn if a required package is not present:
    - `assets-controllers`
    - `gas-fee-controller`
    - `permission-controller`

**Checklist**

- [x] Tests are included if applicable
- [x] Any added code is fully documented
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