pokerogue/vitest.config.ts

/*
 * SPDX-FileCopyrightText: 2024-2025 Pagefault Games
 *
 * SPDX-License-Identifier: AGPL-3.0-only
 */

import { defineConfig } from "vitest/config";
import { BaseSequencer, type TestSpecification } from "vitest/node";
import { defaultConfig } from "./vite.config";

// biome-ignore lint/style/noDefaultExport: required for vitest
export default defineConfig(({ mode }) => ({
  ...defaultConfig,
  test: {
    reporters: process.env.GITHUB_ACTIONS
      ? ["github-actions", "./test/test-utils/reporters/custom-default-reporter.ts"]
      : ["./test/test-utils/reporters/custom-default-reporter.ts"],
    env: {
      TZ: "UTC",
    },
    testTimeout: 20_000,
    slowTestThreshold: 10_000,
    // TODO: Consider enabling
    // expect: {requireAssertions: true},
    setupFiles: ["./test/setup/font-face.setup.ts", "./test/setup/vitest.setup.ts", "./test/setup/matchers.setup.ts"],
    sequence: {
      sequencer: MySequencer,
    },
    includeTaskLocation: true,
    environment: "jsdom" as const,
    environmentOptions: {
      jsdom: {
        resources: "usable",
      },
    },
    typecheck: {
      tsconfig: "tsconfig.json",
      include: ["./test/types/**/*.{test,spec}{-|.}d.ts"],
    },
    threads: false,
    trace: true,
    restoreMocks: true,
    watch: false,
    coverage: {
      provider: "istanbul" as const,
      reportsDirectory: "coverage" as const,
      reporters: ["text-summary", "html"],
    },
    name: "main",
    include: ["./test/**/*.{test,spec}.ts"],
  },
  esbuild: {
    pure: mode === "production" ? ["console.log"] : [],
    keepNames: true,
  },
}));

//#region Helpers

/**
 * Class for sorting test files in the desired order.
 */
class MySequencer extends BaseSequencer {
  async sort(files: TestSpecification[]) {
    files = await super.sort(files);

    return files.sort((a, b) => {
      const aTestOrder = getTestOrder(a.moduleId);
      const bTestOrder = getTestOrder(b.moduleId);
      return aTestOrder - bTestOrder;
    });
  }
}

/**
 * A helper function for sorting test files in a desired order.
 *
 * A lower number means that a test file must be run earlier,
 * or else it breaks due to running tests with `--no-isolate.`
 */
function getTestOrder(testName: string): number {
  if (testName.includes("battle-scene.test.ts")) {
    return 1;
  }
  if (testName.includes("inputs.test.ts")) {
    return 2;
  }
  return 3;
}

//#endregion