feat(webpack): Render for each locale #26
Conversation
markdalgleish
changed the title
|
I love how little code this takes 😍 |
|
@MattsJones looks like this hasn't gone through Prettier. |
mattcompiles
force-pushed
the
locales
branch
2 times, most recently
from
43193dc
to
388167d
Compare
config/webpack/webpack.config.js
Outdated
| @@ -222,7 +222,17 @@ const buildWebpackConfigs = builds.map(({ name, paths, env }) => { | |||
| }, | |||
| plugins: [ | |||
| new webpack.DefinePlugin(envVars), | |||
| new StaticSiteGeneratorPlugin() | |||
| ...locales.map( | |||
There was a problem hiding this comment.
The documentation says it will only render a single file in dev mode, but this appears to always map over every locale?
There was a problem hiding this comment.
Somehow I missed actually implementing this 🤦 Will do.
There was a problem hiding this comment.
Perfect example of why providing docs with a PR is great for reviewers 😄
README.md
Outdated
| @@ -248,6 +248,39 @@ module.exports = { | |||
| } | |||
| ``` | |||
|
|
|||
| ### Locales | |||
|
|
|||
| Often we render multiple versions of our application for different locations. Eg. Australia & New Zealand. To render an html file for each location you can use the locales option in `sku.config.js`. | |||
There was a problem hiding this comment.
Couple of tweaks:
- Should be "locations, e.g. Australia and New Zealand"
- Should be "HTML"
README.md
Outdated
|
|
||
| Often we render multiple versions of our application for different locations. Eg. Australia & New Zealand. To render an html file for each location you can use the locales option in `sku.config.js`. | ||
|
|
||
| Locales accepts an array of strings representing each locale you want to render html files for. |
There was a problem hiding this comment.
When referencing an option/argument name, we should use locales instead of "Locales". Also, you'll need to re-order this sentence so it's not the first word, otherwise it'll look weird.
(Also need to update to "HTML" here too)
README.md
Outdated
| } | ||
| ``` | ||
|
|
||
| For each locale, sku will call your `render.js` function and pass it the locale as a local. |
There was a problem hiding this comment.
Feel like using "locale" and "local" so close together is confusing. In fact, in this case I think you could avoid using the word "local" entirely.
README.md
Outdated
| ) | ||
| ``` | ||
|
|
||
| The name of the html file that is generated will be suffixed by `-{locale}`. |
| @@ -222,7 +222,17 @@ const buildWebpackConfigs = builds.map(({ name, paths, env }) => { | |||
| }, | |||
| plugins: [ | |||
| new webpack.DefinePlugin(envVars), | |||
| new StaticSiteGeneratorPlugin() | |||
| ...locales.slice(0, isProductionBuild ? locales.length : 1).map( | |||
|
Looks good, just one minor suggestion—might be good to explain when and why this is preferable to monorepos, talking about how we generate a single set of assets that supports both locales. |
README.md
Outdated
| @@ -248,6 +248,39 @@ module.exports = { | |||
| } | |||
| ``` | |||
|
|
|||
| ### Locales | |||
|
|
|||
| Often we render multiple versions of our application for different locations, eg. Australia & New Zealand. To render an HTML file for each location you can use the locales option in `sku.config.js`. Locales are preferable to [Monorepos](monorepo-support) when you need to render multiple versions of your HTML file but only need one version of each of the assets (JS, CSS, images, etc). Note: You can use `locales` inside a monorepo project. | |||
There was a problem hiding this comment.
Sorry—I think monorepo-support needs to be #monorepo-support for the link to work correctly. Also, "Monorepos" should be lowercase.
Will add docs. Just opening for discussion.