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

versionGroup.dependencyTypes takes "peerDependencies" instead of documented "peer" #96

Closed
dsilvasc opened this issue Sep 26, 2022 · 2 comments

Comments

@dsilvasc
Copy link
Contributor

dsilvasc commented Sep 26, 2022

Description

The readme says versionGroup.dependencyTypes accepts "peer" as a value. In this example, I have a violation this should catch but doesn't:

filter: webpack
versionGroups:
  - packages: ["**"]
    dependencies: ["webpack"]
    dependencyTypes: ["peer"]
    pinVersion: "5.73.0"
$ node node_modules/.bin/syncpack list-mismatches

Syncpack catches the mismatch if I use "peerDependencies" instead:

filter: webpack
versionGroups:
  - packages: ["**"]
    dependencies: ["webpack"]
    dependencyTypes: ["peerDependencies"]
    pinVersion: "5.73.0"
$ node node_modules/.bin/syncpack list-mismatches
= Version Group 1 ===============================================================
- webpack: 5.73.0 is the highest valid semver version in use
  5.74.0 in peerDependencies of common/tools/package.json

Suggested Solution

Either update the readme to say it should be peerDependencies, or update the versionGroup handler to handle "peer", or support both?

Help Needed

@JamieMason
Copy link
Owner

Thanks a lot @dsilvasc, you're right. This is a mistake in the readme and should be peerDependencies.

dsilvasc added a commit to dsilvasc/syncpack that referenced this issue Sep 27, 2022
@dsilvasc
Copy link
Contributor Author

Updating that in #98

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

Successfully merging a pull request may close this issue.

2 participants