Jest Command Based on Project

[jrock2004]

Not an issue per-say but wondering how people configure their jest command when you have projects that use npm, some that use yarn, etc... Do you change your config? Or is there a dynamic way?

return {
  "nvim-neotest/neotest",
  dependencies = {
    "haydenmeade/neotest-jest",
  },
  opts = function(_, opts)
    table.insert(
      opts.adapters,
      require("neotest-jest")({
        -- jestCommand = 'npm test --',
        jestCommand = "pnpm test --",
        -- jestCommand = "yarn test",
        -- jestConfigFile = 'custom.jest.config.ts',
        env = { CI = true },
        cwd = function()
          return vim.fn.getcwd()
        end,
      })
    )
  end,
}

Update 1:

I think when I made this ticket, I was bad in not adding a thought on a solution. What if we do something like not pass jestCommand and have another property that is something like:

...,
detectCommand = {
  enable = true,
  args = "test --"
},
...

With this, what the plugin can do is check in the root dir of project, is there a package-lock, or yarn.lock, or pnpm-lock? Then it could build the jestCommand from that

[JaapBarnhoorn]

Although not exactly what you are looking for, but you could use ni to automatically use the correct package manager.

For example running ‘nr test —‘ will run your test regardless of your package manager.

https://www.builder.io/blog/goodbye-package-manager-chaos

[jrock2004]

Although not exactly what you are looking for, but you could use ni to automatically use the correct package manager.

For example running ‘nr test —‘ will run your test regardless of your package manager.

https://www.builder.io/blog/goodbye-package-manager-chaos

Thanks, but was hoping to not have another toolchain. I might go with this but hoping for another solution

[Demianeen]

Does option with nr work for you? In my case tests are passing, but neotest still show that test failed:

I didn't add any fancy settings and everything works with jestCommand = "npm test --":

 {
	jestCommand = "nr test --",
	jestConfigFile = function()
		local file = vim.fn.expand("%:p")
		if string.find(file, "/packages/") then
			return string.match(file, "(.-/[^/]+/)src")
				.. "jest.config.ts"
		end

		return vim.fn.getcwd() .. "/jest.config.ts"
	end,
	env = { CI = true },
	cwd = function(path)
		return vim.fn.getcwd()
	end,
}

[MisanthropicBit]

Not sure if this is still relevant but the jestCommand option can also take a function accepting a single argument (the path of the current test). So you could do:

jestCommand = function(path)
    local cwd = vim.fn.getcwd()

    if vim.endswith(cwd, 'my-special-project') then
        return "yarn test"
    end

    return "npm test"
end

You might also be able to adapt some of the code for hasJestDependency or some of the util functions to locate the package.json file, or similar, and grab the test command directly.

[jrock2004]

@MisanthropicBit interesting. Maybe I could check for lock file.

[orenherman]

tried to alter @MisanthropicBit approach to accept an input as the jest command to run:

       jestCommand = function(_)
            return vim.ui.input({
              prompt = 'Enter jest command (default: test): ',
              default = 'test',
            }, function(input)
              return string.format('npm run %s --', input or 'test')
            end)
          end,

but got an error before prompt shows that prevents tests from running, could someone assist?

neotest-jest: vim/shared.lua:0: s: expected string, got nil
stack traceback:
        ...ocal/share/nvim/lazy/neotest/lua/neotest/client/init.lua:89: in function <...ocal/share/nvim/lazy/neotest/lua/neotest/client/init.lua:88>
        [C]: in function 'error'
        vim/shared.lua: in function 'validate'
        vim/shared.lua: in function 'gsplit'
        vim/shared.lua: in function 'split'
        ...l/share/nvim/lazy/neotest-jest/lua/neotest-jest/init.lua:406: in function 'build_spec'
        ...al/share/nvim/lazy/neotest/lua/neotest/client/runner.lua:76: in function '_run_tree'
        ...al/share/nvim/lazy/neotest/lua/neotest/client/runner.lua:65: in function <...al/share/nvim/lazy/neotest/lua/neotest/client/runner.lua:22>
        [C]: in function 'xpcall'
        ...ocal/share/nvim/lazy/neotest/lua/neotest/client/init.lua:84: in function 'run_tree'
        ...al/share/nvim/lazy/neotest/lua/neotest/consumers/run.lua:73: in function 'func'
        ...herman/.local/share/nvim/lazy/nvim-nio/lua/nio/tasks.lua:173: in function <.../.local/share/nvim/lazy/nvim-nio/lua/nio/tasks.lua:172>```

[MisanthropicBit]

@orenherman Slightly off-topic for the issue but if you read the documentation for vim.ui.input you'll see that it is an asynchronous function (accepts a callback), which means it returns immediately, and that it has no return value, which means it returns nil. Also the return from the callback goes to nowhere.

You can either use vim.fn.input which blocks neovim or we neotest-jest would need to support coroutines which you could then resume when the prompt is answered/cancelled which is what e.g. nvim-dap does to facilitate this kind of beaviour.

Hope that helps.