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

v2 #7

Open
5 tasks
chippers opened this issue Oct 13, 2020 · 2 comments
Open
5 tasks

v2 #7

chippers opened this issue Oct 13, 2020 · 2 comments
Assignees
Milestone

Comments

@chippers
Copy link
Owner

chippers commented Oct 13, 2020

With webpack 5 having recently been released, I've been interested in making some changes to this lib to make it useful to more developers. Here's a list of changes I've been thinking about that would mark a v2 phase for this plugin - in no particular order:

  • Remove the csp option from the plugin. Nobody uses it in any public code (through reverse dependencies on Github) and unlikely to be used in private code due it being borderline useless. To actually work in the current state another CSP plugin would need to be used for the non-runtime chunks and at that point it should just cover the inlined ones anyways.
  • Support both the latest v4 and v5 of webpack. This doesn't seem difficult for our use-case and html-webpack-plugin already added support in a non-breaking way in some of the recent minor releases. (see added v5 compilation support and deleted depreciation warnings jantimon/html-webpack-plugin#1454 and jantimon/html-webpack-plugin@f3ccdd5)
  • More documentation on what this plugin does, why it does it, and how. Should still be simple to consume as a novice webpack user.
    • Documentation and examples covering a few cases. One a bare minimum of a skeleton webpack project with this plugin, and more complete ones with more html-webpack-plugin plugins to show a more advanced and configurable use-case in the ecosystem. Not only will it show how well it may integrate with the ecosystem (or not well), but can help improve other documentation and edge cases this package may have with other plugins.
  • A test suite for a variety of cases. Ideally one integration test for each valid configuration of webpack and this plugin, along with expected failure/error cases.
    • If the documentation expands to cover some common html-webpack-plugin setups, then the tests should also reflect these too.

Boiled down to a checklist:

  • Remove csp option
  • Support both webpack v4 and v5
  • Document the what/how/why of the plugin
  • Document use-cases with other common html-webpack-plugin plugins.
  • Integration testing (including documentation examples)

I haven't decided any testing tools or what plugins to show examples of. Maybe I'll end up researching and decided by next weekend, when I plan to start working on v2. This issue is more of a scratchpad for my thoughts, but feel free to comment any suggestions/thoughts

@chippers chippers self-assigned this Oct 13, 2020
@chippers chippers added this to the v2 milestone Oct 13, 2020
@chippers chippers pinned this issue Oct 13, 2020
@chippers
Copy link
Owner Author

chippers commented Oct 15, 2020

looks like dual v4/v5 support might not be possible

probably going to wait for that issue being resolved before i start deciding about v4/v5 compatibility

@chippers
Copy link
Owner Author

Dual support may still be possible if html-webpack-plugin keeps a similar api between v4 and v5 (of itself, not webpack), and we keep track of the smaller differences in webpack v4-v5

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

No branches or pull requests

1 participant