Skip to content

feat: add shouldIncludeDevDependencies to buildDAG #345

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.

Sign up for GitHub

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

Open
kellyselden wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add shouldIncludeDevDependencies to buildDAG #345

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 16 additions & 3 deletions src/build-dag.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,14 @@
const dependencyTypes = require('./dependency-types');
const { collectPackages } = require('./build-dep-graph');

function doesDependOnPackage(_package, packageName) {
function doesDependOnPackage(_package, packageName, {
shouldIncludeDevDependencies,
}) {
for (let dependencyType of dependencyTypes) {
if (!shouldIncludeDevDependencies && dependencyType === 'devDependencies') {
return;
}

if (Object.keys(_package[dependencyType]).includes(packageName)) {
return {
dependencyType,
Expand All @@ -19,6 +25,7 @@ function thirdPass({
group,
branch,
visitedNodes,
shouldIncludeDevDependencies,
}) {
let currentPackageName = group.node.packageName;

Expand All @@ -32,7 +39,9 @@ function thirdPass({
let {
dependencyType,
dependencyRange,
} = doesDependOnPackage(_package, currentPackageName) || {};
} = doesDependOnPackage(_package, currentPackageName, {
shouldIncludeDevDependencies,
}) || {};

if (dependencyType) {
let parent = group;
Expand Down Expand Up @@ -73,6 +82,7 @@ function thirdPass({
group: newGroup,
branch: newBranch,
visitedNodes,
shouldIncludeDevDependencies,
});
}
}
Expand Down Expand Up @@ -113,7 +123,9 @@ function createPackageNode({
};
}

function buildDAG(workspaceMeta, packageName) {
function buildDAG(workspaceMeta, packageName, {
shouldIncludeDevDependencies = true,
} = {}) {
let {
newGroup,
newBranch,
Expand All @@ -130,6 +142,7 @@ function buildDAG(workspaceMeta, packageName) {
group: newGroup,
branch: newBranch,
visitedNodes,
shouldIncludeDevDependencies,
});

return newGroup;
Expand Down
78 changes: 78 additions & 0 deletions test/build-dag-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -294,4 +294,82 @@ describe(buildDAG, function() {
},
}));
});

describe('devDependencies', function() {
beforeEach(function() {
fixturify.writeSync(tmpPath, {
'packages': {
'package-a': {
'package.json': stringifyJson({
'name': '@scope/package-a',
'version': '1.0.0',
'devDependencies': {
'@scope/package-b': '1.0.0',
},
}),
},
'package-b': {
'package.json': stringifyJson({
'name': '@scope/package-b',
'version': '1.0.0',
'dependencies': {
'@scope/package-a': '1.0.0',
},
}),
},
},
'package.json': stringifyJson({
'private': true,
'workspaces': [
'packages/*',
],
}),
});
});

it('can stop traversing devDependencies if enabled', async function() {
let dag = buildDAG(await buildDepGraph({ workspaceCwd: tmpPath }), '@scope/package-a', { shouldIncludeDevDependencies: false });

expect(dag).to.match(this.match({
node: {
packageName: '@scope/package-a',
dependents: [
this.match({
dependencyType: 'dependencies',
node: {
packageName: '@scope/package-b',
dependents: [],
},
}),
],
},
}));
});

it('doesn\'t stop traversing devDependencies by default', async function() {
let dag = buildDAG(await buildDepGraph({ workspaceCwd: tmpPath }), '@scope/package-a');

expect(dag).to.match(this.match({
node: {
packageName: '@scope/package-a',
dependents: [
this.match({
dependencyType: 'dependencies',
node: {
packageName: '@scope/package-b',
dependents: [
this.match({
dependencyType: 'devDependencies',
node: {
packageName: '@scope/package-a',
},
}),
],
},
}),
],
},
}));
});
});
});