Improve types for (un)compiled template results #4309
Merged
Conversation
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
🦋 Changeset detectedLatest commit: d4291a2 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
📊 Tachometer Benchmark ResultsSummarynop-update
render
update
update-reflect
Resultsthis-change
render
update
update-reflect
this-change, tip-of-tree, previous-release
render
update
nop-update
this-change, tip-of-tree, previous-release
render
update
this-change, tip-of-tree, previous-release
render
update
update-reflect
|
|
The size of lit-html.js and lit-core.min.js are as expected. |
rictic
force-pushed
the
explicit-template-result-compiledness
branch
from
c94a54f
to
51abba4
Compare
packages/lit-html/src/lit-html.ts
Outdated
| * In Lit 4, this type will be an alias of | ||
| * MaybeCompiledTemplateResult, so that code will get type errors if it assumes | ||
| * that Lit templates are not compiled. When deliberately working with only | ||
| * one, use either CompiledTemplateResult or UncompiledTemplateResult |
There was a problem hiding this comment.
Nit: Could make CompiledTemplateResult and UncompiledTemplateResult use @linkcode so they link to the respective docs.
| // This property needs to remain unminified. | ||
| ['_$litType$']: T; | ||
| strings: TemplateStringsArray; | ||
| values: unknown[]; | ||
| }; | ||
|
|
||
| export type MaybeCompiledTemplateResult<T extends ResultType = ResultType> = |
There was a problem hiding this comment.
Nit: This could use a JSDoc to clarify why this is used. Probably want to call out that this should ideally be the type of html or svg when you're trying to target both uncompiled and compiled environments.
Adds two new types: `UncompiledTemplateResult` and `MaybeCompiledTemplateResult`. Currently `UncompiledTemplateResult` is the same as `TemplateResult`, and `MaybeCompiledTemplateResult` is the union of the compiled and uncompiled types. We'd like for code to be able to handle the `html` and `svg` functions returning a MaybeCompiledTemplateResult. Changing that type will be a major breaking change though, and we don't want to do a major version so quickly, but this lays the ground work, and provides future-compatible types that people can use when they want to be explicit about which type they mean, because while TemplateResult will change, MaybeCompiled, Uncompiled, and Compiled will all have the same meanings in the next major version.
rictic
force-pushed
the
explicit-template-result-compiledness
branch
from
51abba4
to
d4291a2
Compare
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.
Adds two new types:
UncompiledTemplateResultandMaybeCompiledTemplateResult. CurrentlyUncompiledTemplateResultis the same asTemplateResult, andMaybeCompiledTemplateResultis the union of the compiled and uncompiled types.We'd like for code to be able to handle the
htmlandsvgfunctions returning a MaybeCompiledTemplateResult. Changing that type will be a major breaking change though, and we don't want to do a major version so quickly, but this lays the ground work, and provides future-compatible types that people can use when they want to be explicit about which type they mean, because while TemplateResult will change, MaybeCompiled, Uncompiled, and Compiled will all have the same meanings in the next major version.