search

atlassian / better-ajv-errors

JSON Schema validation for Human 👨‍🎤
https://atlassian.github.io/better-ajv-errors/
Other
232 stars 44 forks source link

Types are not correctly exported for a package supporting both ESM and CJS #176

Open duniul opened 12 months ago

duniul commented 12 months ago

Context

The typings.d.ts are currently only exposed via the types field in package.json, which results in the following error in TypeScript:

error TS7016: Could not find a declaration file for module 'better-ajv-errors'. './node_modules/better-ajv-errors/lib/esm/index.mjs' implicitly has an 'any' type.
  There are types at '/Users/daniel/Projects/toca/toca-ts-packages/packages/confy/node_modules/better-ajv-errors/typings.d.ts', but this result could not be resolved when respecting package.json "exports". The 'better-ajv-errors' library may need to update its package.json or typings.

Potential fix

Follow the guidelines listed here: https://www.typescriptlang.org/docs/handbook/esm-node.html#packagejson-exports-imports-and-self-referencing

Basically, you would need to add a types field to each exports entry in package.json, both pointing to unique files.

Edit: PR with fix: https://github.com/atlassian/better-ajv-errors/pull/177

torifat commented 12 months ago

Thanks for reporting this. I will try to fix it soon.

However, did you try using a different moduleResolution option? See https://publint.dev/better-ajv-errors@1.2.0

duniul commented 12 months ago

@torifat I did, but thought I'd report it anyway since that's not always a solution for everyone. Posted a PR with a fix that works for me locally 👍

torifat commented 12 months ago

I will have a look. I was thinking about doing something similar to what I did in one of my other project for maximum compatibility.

duniul commented 12 months ago

Yup, it's pretty much that! 👍

PyotSiili commented 9 months ago

@torifat When is the PR addressing this issue scheduled to be merged? Unfortunately in my project, I cannot use moduleResolution.