TypeScript と Jest で "Cannot find name 'describe'" エラーが発生する原因と解決策

2024-04-02

TypeScript と Jest で発生する "Cannot find name 'describe'" エラーの解決策

原因

このエラーは、以下のいずれかの原因で発生します。

Jest の型定義がインストールされていない
tsconfig.json ファイルの設定が正しくない
テストファイルが tsconfig.json ファイルから除外されている

解決策

このエラーを解決するには、以下の手順を試してください。

Jest の型定義は、@types/jest パッケージを使用してインストールできます。

npm install --save-dev @types/jest

tsconfig.json ファイルの types プロパティに、jest を追加する必要があります。

{
  "compilerOptions": {
    "target": "es5",
    "module": "commonjs",
    "lib": ["dom", "es5", "es6", "es2017", "es2018", "es2019", "es2020", "es2021", "es2022", "esnext"],
    "types": ["node", "jest"]
  }
}

tsconfig.json ファイルの exclude プロパティに、テストファイルが含まれていないことを確認する必要があります。

{
  "compilerOptions": {
    "target": "es5",
    "module": "commonjs",
    "lib": ["dom", "es5", "es6", "es2017", "es2018", "es2019", "es2020", "es2021", "es2022", "esnext"],
    "types": ["node", "jest"]
  },
  "exclude": ["node_modules", "coverage"]
}

これらの手順を試してもエラーが解決しない場合は、以下の点を確認してください。

Jest と TypeScript のバージョンが互換性があることを確認してください。
IDE や TypeScript サービスを再起動してみてください。

TypeScript と Jest を使用したサンプルコード

greeter.ts

export function greet(name: string): string {
  return `Hello, ${name}!`;
}

import { greet } from "./greeter";

describe("greeter", () => {
  it("should return a greeting with the given name", () => {
    const name = "John Doe";
    const greeting = greet(name);

    expect(greeting).toBe(`Hello, ${name}!`);
  });
});

このコードを実行するには、以下のコマンドを使用します。

jest

テストが成功すると、以下の出力が表示されます。

PASS ./greeter.test.ts
✓ should return a greeting with the given name (10ms)

Test Suites: 1 passed, 1 total
Tests:       1 passed, 1 total
Snapshots:   0 total
Time:        2.33s
Ran all test suites.

TypeScript と Jest で "describe" エラーを解決するその他の方法

--noImplicitAny フラグを使用する

tsc コマンドを実行する際に --noImplicitAny フラグを指定すると、暗黙的な any 型の使用を警告してくれます。この警告は、describe 関数のような型定義が不明確な関数を使用している場合に役立ちます。

tsc --noImplicitAny greeter.test.ts

describe 関数を import する

Jest の describe 関数を明示的に import することで、エラーを回避することができます。

import { describe } from "@jest/globals";

describe("greeter", () => {
  it("should return a greeting with the given name", () => {
    const name = "John Doe";
    const greeting = greet(name);

    expect(greeting).toBe(`Hello, ${name}!`);
  });
});

テストファイルの拡張子を .js に変更する

Jest は、デフォルトで .ts ファイルではなく .js ファイルをテストします。テストファイルの拡張子を .js に変更することで、エラーを回避することができます。

greeter.js

import { greet } from "./greeter";

describe("greeter", () => {
  it("should return a greeting with the given name", () => {
    const name = "John Doe";
    const greeting = greet(name);

    expect(greeting).toBe(`Hello, ${name}!`);
  });
});

typescript jestjs