Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(zod-validator): resolve module support issue in Zod validators #869

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

mofareedd
Copy link

Description:
When importing @hono/zod-validator in a ESM environment, the following error occurs:

The current file is a CommonJS module whose imports will produce 'require' calls;
however, the referenced file is an ECMAScript module and cannot be imported with 'require'.

This issue arises because the CommonJS and ESM entry points in the package are not correctly configured in package.json. This misconfiguration causes compatibility issues when the library is used in different module systems.

This PR resolves the compatibility issue by updating the entry points in package.json:

  • Set the CommonJS entry point to dist/index.js
  • Set the ESM entry point to dist/index.mjs

package.json

{
  "main": "dist/index.js",
  "module": "dist/index.mjs",
}

Copy link

changeset-bot bot commented Dec 4, 2024

⚠️ No Changeset found

Latest commit: a407a52

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@yusukebe
Copy link
Member

yusukebe commented Dec 5, 2024

Hi @mofareedd

The current setting may be correct. It does not create dist/index.mjs for ESM but creates dist/index.js as ESM and dist/index.cjs as CommonJS:

yusuke $ ls -l dist
-rw-r--r--@ 1 yusuke  staff  1698 12  5 17:01 index.cjs
-rw-r--r--@ 1 yusuke  staff  1252 12  5 17:01 index.d.cts
-rw-r--r--@ 1 yusuke  staff  1252 12  5 17:01 index.d.ts
-rw-r--r--@ 1 yusuke  staff   666 12  5 17:01 index.js

Can you confirm again that your project is correct?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants