Closed4

jestでremarkのテストをしたいがエラーになる

堀川登喜矢堀川登喜矢

こんなエラーが出る。

状況

  • Next.jsのチュートリアルのremarkでブログ記事を書く的なやつをやった後にjestでテストを書いてみた
  • Next.jsのRust Compilerを選択したが、おそらく関係無い
  • remarkライブラリの中でESMの依存があるっぽいが、jestがそれに対応していない
yarn run v1.22.15
$ jest
 FAIL  pages/index.test.tsx
  ● 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.
     • If you are trying to use TypeScript, see https://jestjs.io/docs/getting-started#using-typescript
     • 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:

    /Users/name/code/testing-labs/node_modules/remark/index.js:1
    ({"Object.<anonymous>":function(module,exports,require,__dirname,__filename,jest){import {unified} from 'unified'
                                                                                      ^^^^^^

    SyntaxError: Cannot use import statement outside a module

      2 | import path from "path";
      3 | import matter from "gray-matter";
    > 4 | import { remark } from "remark";
        |                                ^
      5 | import html from "remark-html";
      6 |
      7 | const postsDirectory = path.join(process.cwd(), "posts");

      at Runtime.createScriptFromCode (node_modules/jest-runtime/build/index.js:1773:14)
      at Object.<anonymous> (lib/posts.ts:4:32)

Test Suites: 1 failed, 1 total
Tests:       0 total
Snapshots:   0 total
Time:        0.783 s, estimated 1 s
Ran all test suites.
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command
堀川登喜矢堀川登喜矢

解決

下記のディスカッションの通り、remarkをmockする。
テスト上でちゃんとremarkを動かしたくなったら困るけど、一旦これでお茶を濁す

https://github.com/orgs/remarkjs/discussions/814

参考コード

jest.config.js
module.exports = {
  // 省略

 // 下記を追加
  remark: "<rootDir>/__mocks__/remarkMock.js"
}
__mocks__/remarkMock.js
module.exports = {};
堀川登喜矢堀川登喜矢

今回はremarkを使ったテストがガッツリ書きたかったわけではないのでこれで終了
remarkで生成した値をpage componentのpropsとして食わせているので、今の所はテストではmockデータを食わせてあげればテストは可能なので今回は打ち切り。いつか本当に悩むことになったらこのスクラップを再会する。

このスクラップは2022/05/05にクローズされました