JestでReact MarkdownとRemark GFMのエラーを無理やり回避するメモ

JestでReact MarkdownとRemark GFMのエラーを無理やり回避するメモ

環境

"next": "^14.2.15",
"react": "^18",
"react-dom": "^18",
"react-markdown": "^9.0.1",
"remark-gfm": "^4.0.0",

エラー

jestでreact-markdown、remark-gfmをテストしようとすると、下記のようなエラーが発生する。原因はesmモジュールをCommonJS環境で実行しようとしているかららしい。

FAIL  ~
  ● 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:

    ~
    import {ReactMarkdown} from './lib/react-markdown.js'
    ^^^^^^

解決法

ESMに対応させるような解決方法をやってみましたが、エラーが消えることはなかった。色々試しみた結果、下記のようにしたら直しました。

jest.mock('react-markdown', () => {
  return {
    __esModule: true,
    default: (props) => {
      return props.children
    }
  }
});

jest.mock('remark-gfm', () => {
  return {
    __esModule: true,
    default: () => {}
  }
})

参考

最後に

間違っていること、もっといい方法をご存じの方いらっしゃいましたら、コメントに書いていただけると幸いです。
よろしくお願いいたします。