Fix monorepo support in project root detection

Fixes #312

Author: sindresorhus

package.json

@@ -48,7 +48,6 @@
 		"espree": "^11.1.0",
 		"espurify": "^3.2.0",
 		"micro-spelling-correcter": "^1.1.1",
-		"package-directory": "^8.2.0",
 		"resolve-from": "^5.0.0"
 	},
 	"devDependencies": {

test/util.js

@@ -1,9 +1,10 @@
 import fs from 'node:fs/promises';
 import path from 'node:path';
+import process from 'node:process';
 import {createRequire} from 'node:module';
 import test from 'ava';
 import resolveFrom from 'resolve-from';
-import util from '../util.js';
+import util, {findProjectRoot} from '../util.js';
 
 const require = createRequire(import.meta.url);
 const packageJson = require('../package.json');
@@ -30,27 +31,211 @@ test.serial('loadAvaHelper retries lookup when helper becomes available', async
 	});
 
 	const testFilename = path.join(fixtureRootDirectory, 'example.test.js');
-	await fs.writeFile(path.join(fixtureRootDirectory, 'package.json'), '{"name":"fixture"}');
+	await fs.writeFile(path.join(fixtureRootDirectory, 'package.json'), '{"name":"fixture","ava":{}}');
 	await fs.writeFile(testFilename, '');
 
 	const overrides = {files: ['test.js']};
 	const helperPath = path.join(fixtureRootDirectory, 'eslint-plugin-helper.js');
 	await fs.writeFile(helperPath, 'module.exports = {load(rootDirectory, options) { return {rootDirectory, options}; }};');
 
 	const originalResolveFromSilent = resolveFrom.silent;
-	let numberOfResolveCalls = 0;
-	resolveFrom.silent = () => {
-		numberOfResolveCalls += 1;
-		return numberOfResolveCalls === 1 ? undefined : helperPath;
-	};
+	let isHelperAvailable = false;
+	resolveFrom.silent = () => isHelperAvailable ? helperPath : undefined;
 
 	t.teardown(() => {
 		resolveFrom.silent = originalResolveFromSilent;
 	});
 
 	t.is(util.loadAvaHelper(testFilename, overrides), undefined);
+	isHelperAvailable = true;
 
 	const helper = util.loadAvaHelper(testFilename, overrides);
-	t.is(numberOfResolveCalls, 2);
 	t.deepEqual(helper, {rootDirectory: fixtureRootDirectory, options: overrides});
 });
