avajs/ava

Support `.ava` cacheDir for better compatibility with Yarn PnP

Open

#3226 opened on Jul 28, 2023

View on GitHub
 (3 comments) (0 reactions) (0 assignees)JavaScript (20,600 stars) (1,408 forks)batch import
enhancementhelp wantedscope:internals

Description

Hello,

We're using Yarn 3 with PnP in our mono-repo, and find that ava is creating unwanted node_modules directories in our workspace (with node_modules/.cache/ava/failing-tests.json) This is a result of https://github.com/avajs/ava/blob/f047694d86a8ee7af2e998baf28812770e9ea71e/lib/cli.js#L256

Sometimes the existence of node_modules confuses the pnp patched executables (eg. eslint), so the mere existence of node_modules can sometimes cause issues with things working reliable.

It would be great if you supported some manner of specifying the cache directory or simply defaulted to projectDir/.ava and recommended adding .ava to the .gitignore.

Thanks!

Contributor guide

Tech stack
nodejs
Domain
testing
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Node.jsYarn PnPAVA core
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Review the cache directory setup in lib/cli.js at line 256. Understand how the path is determined and consider adding a CLI option or environment variable to specify an alternative cache directory, defaulting to `.ava` in the project root. Ensure the change does not break existing behavior and update documentation and `.gitignore` recommendations accordingly.