vitest tsconfig path failed to load url in node js (express)

[darylescode]

I would like to perform some unit testing in Node.js (Express) using Vitest. I'm wondering if there might be a conflict between the two, as I have installed both tsconfig-path and vite-tsconfig-path. I tried this from the discussion #3042 but it didn't work for me.

All my files with import paths like @/controller/auth.controller.ts work fine, and the server runs smoothly. However, I'm encountering a problem only with the testing files. It says:

folder structure:

my-project/
│
├── server/     
│   ├── dist             
│   ├── node_modules/         
│   ├── src/      
│   │   ├── __test__/             
│   │   ├── controllers/      
│   │   ├── models/           
│   │   ├── routes/           
│   │   ├── utils/            
│   │   ├── index.js            
│   │   └── vitest.config.ts          
│   ├── package.json          
│   ├── package-lock.json     
│   └── tsconfig.json
│
├── client/                 
│   ├── node_modules/         
│   ├── public/               
│   ├── src/                  
│   │   ├── components/       
│   │   ├── pages/            
│   │   ├── utils/             
│   │   ├── app.js
│   │   └── index.js        
│   ├── package.json          
│   ├── package-lock.json     
│   └── ...

tsconfig.json

{
  "extends": "ts-node/node16/tsconfig.json",
  "ts-node": {
    "transpileOnly": true,
    "files": true,
  },
  "compilerOptions": {
    /* Base Options: */
    "target": "es2022",
    "moduleDetection": "force",
    "moduleResolution": "NodeNext",
    "module": "NodeNext",
    "skipLibCheck": true,
    "esModuleInterop": true,
    "isolatedModules": true,
    "resolveJsonModule": true,
    "lib": ["es2022"],
    "types": ["vitest/globals"],

    /* Strictness */
    "strict": true,
    "noUncheckedIndexedAccess": true,

    /* Module Resolution Options: */
    "rootDir": "src",
    "outDir": "dist",
    "baseUrl": ".",
    "paths": {
      "@/*": [
        "src/*",
      ]
    }
  },
  "exclude": ["node_modules"]
}

vitest.config.ts

import path from "path";
import tsconfigPaths from "vite-tsconfig-paths";
export default import("vitest/config").then(({ defineConfig, configDefaults }) => {
  defineConfig({
    resolve: {
      alias: [
        {
          find: "@",
          replacement: path.resolve(__dirname, "./src"),
        },
      ],
    },
    test: {
      ...configDefaults,
      globals: true,
    },
    plugins: [tsconfigPaths()],
  });
});

package.json

{
  "name": "server",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "type": "commonjs",
  "scripts": {
    "test": "vitest run",
    "test:watch": "vitest",
    "test:coverage": "vitest run --coverage",
    "build": "tsc",
    "start:dev": "SET NODE_ENV=development && ts-node-dev --watch -r tsconfig-paths/register src/index.ts"
  },
  ...
}

auth.spec.ts

import UserRepository                                from "@/repository/user/user.repository.impl";
import { describe, it, expect, vi, Mock, afterEach } from "vitest";

describe("UserRepository", () => {
  test("should create an instance of UserRepository", () => {
    const userRepository: UserRepository = new UserRepository();
    expect(userRepository).toBeInstanceOf(UserRepository);
  });
});

[ygqygq2]

Looks like your alias didn't work, here it's my config.

/// <reference types="vitest" />
import path from 'path';

import { defineConfig } from 'vite';

export default defineConfig({
  plugins: [],
  resolve: {
    alias: [
      {
        find: /^~(.+)/,
        replacement: path.join(process.cwd(), 'node_modules/$1'),
      },
      {
        find: /^@\/(.+)/,
        replacement: path.join(process.cwd(), 'src/$1'),
      },
    ],
  },
  test: {
    include: ['src/test/unit/**/*.spec.ts'],
    coverage: {
      exclude: ['node_modules', 'out', 'src/test', 'src/typings', '.vscode-test'],
    },
  },
});

[darylescode]

Thank you for the reply. I tried and copy your code. It might different from me because at tsconfig.ts both moduleResolution and module is being set to NodeNext.

as for the vitest config, it didn't work. What I am missing?:

EDIT: I also removed tsconfigPaths from plugins just now, but it didn't fixed as well.

/// <reference types="vitest" />
import path                from "path";
import { UserConfig } from "vitest";

export default import("vitest/config").then(({ defineConfig, configDefaults }) => {
  return defineConfig({
    resolve: {
      alias: [
        {
          find: /^@(.+)/,
          replacement: path.join(process.cwd(), "src"),
        },
      ],
    },
    test: {
      ...configDefaults,
      include: ['src/__test__/unit/**/*.spec.ts'],
      coverage: {
        exclude: ['node_modules'],
      },
      globals: true,
      environment: "node"
    },
    plugins: [],
  }) as UserConfig;
});

[ygqygq2]

You'd better not put spaces in your path, then try to confirm the issue of aliases.
My project uses vitest, you can have a look.
https://github.com/ygqygq2/turbo-console-log

[darylescode]

Thank you so much! I just checked your project and aligned the structure with yours. What fixed it was moving the tsconfig.json file to the root folder and then adding include": ["./src","../vitest.config.ts"] to it then it works.

May I ask how to exclude the files following role-based naming convention such auth.route.ts like in the below :

vitest.config.ts
it doesn't exclude the files I don't want to be included

/// <reference types="vitest" />
import path                from "path";
import { UserConfig } from "vitest";

export default import("vitest/config").then(({ defineConfig, configDefaults }) => {
  return defineConfig({
    resolve: {
      alias: [
        {
          find: /^@(.+)/,
          replacement: path.join(process.cwd(), "src"),
        },
      ],
    },
    test: {
      ...configDefaults,
      include: ["src/__test__/unit/**/*.spec.ts"],
      coverage: {
        exclude: [
          ...configDefaults.exclude,
          "node_modules",
          "**/router/**",
          "./src/router/*.route.ts",
        ],
      },
      globals: true,
      environment: "node",
    },
    plugins: [],
  }) as UserConfig;
});

[ygqygq2]

You Don't know if your paths will match. You can relax the rules and refine them. And see if the root setting in vite.config has any effect.