🛕

Jestで--coverageの時だけBabelエラーが起きる場合の対処

2021/07/27に公開

JavaScript

Jest

Babel

tech

現象

TypeScript+Jestで、Babelは使わずに開発・テストしていたのですが、「カバレッジ情報を出してみよう」と思ってjest --coverageを動かした途端、なぜか突然Babelのエラーが起きました。
jestだけならBabel使わず正しく動くのに、jest --coverageで自動的にBabelが動いてしかもエラーになるという。。。

エラーログはこんな感じ。

  ● Test suite failed to run

    Jest encountered an unexpected token

    Jest failed to parse a file. This happens e.g. when your code or its dependencies use non-standard JavaScript syntax, or when Jest is not configured to support such syntax.

    Out of the box Jest supports Babel, which will be used to transform your files into valid JS based on your Babel configuration.

    By default "node_modules" folder is ignored by transformers.

    Here's what you can do:
     • If you are trying to use ECMAScript Modules, see https://jestjs.io/docs/ecmascript-modules for how to enable it.
     • To have some of your "node_modules" files transformed, you can specify a custom "transformIgnorePatterns" in your config.
     • If you need a custom transformation specify a "transform" option in your config.
     • If you simply want to mock your non-JS modules (e.g. binary assets) you can stub them out with the "moduleNameMapper" config option.

    You'll find more details and examples of these config options in the docs:
    https://jestjs.io/docs/configuration
    For information about custom transformations, see:
    https://jestjs.io/docs/code-transformation

    Details:

    SyntaxError: /home/foo/bar/FooBar.ts: Support for the experimental syntax 'classProperties' isn't currently enabled (46:14):

      44 | ];
      45 | class FooBar {
    > 46 |     hoge;
         |         ^
      47 |     fuga;
      48 |     piyo;

    Add @babel/plugin-proposal-class-properties (https://git.io/vb4SL) to the 'plugins' section of your Babel config to enable transformation.
    If you want to leave it as-is, add @babel/plugin-syntax-class-properties (https://git.io/vb4yQ) to the 'plugins' section to enable parsing.

原因

Class Propertyが使えないから@babel/plugin-proposal-class-propertiesを有効にせよと言わっしゃる。Babel 7.14以降では@babel/preset-envだけでClass Property使えるはずなので、Jestが内部で持っているBabelの設定が古い感じ。

この記事を書いた時点でのbabel-preset-jestの最新バージョンは27.0.6ですが、そこから参照されてる@babel/preset-envのバージョンは「7.1.0」と古い。ここが「7.14.x」以降にアップデートされたら解決するんだろうけど、ひとまず手元で何とかエラーを直したい。

というか、そもそもBabelは自分では使ってないので、--coverageの時だけBabelが動くのがとても気持ち悪い！Babelが動かないようにできないのか？

対処法

できました！

coverage provider（カバレッジ・プロバイダ）という概念があって、デフォルトではBabelでコードの解析が行われるようです。オプションでv8に切り替えてやることもできるので、jest.config.jsにオプションを追加すればOK

jest.config.js

 module.exports = {
   preset: 'ts-jest',
   verbose: true,
+  coverageProvider: 'v8',
 }

Class Propertyのエラーはいずれbabel-preset-jestがアップデートされたら起きなくなるでしょうけど、JSはどんどん進化してるので、今後も別のBabelエラーが起きる可能性はあると思います。そんな時はこちらをお試しを～。

現象

原因

対処法

Discussion