Skip to content

chore(deps): make express an optional peer dependency#2815

Open
benmccann wants to merge 1 commit intoslackapi:mainfrom
benmccann:optional-peer
Open

chore(deps): make express an optional peer dependency#2815
benmccann wants to merge 1 commit intoslackapi:mainfrom
benmccann:optional-peer

Conversation

@benmccann
Copy link
Copy Markdown

Summary

closes #2814

Requirements (place an x in each [ ])

@benmccann benmccann requested a review from a team as a code owner March 8, 2026 15:56
@salesforce-cla
Copy link
Copy Markdown

salesforce-cla Bot commented Mar 8, 2026

Thanks for the contribution! Before we can merge this, we need @benmccann to sign the Salesforce Inc. Contributor License Agreement.

@benmccann
Copy link
Copy Markdown
Author

I have signed the CLA

Copy link
Copy Markdown
Contributor

@WilliamBergamin WilliamBergamin left a comment

Choose a reason for hiding this comment

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

Hi @benmccann thanks for bringing this up 💯

We need to make express a required peer dependency, making it an optional peer dependency might be considered a breaking change for some users, once resolved we should be good to merge

Comment thread package.json
Comment on lines +79 to +82
"peerDependenciesMeta": {
"express": {
"optional": true
}
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Since express is currently a dependency we can't make it an "optional" peerDependency since some users may be relying on it to transitively import express in their projects, this would cause a breaking change

Removing this section would make express a required peer-dependency (non-breaking change), this will allow users to explicitly exclude it from their projects with npm install --omit peer

@zimeg zimeg closed this Apr 12, 2026
@zimeg zimeg reopened this Apr 12, 2026
@zimeg zimeg added the dependencies Pull requests that update a dependency file label Apr 12, 2026
@benmccann
Copy link
Copy Markdown
Author

I guess we need to wait for the next major to merge this. The stale bot is trying to close the associated issue. Maybe it could be tagged as the next major to keep it open?

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

Labels

cla:signed dependencies Pull requests that update a dependency file semver:major

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Make express an optional peer dependency

3 participants