feat: export types from main entry point #520
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fasttime
approved these changes
Sep 8, 2025
Member
fasttime
left a comment
fasttime
left a comment
There was a problem hiding this comment.
LGTM, thanks. Leaving open for a second review.
JoshuaKGoldberg
approved these changes
Sep 8, 2025
Contributor
JoshuaKGoldberg
left a comment
JoshuaKGoldberg
left a comment
There was a problem hiding this comment.
Great! IMO a single almost-blank file is not a very high price to pay for easier type imports.
Thanks for pushing on this @lumirlumir!
Member
Author
|
@JoshuaKGoldberg Thanks for understanding that I took on the issue you originally suggested. |
github-project-automation
bot
moved this from Second Review Needed
to Complete
in Triage
Merged
1 task
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Prerequisites checklist
What is the purpose of this pull request?
In this PR, I've exported all types from
src/types.tsthrough the main entry point.Previously, to access the global types defined in
src/types.ts, they had to be imported from@eslint/markdown/types. After this change, they can be imported directly from@eslint/markdown.What changes did you make? (Give an overview)
To enable importing types from the main entry point, I used a small trick.
The
types.tsfile is built intotypes.jsandtypes.d.ts.In the built
types.js, it's possible to re-export the type declarations from the main entry point usingexport * from "types.js".However, that wasn't possible in the source. To bridge the gap, I added a dummy
src/types.jsfile so types can be imported fromsrc/types.ts.Related Issues
Ref: eslint/json#130, eslint/json#130 (comment), #453, #367 (comment)
Is there anything you'd like reviewers to focus on?
N/A