All notable changes to
the elm-pages
npm package
will be documented in this file.
The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
- Fix issue with generated
Main.elm
code by using a different version of elm-codegen internally (does not effect the user-facing elm-codegen version constraints).
- Fix dependency versions in elm.json for starter template.
- Update elm-review version for an internally used rule to the latest Elm package to support newer elm-review NPM executable (fixes #364).
- Allow reading files with absolute paths (still reads relative path by default), see #390.
- Fix an error with scripts (
elm-pages run
) when run on Windows, see #446. - Remove
import FatalError
code changes in user-maintained files, see #441. - Update dependencies in starter template.
- Add
AddStaticRoute
in starter template
- Update to Vite v5. NodeJS version 18 or 20+ is now required.
- Update NPM dependencies to latest versions.
- Fix "SubmitEvent" error in older browsers, see #427.
- Fix for a Windows path import issue, see #384.
- Removed some optional chaining operators to prevent unnecessary Node version requirement.
- Runs a special
elm-review
config to give better actionable errors for the user instead of error messages pointing to generated code. Note: this now requireselm-review
to be on the PATH when runningelm-pages
.
</script>
tags within DataSource's are now escaped correctly on the pre-rendered HTML. Thank you @danmarcab for the report and the fix! See #207.
- Check for
elm
andelm-optimize-level-2
executables before running build step to report better error message. - Removed
elm-optimize-level-2
as a dependency since the user needs to install it as adevDependency
in their project anyway to make the binary available.
undefined
errors that were printed inelm-pages build
are now showing the correct error output.
- Refer to latest NPM version in init template.
- Cleaned up error printing in dev server and build to prevent some errors when presenting failure messages.
- Use
cross-spawn
in the beta build to support running on Windows. Thank you @j-maas for fix #161!
- Use a more reliable codegeneration order for the elm-pages dev server to make sure changes hot reload correctly.
- 1.5.2 didn't end up fixing the infinite loop in
elm-pages develop
. It's now properly fixed. - No more double-builds on changes for
elm-pages develop
webpack dev server, so page changes are faster.
- Fixed infinite loop in
elm-pages develop
from the new generated beta code.
- Add missing closing tag for
<head>
in beta build command output. - Make sure to add
/
separator forcontent.json
file requests in beta build's JS code.
- Support for
elm-pages-beta
no-webpack build command (see Elm package release notes for 7.0.0).
elm-pages build --skip-dist
option allows you to build the generated Elm code and check for errors without running the pre-rendering steps. Thank you @sparksp! See https://github.com/dillonkearns/elm-pages/pull/123/files.
- Added headers to the dev server that prevent Safari from serving up stale data. Thank you Kevin Yank for reporting the issue!
- Added dimensions to static images: dillonkearns#110.
- Fix
static
folder behavior in Windows, see #118 (thank you j-maas!). - Make sure that process exits with non-zero status on error so build fails when there are errors in the build. See #121.
- Added hot content reloading to the dev server! That means that you no longer have to restart your dev server if you add/change a StaticHttp request. You don't even
have to reload your browser! It will automatically load in the new data, while keeping your application state. Your markdown (or other format) data, and metadata,
from the
content
folder will also load for you without having to restart the dev server or refresh your browser! You'll see a loading indicator to show you when the dev server is loading a new change. elm-pages
now uses an in-memory cache forStaticHttp
requests. That means that the dev server won't redo requests that were already being performed as you change code with the dev server running. frontmatter in files in thecontent/
folder and save with the dev server running.- Files are re-generated as you change your Elm code. Just refresh the generated file URL while running your dev server, and you'll always see the latest version! Note: there's still an issue where if you no longer generate a file, you'll need to restart your dev server to get a 404 when hitting that URL.
- Uses Terser instead of GoogleClosureCompiler to minify the JavaScript bundle in production. GoogleClosureCompiler was causing some issues for Windows users when
they ran
elm-pages build
because that dependency has known issues on Windows. See #90. Thank you very much to Johannes Maas for the PR!
- Fixed an issue with the dev server not noticing changes to
.emu
files. See #78.elm-markup
files, and files with the.emu
extension, are handled exactly like any other files in thecontent/
folder now. This simplifies the API, and the internal logic is simpler and less error-prone. - Decode errors now show error messages correctly for
StaticHttp.unoptimizedRequest
s. elm-pages
will generate thegen/Pages.elm
module whether or not there are any errors in the build. This was problematic before this fix because you often need the generated file in order to get it compiling in the first place. So it can cause a chicken-and-egg problem.elm-pages
is now more reslient to errors so you don't have to restart the dev server as often. There is still a known issue where a dev server restart is needed when you have unfinished---
for your
- You can now host your
elm-pages
site in a sub-directory. For example, you could host it at mysite.com/blog, where the top-level mysite.com/ is hosting a different app. This works using HTML<base>
tags. The paths you get fromPagePath.toString
andImagePath.toString
will use relative paths (e.g.blog/my-article
) instead of absolute URLs (e.g./blog/my-article
), so you can take advantage of this functionality by just making sure you use the path helpers and don't hardcode any absolute URL strings. See dillonkearns#73.
- Triple quoted strings in content files are now escaped properly (see #26).
- Fixed a path delimiter bug for Windows. Dev server appears to work smoothly on Windows now. See #82. There's currently an issue with running a production build on windows because of Google Closure Compiler. We're investigating possible fixes. A big thank you @vViktorPL for these two fixes!
- Turn off offline service worker fallbacks for now. This will likely be revisited in the future when I can give it a full treatment. It seemed to cause an issue for at least one user of elm-pages, though it may have been related to some a Netlify cloudflare plugin that modifies the HTML assets.
- Fix an issue with the NPM bundle (see dillonkearns#71). Thank you for the fix @icidasset! 🙏
- Colorize elm make output for initial elm-pages build step. See #66.
Note, this patch still hasn't propogated through to
elm-webpack-loader
(see elm-community/elm-webpack-loader#166). So there may still be non-colorized output for errors as you make changes while the dev server is running.
- Don't serve fallback HTML from service worker when a page 404s... only when it fails to load (i.e. when you're offline). 404s will go through from the server if you're online now.
- Only serve up the root route's HTML as a fallback when you're offline. This fixes the flash of root page content when you are online. When you're offline, you will currently still see the root page flash when you load a page, but you will be able to navigate to any cached pages as long as their content.json is in the service worker cache.
- Make sure that pre-render trigger event fires to fix pre-rendering hanging.
- Don't pre-fetch content.json files for unknown paths: dillonkearns#60.
- Fix race condition where pre-rendered content sometimes didn't have body: dillonkearns#62.
- Dev server only terminates with unrecoverable build errors, and now will continue running with recoverable errors like metadata parsing errors. See #58.
- The
pagesInit
function that wraps the way you initialize your app inindex.js
now returns a Promise so you can wire up ports to it once it's initialized. See #50. Thank you @icidasset! 🙏
- Removed a couple of debug console.log statements from the CLI.
- Changed the CLI generator to expect code from the new Elm package from the new
generateFiles
hook inPages.Platform.application
.
- "Missing content" message no longer flashes between pre-rendered HTML and the Elm app hydrating and taking over the page. See #48.
- Newlines and escaped double quotes (
"
s) are handled properly in content frontmatter now. See #41. Thank you Luke! 🎉🙏
- Added hot reloading for code changes! That means that in dev mode (
elm-pages develop
), you can change your code and the changes will be reloaded in your browser for you instantly. Note that changing files in yourcontent
folder won't yet be instantly reloaded, that will be a future task. See #35.
- Fixed the bug that showed blank pages and failed page reloads when you change files in the
content
folder. Thank you so much @danmarcab for contributing the fix! See #23.
- Updated
favicons-webpack-plugin
to latest version. Had to upgrade to[email protected]
for this. See #32.
*Check out this upgrade checklist for more details and steps for upgrading your project.
- Added
StaticHttp
requests in the CLI process (see the Elm package changelog).
- Fixed a regression where elm-markup frontmatter was being incorrectly parsed as JSON (fixes #20).
- Generate files for extensions other than
.md
and.emu
(fixes #16). As always, be sure to also use the latest Elm package.
- Use hidden
<div>
to listen for Elm view renders instead of wrapping entire page in an extra div. Fixes #5.
- Add
onPageChange : PagePath Pages.PathKey -> userMsg
field toPages.application
config record. This is analagous toonUrlChange
inBrowser.application
, except that you get a type-safePagePath Pages.PathKey
because it is guaranteed that you will only go to one of your static routes when thisMsg
is fired. Fixes #4.