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

feat(cli): check peer dependencies in root package #101

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,6 @@ dist/
.cache
public
scratchings.js

# IDEs
.idea
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,17 @@ type ErrorType = {

export default makeCheck<ErrorType>({
type: "all",
validate: (workspace, allWorkspaces) => {
let errors: ErrorType[] = [];
let peerDeps = workspace.packageJson.peerDependencies;
let devDeps = workspace.packageJson.devDependencies || {};
validate: (workspace, allWorkspaces, rootWorkspace) => {
const errors: ErrorType[] = [];
const peerDeps = workspace.packageJson.peerDependencies;
const devDeps = workspace.packageJson.devDependencies || {};
const rootDeps = rootWorkspace.packageJson.dependencies || {};

if (peerDeps) {
for (let depName in peerDeps) {
if (!devDeps[depName]) {
const devOrRootDep = devDeps[depName] || rootDeps[depName];

if (!devOrRootDep) {
let highestRanges = getHighestExternalRanges(allWorkspaces);
let idealDevVersion = highestRanges.get(depName);
let isInternalDependency = allWorkspaces.has(depName);
Expand All @@ -39,12 +43,12 @@ export default makeCheck<ErrorType>({
idealDevVersion
});
} else if (
semver.validRange(devDeps[depName]) &&
semver.validRange(devOrRootDep) &&
// TODO: we should probably error when a peer dep has an invalid range (in a seperate rule)
// (also would be good to do a bit more validation instead of just ignoring invalid ranges for normal dep types)
semver.validRange(peerDeps[depName]) &&
!upperBoundOfRangeAWithinBoundsOfB(
devDeps[depName],
devOrRootDep,
peerDeps[depName]
)
) {
Expand All @@ -58,7 +62,7 @@ export default makeCheck<ErrorType>({
workspace,
dependencyName: depName,
peerVersion: peerDeps[depName],
devVersion: devDeps[depName],
devVersion: devOrRootDep,
idealDevVersion
});
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -181,4 +181,19 @@ describe("invalid dev and peer dependency", () => {
let errors = makeCheck.validate(pkg1, ws, rootWorkspace, {});
expect(errors).toHaveLength(0);
});

it("should work when peer dependency is in root dependencies", () => {
let ws = getWS();
let pkg1 = ws.get("pkg-1")!;

pkg1.packageJson.peerDependencies = {
"external-dep": "^1.0.0"
};
rootWorkspace.packageJson.dependencies = {
"external-dep": "^1.0.0"
};

let errors = makeCheck.validate(pkg1, ws, rootWorkspace, {});
expect(errors).toHaveLength(0);
});
});