+
+test.serial('loadAvaHelper resolves helper from sub-package when config is at workspace root', async t => {
+	const workspaceRootDirectory = await fs.mkdtemp(path.join(import.meta.dirname, 'tmp-load-ava-helper-workspace-'));
+	t.teardown(async () => {
+		await fs.rm(workspaceRootDirectory, {recursive: true, force: true});
+	});
+
+	await fs.writeFile(path.join(workspaceRootDirectory, 'package.json'), '{"name":"workspace","ava":{}}');
+	const packageDirectory = path.join(workspaceRootDirectory, 'packages', 'pkg-a');
+	await fs.mkdir(packageDirectory, {recursive: true});
+	await fs.writeFile(path.join(packageDirectory, 'package.json'), '{"name":"pkg-a"}');
+	const testFilename = path.join(packageDirectory, 'test', 'example.test.js');
+	await fs.mkdir(path.join(packageDirectory, 'test'), {recursive: true});
+	await fs.writeFile(testFilename, '');
+
+	const helperPath = path.join(workspaceRootDirectory, 'eslint-plugin-helper.js');
+	await fs.writeFile(helperPath, 'module.exports = {load(rootDirectory, options) { return {rootDirectory, options}; }};');
+
+	const originalResolveFromSilent = resolveFrom.silent;
+	resolveFrom.silent = fromDirectory => {
+		if (fromDirectory === workspaceRootDirectory) {
+			return undefined;
+		}
+
+		return fromDirectory.startsWith(packageDirectory) ? helperPath : undefined;
+	};
+
+	t.teardown(() => {
+		resolveFrom.silent = originalResolveFromSilent;
+	});
+
+	const overrides = {files: ['test.js']};
+	const helper = util.loadAvaHelper(testFilename, overrides);
+	t.deepEqual(helper, {rootDirectory: workspaceRootDirectory, options: overrides});
+});
+
+test.serial('loadAvaHelper resolves hoisted helper outside sub-package root', async t => {
+	const workspaceRootDirectory = await fs.mkdtemp(path.join(import.meta.dirname, 'tmp-load-ava-helper-hoisted-'));
+	t.teardown(async () => {
+		await fs.rm(workspaceRootDirectory, {recursive: true, force: true});
+	});
+
+	// Sub-package has its own AVA config, but AVA is hoisted to the monorepo root.
+	await fs.writeFile(path.join(workspaceRootDirectory, 'package.json'), '{"name":"workspace"}');
+	const packageDirectory = path.join(workspaceRootDirectory, 'packages', 'pkg-a');
+	await fs.mkdir(packageDirectory, {recursive: true});
+	await fs.writeFile(path.join(packageDirectory, 'package.json'), '{"name":"pkg-a","ava":{}}');
+	const testFilename = path.join(packageDirectory, 'test', 'example.test.js');
+	await fs.mkdir(path.join(packageDirectory, 'test'), {recursive: true});
+	await fs.writeFile(testFilename, '');
+
+	// The helper lives at the workspace root (hoisted node_modules), outside the sub-package.
+	const helperPath = path.join(workspaceRootDirectory, 'node_modules', 'ava', 'eslint-plugin-helper.js');
+	await fs.mkdir(path.dirname(helperPath), {recursive: true});
+	await fs.writeFile(helperPath, 'module.exports = {load(rootDirectory, options) { return {rootDirectory, options}; }};');
+
+	const originalResolveFromSilent = resolveFrom.silent;
+	resolveFrom.silent = () => helperPath;
+
+	t.teardown(() => {
+		resolveFrom.silent = originalResolveFromSilent;
+	});
+
+	const overrides = {files: ['test.js']};
+	const helper = util.loadAvaHelper(testFilename, overrides);
+	t.deepEqual(helper, {rootDirectory: packageDirectory, options: overrides});
+});
+
+const createFixtureDirectory = async t => {
+	const directory = await fs.mkdtemp(path.join(import.meta.dirname, 'tmp-find-root-'));
+	t.teardown(async () => {
+		await fs.rm(directory, {recursive: true, force: true});
+	});
+
+	return directory;
+};
+
+test('findProjectRoot: finds directory with ava config in package.json', async t => {
+	const root = await createFixtureDirectory(t);
+	await fs.writeFile(path.join(root, 'package.json'), '{"name":"fixture","ava":{}}');
+	const testFile = path.join(root, 'test', 'foo.test.js');
+	await fs.mkdir(path.join(root, 'test'), {recursive: true});
+	await fs.writeFile(testFile, '');
+
+	t.is(findProjectRoot(testFile), root);
+});
+
+test('findProjectRoot: finds directory with ava.config.js', async t => {
+	const root = await createFixtureDirectory(t);
+	await fs.writeFile(path.join(root, 'package.json'), '{"name":"fixture"}');
+	await fs.writeFile(path.join(root, 'ava.config.js'), '');
+	const testFile = path.join(root, 'test', 'foo.test.js');
+	await fs.mkdir(path.join(root, 'test'), {recursive: true});
+	await fs.writeFile(testFile, '');
+
+	t.is(findProjectRoot(testFile), root);
+});
+
+test('findProjectRoot: finds directory with ava.config.cjs', async t => {
+	const root = await createFixtureDirectory(t);
+	await fs.writeFile(path.join(root, 'package.json'), '{"name":"fixture"}');
+	await fs.writeFile(path.join(root, 'ava.config.cjs'), '');
+	const testFile = path.join(root, 'test', 'foo.test.js');
+	await fs.mkdir(path.join(root, 'test'), {recursive: true});
+	await fs.writeFile(testFile, '');
+
+	t.is(findProjectRoot(testFile), root);
+});
+
+test('findProjectRoot: finds directory with ava.config.mjs', async t => {
+	const root = await createFixtureDirectory(t);
+	await fs.writeFile(path.join(root, 'package.json'), '{"name":"fixture"}');
+	await fs.writeFile(path.join(root, 'ava.config.mjs'), '');
+	const testFile = path.join(root, 'test', 'foo.test.js');
+	await fs.mkdir(path.join(root, 'test'), {recursive: true});
+	await fs.writeFile(testFile, '');
+
+	t.is(findProjectRoot(testFile), root);
+});
+
+test('findProjectRoot: monorepo - finds root with ava config over sub-package', async t => {
+	const root = await createFixtureDirectory(t);
+	await fs.writeFile(path.join(root, 'package.json'), '{"name":"monorepo","ava":{}}');
+	const packageDir = path.join(root, 'packages', 'pkg-a');
+	await fs.mkdir(packageDir, {recursive: true});
+	await fs.writeFile(path.join(packageDir, 'package.json'), '{"name":"pkg-a"}');
+	const testFile = path.join(packageDir, 'test', 'foo.test.js');
+	await fs.mkdir(path.join(packageDir, 'test'), {recursive: true});
+	await fs.writeFile(testFile, '');
+
+	t.is(findProjectRoot(testFile), root);
+});
+
+test('findProjectRoot: config file closer to file wins over package.json ava key higher up', async t => {
+	const root = await createFixtureDirectory(t);
+	await fs.writeFile(path.join(root, 'package.json'), '{"name":"monorepo","ava":{}}');
+	const subDir = path.join(root, 'packages', 'pkg-a');
+	await fs.mkdir(subDir, {recursive: true});
+	await fs.writeFile(path.join(subDir, 'package.json'), '{"name":"pkg-a"}');
+	await fs.writeFile(path.join(subDir, 'ava.config.js'), '');
+	const testFile = path.join(subDir, 'test', 'foo.test.js');
+	await fs.mkdir(path.join(subDir, 'test'), {recursive: true});
+	await fs.writeFile(testFile, '');
+
+	t.is(findProjectRoot(testFile), subDir);
+});
+
+test('findProjectRoot: skips package.json without ava key', async t => {
+	const root = await createFixtureDirectory(t);
+	await fs.writeFile(path.join(root, 'package.json'), '{"name":"fixture"}');
+	await fs.mkdir(path.join(root, '.git'));
+	const testFile = path.join(root, 'test', 'foo.test.js');
+	await fs.mkdir(path.join(root, 'test'), {recursive: true});
+	await fs.writeFile(testFile, '');
+
+	// The fixture package.json has no "ava" key, but traversal should stop
+	// at the repository boundary and return the nearest package root.
+	const result = findProjectRoot(testFile);
+	t.is(result, root);
+});
+
+test('findProjectRoot: does not escape repository boundary', async t => {
+	const outsideDirectory = await createFixtureDirectory(t);
+	await fs.writeFile(path.join(outsideDirectory, 'package.json'), '{"name":"outside","ava":{}}');
+	await fs.writeFile(path.join(outsideDirectory, 'ava.config.js'), '');
+
+	const root = path.join(outsideDirectory, 'project');
+	await fs.mkdir(root, {recursive: true});
+	await fs.mkdir(path.join(root, '.git'));
+	await fs.writeFile(path.join(root, 'package.json'), '{"name":"fixture"}');
+	const testFile = path.join(root, 'test', 'foo.test.js');
+	await fs.mkdir(path.join(root, 'test'), {recursive: true});
+	await fs.writeFile(testFile, '');
+
+	t.is(findProjectRoot(testFile), root);
+});
+
+test('findProjectRoot: handles relative filename', async t => {
+	const root = await createFixtureDirectory(t);
+	await fs.writeFile(path.join(root, 'package.json'), '{"name":"fixture","ava":{}}');
+	const testFile = path.join(root, 'test', 'foo.test.js');
+	await fs.mkdir(path.join(root, 'test'), {recursive: true});
+	await fs.writeFile(testFile, '');
+
+	const relativeTestFile = path.relative(process.cwd(), testFile);
+	t.is(findProjectRoot(relativeTestFile), root);
+});

