-
Notifications
You must be signed in to change notification settings - Fork 8
Fix default field in package.json #290
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
base: main
Are you sure you want to change the base?
Conversation
Updated the 'default' field to include types which avoids import issues such as the below error: Could not find a declaration file for module '@lob/lob-typescript-sdk'. <package> implicitly has an 'any' type. There are types at 'f/node_modules/@lob/lob-typescript-sdk/dist/index.d.ts', but this result could not be resolved when respecting package.json "exports". The '@lob/lob-typescript-sdk' library may need to update its package.json or typings.
Summary of ChangesHello @nvsd, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request refines the package's module resolution configuration by adjusting the Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request correctly fixes a TypeScript type resolution issue by updating the default field in the exports map of package.json. The change adds an explicit types entry, which ensures that TypeScript can locate the declaration files when the package is imported as an ES module. This is the standard and correct way to resolve the described import error. I have added one suggestion to make the package's exports more robust for CommonJS environments.
| "default": { | ||
| "import": "./dist/index.mjs", | ||
| "types": "./dist/index.d.ts" | ||
| } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
While this change correctly adds type definitions for the default export, the default condition is missing an entry for require. This could cause issues for CommonJS-based tools that respect exports but don't match the node condition. To make the package more robust, I suggest adding the require path.
With this change, the default condition would become identical to the node condition. As a follow-up, you could consider simplifying the exports map by removing the now-redundant node condition and just keeping the comprehensive default one.
"default": {
"import": "./dist/index.mjs",
"require": "./dist/index.cjs.js",
"types": "./dist/index.d.ts"
}
Updated the 'default' field to include types which avoids import issues such as the below error:
Could not find a declaration file for module '@lob/lob-typescript-sdk'. implicitly has an 'any' type.
There are types at 'f/node_modules/@lob/lob-typescript-sdk/dist/index.d.ts', but this result could not be resolved when respecting package.json "exports". The '@lob/lob-typescript-sdk' library may need to update its package.json or typings.
Note
Update
package.jsonto makeexports.defaultan object that includesimportandtypesso TypeScript declarations are resolved.Written by Cursor Bugbot for commit 22586ae. This will update automatically on new commits. Configure here.