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

feat: improve configuration as suggested by publint #6

Merged
merged 1 commit into from
Mar 5, 2025

Conversation

bilalshareef
Copy link
Contributor

@bilalshareef bilalshareef commented Mar 5, 2025

This PR fixes the warnings reported by publint.

As per the recommendation to fix the warnings, we have to make sure that the type declarations live adjacent to the resolved JS file. So I have removed tsconfig which generates the types separately and I am now generating types for both CommonJS and ESM modules. I also noticed during my testing that exposing the type declarations this way makes sure that the IDEs pick the types out-of-the-box which was not happening prior to this PR.

I also came across this documentation which says pkg.main is not needed when we have pkg.exports defined. So I have got rid of the not needed fields as well.

Copy link

github-actions bot commented Mar 5, 2025

No linked issues found. Please add the corresponding issues in the pull request description.
Use GitHub automation to close the issue when a PR is merged

@bilalshareef bilalshareef marked this pull request as ready for review March 5, 2025 09:07
@bilalshareef bilalshareef requested a review from simoneb March 5, 2025 09:07
@bilalshareef bilalshareef merged commit 66b7f0d into master Mar 5, 2025
2 of 4 checks passed
@bilalshareef bilalshareef deleted the improvements branch March 5, 2025 09:14
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