AVAでswc-nodeを使ってTypeScriptで書かれたテストを実行するための設定

SWC, swc-nodeとは

SWCはRustで実装された高速なTypeScript/JavaScriptのトランスパイラで、BabelのようにTypeScript/JavaScriptのファイルを入力して、そこから様々な環境で動くJavaScriptファイルを生成することができます。

設定を行うことで、以下のようにtsconfig.jsonのpathsの設定を利用したインポートを、相対パスでのimport/requireに書き換えてくれる機能が標準で備わっている点を特に個人的に便利だと感じています。¹

src/hoge/fuga/piyo.ts

import { hogera } from "@/moge/hogera";

↓ トランスパイルされたJSファイル

dist/hoge/fuga/piyo.js

"use strict";
Object.defineProperty(exports, "__esModule", {
    value: true
});
const _hogera = require("../../moge/hogera");

swc-nodeは、SWCをベースにしたts-nodeの代替で、ts-node同様以下のようにTypeScriptファイルを直接実行できるようにするものです。²

node -r @swc-node/register script.ts

ts-nodeには、TypeScript 5.0から追加されたtsconfig.jsonでの配列型のextendsを使用するとエラーが出る点や、pathsを利用したインポートを認識させるためにtsconfig-paths/registerを別途要する点など、不便に感じる点がいくつかありました。
自分はビルドにSWCを使っているので、統一できる嬉しさなどから、最近は個人のプロジェクトではswc-nodeを使うようにしています。
また、swc-nodeのREADMEにはベンチマークとともに“Fastest TypeScript transformer.”と書いてあるように、トランスパイルが高速（≒ 実行までが早い）なこともswc-nodeの利点といえるでしょう。

AVAでswc-nodeを使う

さて、この記事では詳しい説明はしないことにしますが、AVAはTypeScript/JavaScriptのためのテスティングフレームワークのひとつです。

AVAを使用する際に、JavaScriptではなくTypeScriptでテストを書くようにする方法はいくつかありますが、swc-nodeを使う方法もあるのでそれをここで紹介します。

AVAにはpackage.jsonから設定を読み込む機能があるので、package.jsonに以下を追加することで、設定が完了します。

package.json

{
  "ava": {
    "files": ["tests/**/*.ts"],
    "extensions": ["ts"],
    "nodeArguments": ["-r", "@swc-node/register"],
    "environmentVariables": {
      "SWCRC": "true"
    }
  }
}

それでは上記の設定の内容を順に説明します。
まず、filesとextensionsでテストファイルの場所と拡張子を指定して、AVAがTypeScriptのテストを見つけられるようにしています。filesの値は、各々のディレクトリ構成のテストファイルの配置に合わせて変更してください。³

"files": ["tests/**/*.ts"],
"extensions": ["ts"],

nodeArgumentsには、AVAがテストファイルを実行するためにnodeコマンドを呼び出す際に渡すオプションを指定できます。-r　@swc-node/registerが渡されるようにすることで、nodeがTypeScriptを実行できるようにしています。

"nodeArguments": ["-r", "@swc-node/register"],

environmentVariablesに環境変数の名前と値（文字列）を設定すると、AVAを実行した際にその環境変数が自動で設定されます。swc-nodeはデフォルトでは、SWCの設定ファイル.swcrcを読み込まないようになっていて、SWCRC=trueを設定することで.swcrcを読み込むようになります。この設定がなくてもテストを実行することはできますが、設定ファイルを読み込ませてビルド時とSWCの設定を統一した方がよさそうなので、このようにしています。

"environmentVariables": {
  "SWCRC": "true"
}

これでTypeScriptで書かれたテストが実行できるようになりました。
package.jsonで以下のようなスクリプトを定義して、npm testなどのコマンドを実行すれば各テストケースが実行されます。

package.json

{
  "scripts": {
    "test": "ava",
  }
}

---

参考

1. pathsを利用したインポートはJavaScriptを実行するツールや環境によって認識されたりされなかったりするのでありがたいです。 ↩

2. 同じようなts-nodeの代替に、tsxというツールもあります。swc-nodeは内部でSWCをトランスパイルに使っていて、tsxは内部でesbuildをトランスパイルに使っています。（参考: まだts-node使ってるの？tsxの紹介 - Qiita） ↩

3. この例では、プロジェクトのルートのtests/ディレクトリの下に配置したファイルがテストファイルとして認識されます。 ↩