fix(html): types for plugin #1264
Open
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
shellscape
force-pushed
the
master
branch
4 times, most recently
from
b353836
to
3038271
Compare
shellscape
force-pushed
the
master
branch
7 times, most recently
from
a69c299
to
a9b9cd3
Compare
|
@SquidDev not sure why this one was in purgatory so long. could you please run linting on your branch and push? looks like prettier is upset about formatting |
- Make templateoptions non-optional - Allow template to return a Promise Also adds type annotations to the implementation to ensure the types are more consistent.
SquidDev
force-pushed
the
hotfix/html-types
branch
from
c7286ec
to
cd00ee0
Compare
|
I've rebased on top of master, and re-run prettier. Not 100% sure I got this right - running prettier locally reported a lot of additional issues that CI doesn't complain about! |
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.
Rollup Plugin Name:
HTMLThis PR contains:
Are tests included?
Breaking Changes?
If yes, then include "BREAKING CHANGES:" in the first commit message body, followed by a description of what is breaking.
List any relevant issue numbers:
Description
The exposed types for the
templatefunction in the HTML plugin are more strict than the implementation allows. This relaxes them.It also adds type annotations to the implementation to ensure the types remain consistent in the future.
I've not added tests here, as it's just a type signature change.
Technically this could be viewed as a breaking change as the public types are changing. I'm not convinced this would break anything in practice, but happy to mark it as such if preferred!