Skip to content
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
5 changes: 5 additions & 0 deletions .changeset/curly-needles-rest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@rnx-kit/tools-node": patch
---

Add a `stopAt` option to limit `findPackageDependencyDir` searches.
9 changes: 8 additions & 1 deletion packages/tools-node/src/package.ts
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,11 @@ export type FindPackageDependencyOptions = {
*/
startDir?: string;

/**
* Optional directory where the search should stop.
*/
stopAt?: string;

/**
* Optional flag controlling whether symlinks can be found. Defaults to `true`.
* When `false`, and the package dependency directory is a symlink, it will not
Expand Down Expand Up @@ -201,10 +206,12 @@ export function findPackageDependencyDir(
): string | undefined {
const pkgName =
typeof ref === "string" ? ref : path.join(ref.scope ?? "", ref.name);
const startDir = options?.startDir ?? process.cwd();
const packageDir = findUp(
path.join("node_modules", pkgName),
{
startDir: options?.startDir,
startDir,
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Can we revert this?

stopAt: options?.stopAt,
type: "directory",
allowSymlinks: options?.allowSymlinks,
},
Expand Down
36 changes: 36 additions & 0 deletions packages/tools-node/test/package.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -212,4 +212,40 @@ describe("Node > Package", () => {
);
equal(pkgDir, undefined);
});

it("findPackageDependencyDir() does not search beyond stopAt", () => {
const rootDir = path.join(testTempDir, "repo");
const workspaceDir = path.join(rootDir, "packages", "app");
const externalDir = path.join(testTempDir, "node_modules", "external");
const localDir = path.join(
rootDir,
"packages",
"node_modules",
"local"
);
const blockedLocalDir = path.join(rootDir, "node_modules", "blocked");

fs.mkdirSync(workspaceDir, { recursive: true });
fs.mkdirSync(externalDir, { recursive: true });
fs.mkdirSync(localDir, { recursive: true });
fs.mkdirSync(blockedLocalDir, { recursive: true });

const blockedPkgDir = findPackageDependencyDir("external", {
startDir: workspaceDir,
stopAt: rootDir,
});
equal(blockedPkgDir, undefined);

const localPkgDir = findPackageDependencyDir("local", {
startDir: workspaceDir,
stopAt: rootDir,
});
equal(localPkgDir, localDir);

const blockedLocalPkgDir = findPackageDependencyDir("blocked", {
startDir: workspaceDir,
stopAt: rootDir,
});
equal(blockedLocalPkgDir, undefined);
});
});