In an nx monorepo set the working directory to the package directory

[chriswheeldon-peakon]

When running tests in an nx monorepo (e.g. the monorepo-nx sample) the working directory is set to the monorepo root. However, when the tests are executed using nx (e.g. nx run-many -t test or nx test <package>) the working directory is set to the package directory.

Ideally the extension would be consistent with nx and change to the package directory before executing tests.

A workaround right now is to set up a multi-root vscode workspace with an entry for each package directory e.g. for the monorepo-nx sample:

{
  "folders": [
    {
      "path": "node"
    },
    {
      "path": "library"
    }
  ],
  "settings": {
    "vitest.enable": true
  }

[chriswheeldon-peakon]

cc @ffMathy - from our conversation on #231 🙏

[sheremet-va]

I don't think this is in the scope of this extension. Vitest itself doesn't support nx integration, it has its own workspace support.

[ffMathy]

But when we have a vitest.workspace.ts file, is Vitest's behavior then to set the root directory to the workspace folder, or the root folder?

Either way, I think I'll update the NX sample to mimick NX behavior more. I think it's doable.

[sheremet-va]

But when we have a vitest.workspace.ts file, is Vitest's behavior then to set the root directory to the workspace folder, or the root folder?

Either way, I think I'll update the NX sample to mimick NX behavior more. I think it's doable.

vitest.workspace.ts file should be supported, yes. We cannot support nx vitest behavior though.

[chriswheeldon-peakon]

@sheremet-va when you say "We cannot support nx vitest behavior though." do you mean in this extension or generally in vitest?

Having thought about it some more I can clearly see that this, as you said, is beyond the scope of this extension. The issue here would seem to stem from the fact that nx will change directory into the package directory when running package commands whereas vitest will not do this, even in the presence of a vitest workspaces file.

Is it worth opening a discussion on this in the vitest repo? From reading the vitest workspaces docs and in particular this line "Vitest will consider every folder in packages as a separate project even if it doesn't have a config file inside." (emphasis mine), I think it can be argued that vitest should change directory when executing package tests. My experience here is limited, but I think this would also be consistent with other monorepo tooling (f.ex nx, npm -w).

[sheremet-va]

Yes, it should change the directory for projects. And from my knowledge, it already does so (when you use the workspace feature of course). If it doesn't for you, I would suggest opening an issue with a reproduction in Vitest repo.

[sebastien-comeau]

I tried everything base on the Workspace guide and no success with our monorepo. Only the frontend directory is using vitest. We are using Playwright Test for VS Code extension and it works without any extra configurations.

[INFO 12:29:12 PM] The extension is not activated because no Vitest environment was detected.

[sheremet-va]

This is the behavior of Vitest and not the extension. The vitest.workspace file doesn't change the working directory of its projects because it's not supported in workers. You can bypass this by using pool: 'forks' and adding a setup file that changes the directory like this for example:

import { resolve } from 'node:path'
process.chdir(resolve('../project-1'))

[chriswheeldon-peakon]

@sheremet-va I don't that is viable as you are not allow to chdir in a worker.

[sheremet-va]

@sheremet-va I don't that is viable as you are not allow to chdir in a worker.

Sorry, I forgot to mention to also use pool: 'forks'.