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
[lit] Add "types" to package exports #3320
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
'lit': patch | ||
--- | ||
|
||
The `lit` package now specifies and "types" export condition allowing TypeScript `moduleResolution` to be `nodenext`. |
This file contains 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
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.
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.
I don't think we need development for lit, because all the differences are in the underlying packages
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.
I agree that it's no different than the default build. The types field does need to point to the
./development/*
directory for the self reference to work during build time since that is the specifiedoutDir
so I did have to add the entire/development/
directory to the published package. We could possibly just include thed.ts
andd.ts.map
files there.I noticed some of the labs packages also include the (unnecessary)
"development"
export probably just from copy pasting so I opted to just follow that here too.An alternative, and perhaps arguably more sensible, thing to do might be to change the tsc outDir to emit directly to the package root and not do the treemirror copy for the packages that don't need a development build but that seemed like extra work and I wasn't sure if that would require tweaking the rollup config as well.
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.
+1 to that, the minified files in
lit
only save a couple of spaces and newlines.But also +1 to not trying to do that first to fix the tests. This change seems reasonable to me given that we currently compile to
/development/
, Rollup to the default location, and treemirror in the types, just like in lit-html, etc.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.
I went ahead and removed the
"development"
export conditions from thelit
package since there's nothing different in those so no need to even include them inpackage.json
. I'm still keeping the existing tsc output directory and rollup since I don't want to mess with that, and therefore"types"
export will still point to./development/*.d.ts
and the/development/
directory output will be included in the npm package for those. I think that's a good compromise for now.