Can't make it run when using vitest.

[yoniaiz]

Hi!
I'm trying to run the tests using vitest and it does not seem to work.
I didn't create any vitest configuration, when i'm running the tests that use runCommand i'm getting the following error

stdout  (node:99331) [ERR_UNKNOWN_FILE_EXTENSION] Warning: TypeError
module: @oclif/core@4.0.31
task: findCommand (local)
plugin: test-reports-cli
root: /.../my-cli
code: ERR_UNKNOWN_FILE_EXTENSION
message: Unknown file extension ".ts" for .../src/commands/local.ts
See more details with DEBUG=*

Is there any guidance or known issues running the tests using vitest?

[kanadgupta]

@yoniaiz I've been able to get this library working with vitest. How are you executing your command? That looks like an error related to ts-node attempting to run ESM files. There are a lot of issues in the ts-node repo related to this: https://github.com/TypeStrong/ts-node/issues?q=ERR_UNKNOWN_FILE_EXTENSION+sort:reactions-+1-desc

I'd recommend using tsx or running your tests via npx vitest

[jpshack-at-palomar]

I've added an example repo that is generated using oclif generate but then swapped out mocha tests for vitest. See https://github.com/jpshack-at-palomar/oclif-with-vitest

[kamaal111]

Also important is to enable disableconsoleintercept

import { defineConfig } from 'vitest/config';

export default defineConfig({
  test: { disableConsoleIntercept: true },
});

or else Vitest will swallow stdout to display it in the terminal, causing tests that assert against the stdout from runCommand to fail.

[eyerean]

Very useful thread! I am still getting error: CLIError: command push not found in the return of runCommand in the test with vitest, where push is my custom command, similar to hello in the example repo above, which also fails for me locally 👀 . The test passes with jest. Any help is much appreciated!

[hariria]

I'm also having issues with the example repo above, except i ported it to a monorepo: #745

[jpshack-at-palomar]

See #745 (comment)

[jpshack-at-palomar]

@eyerean run tests with DEBUG=* and post your debug logs and we can see if something jumps out.

[eyerean]

Hello! I fixed it by passing our config to the method!

import { runCommand } from '@oclif/test';
import { Config } from '@oclif/core';
import { join } from 'path';
import foo from '../../foo';

vi.mock('../../foo', () => { default: vi.fn() });

describe(() => ({
  const config = await Config.load(join(__dirname, '../../config.ts'));

  afterEach(() => {
    vi.clearAllMocks();
  });

  it('passes', () => ({
      const { stdout } = await runCommand(
        'foo ./example.yaml  --id abc',
        config
      );
      expect(stdout).toContain('Computing updates to push');
  })
})

The DEBUG=* arg has a big output and I'd need more time to remove personal info 😅 Can't see anything obvious there though, like an error or a 'not found' message.