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

fix(html): types for plugin #1264

Merged
merged 3 commits into from
Dec 15, 2024
Merged

Conversation

SquidDev
Copy link
Contributor

@SquidDev SquidDev commented Sep 14, 2022

Rollup Plugin Name: HTML

This PR contains:

  • bugfix
  • feature
  • refactor
  • documentation
  • other

Are tests included?

  • yes (bugfixes and features will not be merged without tests)
  • no

Breaking Changes?

  • yes (breaking changes will not be merged unless absolutely necessary)
  • no

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 template function 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!

@shellscape shellscape force-pushed the master branch 4 times, most recently from b353836 to 3038271 Compare October 21, 2022 19:01
@shellscape shellscape force-pushed the master branch 7 times, most recently from a69c299 to a9b9cd3 Compare October 25, 2023 21:01
@shellscape shellscape changed the title Fix types in html plugin fix(html): types for plugin Jun 5, 2024
@shellscape
Copy link
Collaborator

@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 SquidDev force-pushed the hotfix/html-types branch from c7286ec to cd00ee0 Compare June 5, 2024 19:15
@SquidDev
Copy link
Contributor Author

SquidDev commented Jun 5, 2024

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!

ᐅ npx pnpm run prettier:check

> @rollup/plugins@ prettier:check /home/squid/Documents/software/local-copies/rollup-plugins
> prettier --check .

Checking formatting...
[warn] packages/commonjs/src/generate-exports.js
[warn] packages/commonjs/src/index.js
[warn] packages/commonjs/src/proxies.js
[warn] packages/commonjs/src/resolve-require-sources.js
[warn] packages/commonjs/src/transform-commonjs.js
[warn] packages/html/README.md
[warn] packages/html/recipes/external-files/ReadMe.md
[warn] packages/typescript/src/options/tsconfig.ts
[warn] util/test.d.ts
[warn] Code style issues found in 9 files. Run Prettier with --write to fix.

@shellscape shellscape merged commit 3165a25 into rollup:master Dec 15, 2024
5 checks passed
@SquidDev
Copy link
Contributor Author

Thanks!

@SquidDev SquidDev deleted the hotfix/html-types branch December 15, 2024 18:59
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