util.js

@@ -1,16 +1,53 @@
+import fs from 'node:fs';
 import path from 'node:path';
 import {createRequire} from 'node:module';
-import {packageDirectorySync} from 'package-directory';
 import resolveFrom from 'resolve-from';
 
 const require = createRequire(import.meta.url);
 const pkg = require('./package.json');
 
+const avaConfigFiles = ['ava.config.js', 'ava.config.cjs', 'ava.config.mjs'];
+
+// Walk up from the file to find the directory where AVA is configured.
+// In a monorepo, the nearest package.json may belong to a sub-package
+// while AVA is configured at the monorepo root.
+export const findProjectRoot = filename => {
+	let directory = path.resolve(path.dirname(filename));
+	const {root} = path.parse(directory);
+	let nearestPackageDirectory;
+
+	while (directory !== root) {
+		if (avaConfigFiles.some(configFile => fs.existsSync(path.join(directory, configFile)))) {
+			return directory;
+		}
+
+		const packageJsonPath = path.join(directory, 'package.json');
+		if (fs.existsSync(packageJsonPath)) {
+			nearestPackageDirectory ??= directory;
+
+			try {
+				const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
+				if ('ava' in packageJson) {
+					return directory;
+				}
+			} catch {}
+		}
+
+		if (fs.existsSync(path.join(directory, '.git'))) {
+			break;
+		}
+
+		directory = path.dirname(directory);
+	}
+
+	return nearestPackageDirectory;
+};
+
 /* c8 ignore start -- requires a real project with AVA's eslint-plugin-helper installed */
 const avaHelperCache = new Map();
 
 export const loadAvaHelper = (filename, overrides) => {
-	const rootDirectory = packageDirectorySync({cwd: filename});
+	const rootDirectory = findProjectRoot(filename);
 	if (!rootDirectory) {
 		return undefined;
 	}
@@ -25,7 +62,8 @@ export const loadAvaHelper = (filename, overrides) => {
 		avaHelperCache.clear();
 	}
 
-	const avaHelperPath = resolveFrom.silent(rootDirectory, 'ava/eslint-plugin-helper');
+	const avaHelperPath = resolveFrom.silent(path.resolve(path.dirname(filename)), 'ava/eslint-plugin-helper')
+		?? resolveFrom.silent(rootDirectory, 'ava/eslint-plugin-helper');
 	if (!avaHelperPath) {
 		return undefined;
 	}