html-template: Replace html-webpack-template with our own template #1049
Conversation
| // @neutrinojs/html-template includes a custom template that has more features | ||
| // (eg appMountId and lang support) than the default html-webpack-plugin template: | ||
| // https://github.com/jantimon/html-webpack-plugin/blob/master/default_index.ejs | ||
| template: require.resolve('@neutrinojs/html-template/template.ejs'), |
There was a problem hiding this comment.
Should we instead use path.resolve here?
| @@ -1,5 +1,8 @@ | |||
| import { resolve } from 'path'; | |||
|
|
|||
There was a problem hiding this comment.
Let's remove the extra blank lines between imports.
There was a problem hiding this comment.
I intentionally added the newline, since I think it's cleaner to order (and separate) imports based on stdlib vs third-party vs local imports (we already do this for Treeherder). Ideally in the future all Neutrino imports would be sorted this way, and enforced via eslint-plugin-import.
meta tags yes, via the |
The HTML template that comes with `html-webpack-plugin` [1] is very minimal and so until now we've used the more fully-featured template from `html-webpack-template` [2] instead. However that template currently reimplements the core functionality of `html-webpack-plugin` in template markup and so has to be used with `inject` mode disabled [3]. This means: - many `html-webpack-plugin` plugins don't work (eg the one for SRI) - the template depends much more strongly on the internal data structures of `html-webpack-plugin`, and so can be broken by new major versions (as will be the case with `html-webpack-plugin` v4) - the template doesn't benefit from upstream improvements made to the injected content. In addition, `html-webpack-plugin` now supports several features that were previously only possible with a custom template (eg additional meta tags), and there are now many third party plugins to provide additional functionality (and are the preferred approach). As such, this switches `@neutrinojs/html-template` to using its own custom template, that is virtually the same as [1], other than adding `lang` and `appMountId` support. The `mobile` option has been replaced by adding the same viewport tag via the new `meta` option. If there are features that `html-webpack-template` supported, that our new simpler template does not, users can use their own template (`html-webpack-plugin` pushes this approach strongly) - Neutrino should cater for the 80% out of the box, not the 99%). Unrelated to the switch away from `html-webpack-template`, I've also stopped setting `xhtml` to `true`, since XHTML compliant output isn't something that most people need. [1] https://github.com/jantimon/html-webpack-plugin/blob/master/default_index.ejs [2] https://github.com/jaketrent/html-webpack-template/blob/master/index.ejs [3] jaketrent/html-webpack-template#61
| <!DOCTYPE html> | ||
| <html lang="<%= htmlWebpackPlugin.options.lang %>"> | ||
| <head> | ||
| <meta charset="utf-8"> |
There was a problem hiding this comment.
It's super picky, but can you make this tag self-closing? The reasoning being xhtml mode. If they enable xhtml mode, this would be the one place in the template that isn't compliant, while a self-closing tag will be compliant with either mode.
There was a problem hiding this comment.
Neither the stock template, nor the one we've been using until now, nor CRA's do that:
https://github.com/jantimon/html-webpack-plugin/blob/55abb36ee8cad6e8eb32fcc0848c785099316f2d/default_index.ejs#L4
https://github.com/jaketrent/html-webpack-template/blob/71257cad015f0e507da13435adef6b648d8eadc9/index.ejs#L10
https://github.com/facebook/create-react-app/blob/a671462c1089c1afe95cc1f9d4f2432d3a885806/packages/react-scripts/template/public/index.html#L4
I think XHTML compliant markup falls into "the 1%". See also a recent thread on the Django developers list about how it's not really worth achieving:
https://groups.google.com/forum/#!topic/django-developers/G4Rz1_Bmh7w
There was a problem hiding this comment.
Strange. It's funny that html-webpack-plugin would have an xhtml option for its users and not spit out fully-compliant markup for those users. Anyway, I'm willing to let this one go since its de facto on those platforms, so r+.
* An error is now shown when using the `links` HTML option without also specifying a custom template, so that users affected by #1049 know what changes they need to make. See: #1129 (comment) * The migration guide now recommends regenerating the lockfiles. * The migration section about supported Node.js versions has been made clearer. See: #1129 (comment) * The `neutrino` bin script error message now mentions `test` being removed, includes `--mode` for the inspect example, and uses the correct URL for the migration guide. * The `minify.image` option deprecation error message no longer refers to `@neutrinojs/image-minify`, since it was removed. I've linked to the issue since it gives more background as to why compile-time minification is not recommended. * The `hotEntries` option deprecation check now always occurs, and not only when `options.hot` is enabled. A test has also been added. * Cleans up a few more `t.throws()` usages (missed in #1159).
The HTML template that comes with
html-webpack-plugin[1] is very minimal and so until now we've used the more fully-featured template fromhtml-webpack-template[2] instead.However that template currently reimplements the core functionality of
html-webpack-pluginin template markup and so has to be used withinjectmode disabled [3]. This means:html-webpack-pluginplugins don't work (eg the one for SRI)html-webpack-plugin, and so can be broken by new major versions (as will be the case withhtml-webpack-pluginv4)In addition,
html-webpack-pluginnow supports several features that were previously only possible with a custom template (eg additional meta tags), and there are now many third party plugins to provide additional functionality (and are the preferred approach).As such, this switches
@neutrinojs/html-templateto using its own custom template, that is virtually the same as [1], other than addinglangandappMountIdsupport. Themobileoption has been replaced by adding the same viewport tag via the newmetaoption.If there are features that
html-webpack-templatesupported, that our new simpler template does not, users can use their own template (html-webpack-pluginpushes this approach strongly) - Neutrino should cater for the 80% out of the box, not the 99%).Unrelated to the switch away from
html-webpack-template, I've also stopped settingxhtmltotrue, since XHTML compliant output isn't something that most people need.[1] https://github.com/jantimon/html-webpack-plugin/blob/master/default_index.ejs
[2] https://github.com/jaketrent/html-webpack-template/blob/master/index.ejs
[3] jaketrent/html-webpack-template#61