esm으로 번들링한 모듈을 ssr프레임워크에서 사용시 import 에러 해결법

· 3 min read

post thumbnail image

❗️library maintainer 일 경우에 대한 에러 해결법 입니다.

만약 maintainer가 아니고 next를 사용하고 있다면 next-transpile-modules 를 사용하시면 됩니다.
next에서 사용이 가능하게 transfile을 도와줍니다.

1️⃣ 사용하는 프레임워크의 esm 모듈 지원 여부를 확인 해준다.

Next.js 11.1 부터 ES Modules (e.g. "type": "module" in their package.json) 사용이 가능하다.
config.js에 아래 속성을 꼭 적어줘야 한다.

// next.config.js
module.exports = {
  // Prefer loading of ES Modules over CommonJS
  experimental: { esmExternals: true },
};
// next.config.js
module.exports = {
  // Prefer loading of ES Modules over CommonJS
  experimental: { esmExternals: true },
};

https://nextjs.org/blog/next-11-1#es-modules-support

ESM 라이브러리의 package.json{"type": "module"}이 있는 한 Next.js 12부터는 ES Module에 대한 지원이 기본적으로 활성화됩니다. (esmExternals이 기본적으로 true)
https://stackoverflow.com/questions/65974337/import-es-module-in-next-js-err-require-esm

2️⃣ 사용한 모듈의 package.json 확인

package.json"type" 필드가 없거나 "type:commonjs" 인 경우 .js 파일은 CommonJS로 처리된다.
"type" : "module" 인 경우엔 ES Module 으로 인식한다.
"type" 필드 값에 관계없이 .mjs 확장자를 가진 파일은 항상 ES Module로 처리되고 .cjs 파일은 항상 CommonJS로 처리된다.
https://nodejs.org/dist/latest-v18.x/docs/api/packages.html#type

위 글을 보면 알 수 있듯이 esm으로 번들링후 해당 모듈을 코드베이스에서 사용할 때 ES Modulepackage.json 이나 파일의 확장자에 이 모듈은 ES Module입니다. 라는 명시를 해주지 않으면 사용하는 쪽에서 해당 모듈을 해석할 때 ES Module로 인식을 하지 않고 CommonJS로 인식 함

🔥 그래서 import 에러는 왜 나는건데?

node 에서 ECMAScript 모듈 로더를 사용해야 ES Module 사용이 가능한데 ES Module에서 ECMAScript 모듈 로더를 사용하기 위한 설정을 하지 않아서 생긴 에러이다.
요약하자면, nodeES ModuleCommonJS 모듈 로더를 사용해서 생긴 문제이다.
https://nodejs.org/dist/latest-v16.x/docs/api/esm.html

🚀 결론

csr 에서 사용이 잘 되는 ES Module 인데 ssr에서 동작이 안된다면?
ssr쪽에서 ES Module로 인식을 못 하고 있는 것이다.(ES Module 지원을 안 하는 프레임워크거나...)
package.json{"type" : "module"}를 적어주거나 확장자를 변경하도록 하자!

잘못된 정보가 있다면 댓글로 지적 부탁드립니다!🙇‍♂️

profile
권순민
프론트엔드 개발자 권순민입니다.
GithubVeloge-Mail