elm-pages 3.0.19 → 3.0.21

package/README.md

@@ -11,7 +11,7 @@
 
 - [elm-pages Docs Site](https://elm-pages.com/docs)
 - [elm-pages site showcase](https://elm-pages.com/showcase/)
-- [elm-pages Elm API Docs](https://package.elm-lang.org/packages/dillonkearns/elm-pages/10.1.0/)
+- [elm-pages Elm API Docs](https://package.elm-lang.org/packages/dillonkearns/elm-pages/10.2.0/)
 - [Quick start repo](https://github.com/dillonkearns/elm-pages-starter) [(live site hosted here)](https://elm-pages-starter.netlify.com)
 - [Introducing `elm-pages` blog post](https://elm-pages.com/blog/introducing-elm-pages)
 - [`examples` folder](https://github.com/dillonkearns/elm-pages/blob/master/examples/) (includes https://elm-pages.com site source) Use `git clone --recurse-submodules https://github.com/dillonkearns/elm-pages.git` so that there aren't missing files when you try to build the examples.

package/generator/dead-code-review/elm.json

@@ -10,8 +10,8 @@
             "elm/core": "1.0.5",
             "elm/json": "1.1.3",
             "elm-community/result-extra": "2.4.0",
-            "jfmengels/elm-review": "2.14.0",
-            "stil4m/elm-syntax": "7.3.2"
+            "jfmengels/elm-review": "2.15.1",
+            "stil4m/elm-syntax": "7.3.8"
         },
         "indirect": {
             "elm/bytes": "1.0.8",
@@ -23,7 +23,6 @@
             "elm/time": "1.0.0",
             "elm/virtual-dom": "1.0.3",
             "elm-explorations/test": "2.2.0",
-            "miniBill/elm-unicode": "1.1.1",
             "rtfeldman/elm-hex": "1.0.0",
             "stil4m/structured-writer": "1.0.3"
         }

package/generator/dead-code-review/tests/Pages/Review/DeadCodeEliminateDataTest.elm

@@ -143,7 +143,7 @@ placeholder moduleName =
                             , details =
                                 [ "" ]
                             , under =
-                                """import Html.Styled as Html"""
+                                """import Html.Styled as Html exposing (Html)"""
                             }
                             |> Review.Test.whenFixed
                                 """module View exposing (View, map, placeholder)

package/generator/review/elm.json

@@ -11,9 +11,9 @@
             "elm/html": "1.0.0",
             "elm/json": "1.1.3",
             "elm/regex": "1.0.0",
-            "jfmengels/elm-review": "2.14.0",
-            "mdgriffith/elm-codegen": "5.0.0",
-            "stil4m/elm-syntax": "7.3.2",
+            "jfmengels/elm-review": "2.15.1",
+            "mdgriffith/elm-codegen": "5.2.0",
+            "stil4m/elm-syntax": "7.3.8",
             "the-sett/elm-syntax-dsl": "6.0.3"
         },
         "indirect": {
@@ -30,7 +30,7 @@
             "miniBill/elm-unicode": "1.1.1",
             "rtfeldman/elm-hex": "1.0.0",
             "stil4m/structured-writer": "1.0.3",
-            "the-sett/elm-pretty-printer": "3.1.0"
+            "the-sett/elm-pretty-printer": "3.1.1"
         }
     },
     "test-dependencies": {

package/generator/src/build.js

@@ -73,7 +73,11 @@ export async function run(options) {
     // This is a temporary hack to avoid this warning. elm-pages manages compiling the Elm code without Vite's involvement, so it is external to Vite.
     // There is a pending issue to allow having external scripts in Vite, once this issue is fixed we can remove this hack:
     // https://github.com/vitejs/vite/issues/3533
-    if (messages && messages[0] && !messages[0].startsWith(`<script src="/elm.js">`)) {
+    if (
+      messages &&
+      messages[0] &&
+      !messages[0].startsWith(`<script src="/elm.js">`)
+    ) {
       console.info(...messages);
     }
   };
@@ -97,13 +101,11 @@ export async function run(options) {
         configFile: false,
         root: process.cwd(),
         base: options.base,
-        assetsInclude: [
-          '/elm-pages.js'
-        ],
+        assetsInclude: ["/elm-pages.js"],
         ssr: false,
 
         build: {
-          manifest: '___vite-manifest___.json',
+          manifest: "___vite-manifest___.json",
           outDir: "dist",
           rollupOptions: {
             input: "elm-stuff/elm-pages/index.html",
@@ -126,7 +128,10 @@ export async function run(options) {
       fullOutputPath,
       withoutExtension
     );
-    const assetManifestPath = path.join(process.cwd(), "dist/___vite-manifest___.json");
+    const assetManifestPath = path.join(
+      process.cwd(),
+      "dist/___vite-manifest___.json"
+    );
     const manifest = JSON.parse(
       await fsPromises.readFile(assetManifestPath, { encoding: "utf-8" })
     );
@@ -292,7 +297,7 @@ export async function render(request) {
       processedIndexTemplate
     );
   } catch (error) {
-    if(error) {
+    if (error) {
       console.error(restoreColorSafe(error));
     }
     buildError = true;
@@ -486,9 +491,7 @@ async function spawnElmMake(mode, options, elmEntrypointPath, outputPath, cwd) {
   }
   await fsPromises.writeFile(
     outputPath,
-    (
-      await fsPromises.readFile(outputPath, "utf-8")
-    ).replace(
+    (await fsPromises.readFile(outputPath, "utf-8")).replace(
       /return \$elm\$json\$Json\$Encode\$string\(.REPLACE_ME_WITH_FORM_TO_STRING.\)/g,
       "function appendSubmitter (myFormData, event) { event.submitter && event.submitter.name && event.submitter.name.length > 0 ? myFormData.append(event.submitter.name, event.submitter.value) : myFormData;  return myFormData }; return " +
         (options.debug
@@ -685,19 +688,26 @@ function _HtmlAsJson_toJson(html) {
 
   await fsPromises.writeFile(
     ELM_FILE_PATH().replace(/\.js$/, ".cjs"),
-    applyScriptPatches(options, elmFileContent
-      .replace(
-        /return \$elm\$json\$Json\$Encode\$string\(.REPLACE_ME_WITH_JSON_STRINGIFY.\)/g,
-        `return ${forceThunksSource}
+    applyScriptPatches(
+      options,
+      elmFileContent
+        .replace(
+          /return \$elm\$json\$Json\$Encode\$string\(.REPLACE_ME_WITH_JSON_STRINGIFY.\)/g,
+          `return ${forceThunksSource}
   return _Json_wrap(forceThunks(html));
 `
-      )
-      .replace(`console.log('App dying')`, "")));
+        )
+        .replace(`console.log('App dying')`, "")
+    )
+  );
 }
 
 function applyScriptPatches(options, input) {
   if (options.isScript) {
-    return input.replace(`_Debug_crash(8, moduleName, region, message)`, "console.error('TODO in module `' + moduleName + '` ' + _Debug_regionToString(region) + '\\n\\n' + message); process.exitCode = 1; debugger; throw 'CRASH!';");
+    return input.replace(
+      `_Debug_crash(8, moduleName, region, message)`,
+      "console.error('TODO in module `' + moduleName + '` ' + _Debug_regionToString(region) + '\\n\\n' + message); process.exitCode = 1; debugger; throw 'CRASH!';"
+    );
   } else {
     return input;
   }

package/generator/src/cli.js

@@ -344,7 +344,9 @@ async function requireElm(compiledElmPath) {
   const warnOriginal = console.warn;
   console.warn = function () {};
 
-  let Elm = (await import(url.pathToFileURL(path.resolve(compiledElmPath)).href)).default;
+  let Elm = (
+    await import(url.pathToFileURL(path.resolve(compiledElmPath)).href)
+  ).default;
   console.warn = warnOriginal;
   return Elm;
 }

package/generator/src/compatibility-key.js

@@ -1,3 +1,3 @@
 export const compatibilityKey = 22;
 
-export const packageVersion = "3.0.19";
+export const packageVersion = "3.0.21";

package/generator/src/dev-server.js

@@ -37,7 +37,11 @@ const __dirname = path.dirname(__filename);
  */
 export async function start(options) {
   console.error = function (...messages) {
-    if (messages && messages[0] && !messages[0].startsWith("Failed to load url")) {
+    if (
+      messages &&
+      messages[0] &&
+      !messages[0].startsWith("Failed to load url")
+    ) {
       console.info(...messages);
     }
   };
@@ -175,9 +179,7 @@ export async function start(options) {
           base: options.base,
           port: options.port,
         },
-        assetsInclude: [
-          '/elm-pages.js'
-        ],
+        assetsInclude: ["/elm-pages.js"],
         appType: "custom",
         configFile: false,
         root: process.cwd(),

package/generator/src/generate-template-module-connector.js

@@ -66,7 +66,9 @@ export async function generateTemplateModuleConnector(basePath, phase) {
 async function runElmCodegenCli(templates, basePath, phase) {
   const __filename = fileURLToPath(import.meta.url);
   const __dirname = path.dirname(__filename);
-  const filePath = pathToFileURL(path.join(__dirname, `../../codegen/elm-pages-codegen.cjs`)).href;
+  const filePath = pathToFileURL(
+    path.join(__dirname, `../../codegen/elm-pages-codegen.cjs`)
+  ).href;
 
   const promise = new Promise(async (resolve, reject) => {
     const elmPagesCodegen = (await import(filePath)).default.Elm.Generate;

package/generator/src/pre-render-html.js

@@ -48,11 +48,12 @@ export function templateHtml(devMode, userHeadTagsTemplate) {
     ${indent(userHeadTagsTemplate({ cliVersion: packageVersion }))}
     <!-- PLACEHOLDER_HEAD_AND_DATA -->
   </head>
-  <body>
-    <div data-url="" display="none"></div>
-    <!-- PLACEHOLDER_HTML -->
-  </body>
-</html>`;
+  <body><div data-elm data-url="" style="display: none;"></div><div data-elm id="elm-pages-announcer" aria-live="assertive" aria-atomic="true" style="position: absolute; top: 0; width: 1px; height: 1px; padding: 0; overflow: hidden; clip: rect(0, 0, 0, 0); whiteSpace: nowrap; border: 0;"></div><!-- PLACEHOLDER_HTML --></body></html>`;
+  // NOTE: The above line needs to:
+  // - Be in sync with `view` in Platform.elm (render the same elements).
+  // - Have `data-elm` on each child of `<body>`.
+  // - Not include any extra whitespace. Even whitespace between </body> and </html> is parsed by browsers as a text node _inside_ <body>.
+  // This is to avoid unnecessary rerenders on init (when the first `view` call is diffed with the virtualized form of the above HTML).
 }
 
 /**

package/generator/src/request-cache.js

@@ -21,6 +21,14 @@ export function lookupOrPerform(
   hasFsAccess,
   useCache
 ) {
+  const uniqueTimeId =
+    Date.now().toString(36) + Math.random().toString(36).slice(2, 8);
+  const timeStart = (message) => {
+    !rawRequest.quiet && console.time(`${message} ${uniqueTimeId}`);
+  };
+  const timeEnd = (message) => {
+    !rawRequest.quiet && console.timeEnd(`${message} ${uniqueTimeId}`);
+  };
   const makeFetchHappen = makeFetchHappenOriginal.defaults({
     cache: mode === "build" ? "no-cache" : "default",
   });
@@ -92,8 +100,7 @@ export function lookupOrPerform(
             }),
           });
         } else {
-          !rawRequest.quiet &&
-            console.time(`BackendTask.Custom.run "${portName}"`);
+          timeStart(`BackendTask.Custom.run "${portName}"`);
           let context = {
             cwd: path.resolve(...rawRequest.dir),
             quiet: rawRequest.quiet,
@@ -135,8 +142,7 @@ export function lookupOrPerform(
               });
             }
           }
-          !rawRequest.quiet &&
-            console.timeEnd(`BackendTask.Custom.run "${portName}"`);
+          timeEnd(`BackendTask.Custom.run "${portName}"`);
         }
       } catch (error) {
         console.trace(error);
@@ -147,7 +153,7 @@ export function lookupOrPerform(
       }
     } else {
       try {
-        !rawRequest.quiet && console.time(`fetch ${request.url}`);
+        timeStart(`fetch ${request.url}`);
         const response = await safeFetch(makeFetchHappen, request.url, {
           method: request.method,
           body: request.body,
@@ -158,7 +164,7 @@ export function lookupOrPerform(
           ...rawRequest.cacheOptions,
         });
 
-        !rawRequest.quiet && console.timeEnd(`fetch ${request.url}`);
+        timeEnd(`fetch ${request.url}`);
         const expectString = request.headers["elm-pages-internal"];
 
         let body;

package/generator/src/spinnies/index.js

@@ -1,25 +1,31 @@
-'use strict';
+"use strict";
 
-import * as readline from 'readline';
+import * as readline from "readline";
 import * as chalk from "kleur/colors";
-import cliCursor from 'cli-cursor';
-
-
-import { purgeSpinnerOptions, purgeSpinnersOptions, colorOptions, breakText, getLinesLength, terminalSupportsUnicode } from './utils.js';
-import { dots, dashes, writeStream, cleanStream } from './utils.js';
+import cliCursor from "cli-cursor";
+
+import {
+  purgeSpinnerOptions,
+  purgeSpinnersOptions,
+  colorOptions,
+  breakText,
+  getLinesLength,
+  terminalSupportsUnicode,
+} from "./utils.js";
+import { dots, dashes, writeStream, cleanStream } from "./utils.js";
 
 export class Spinnies {
   constructor(options = {}) {
     options = purgeSpinnersOptions(options);
     this.options = {
-	// TODO kleur doesn't support brightGreen, only nested function or chained syntax
-//       spinnerColor: 'brightGreen',
-      spinnerColor: 'green',
-      succeedColor: 'green',
-      failColor: 'red',
+      // TODO kleur doesn't support brightGreen, only nested function or chained syntax
+      //       spinnerColor: 'brightGreen',
+      spinnerColor: "green",
+      succeedColor: "green",
+      failColor: "red",
       spinner: terminalSupportsUnicode() ? dots : dashes,
       disableSpins: false,
-      ...options
+      ...options,
     };
     this.spinners = {};
     this.isCursorHidden = false;
@@ -27,7 +33,11 @@ export class Spinnies {
     this.stream = process.stderr;
     this.lineCount = 0;
     this.currentFrameIndex = 0;
-    this.spin = !this.options.disableSpins && !process.env.CI && process.stderr && process.stderr.isTTY;
+    this.spin =
+      !this.options.disableSpins &&
+      !process.env.CI &&
+      process.stderr &&
+      process.stderr.isTTY;
     this.bindSigint();
   }
 
@@ -36,13 +46,14 @@ export class Spinnies {
   }
 
   add(name, options = {}) {
-    if (typeof name !== 'string') throw Error('A spinner reference name must be specified');
+    if (typeof name !== "string")
+      throw Error("A spinner reference name must be specified");
     if (!options.text) options.text = name;
     const spinnerProperties = {
       ...colorOptions(this.options),
       succeedPrefix: this.options.succeedPrefix,
       failPrefix: this.options.failPrefix,
-      status: 'spinning',
+      status: "spinning",
       ...purgeSpinnerOptions(options),
     };
 
@@ -61,37 +72,42 @@ export class Spinnies {
   }
 
   succeed(name, options = {}) {
-    this.setSpinnerProperties(name, options, 'succeed');
+    this.setSpinnerProperties(name, options, "succeed");
     this.updateSpinnerState();
 
     return this.spinners[name];
   }
 
   fail(name, options = {}) {
-    this.setSpinnerProperties(name, options, 'fail');
+    this.setSpinnerProperties(name, options, "fail");
     this.updateSpinnerState();
 
     return this.spinners[name];
   }
 
   remove(name) {
-    if (typeof name !== 'string') throw Error('A spinner reference name must be specified');
+    if (typeof name !== "string")
+      throw Error("A spinner reference name must be specified");
     const spinner = this.spinners[name];
     delete this.spinners[name];
 
     return spinner;
   }
 
-  stopAll(newStatus = 'stopped') {
-    Object.keys(this.spinners).forEach(name => {
+  stopAll(newStatus = "stopped") {
+    Object.keys(this.spinners).forEach((name) => {
       const { status: currentStatus } = this.spinners[name];
-      if (currentStatus !== 'fail' && currentStatus !== 'succeed' && currentStatus !== 'non-spinnable') {
-        if (newStatus === 'succeed' || newStatus === 'fail') {
+      if (
+        currentStatus !== "fail" &&
+        currentStatus !== "succeed" &&
+        currentStatus !== "non-spinnable"
+      ) {
+        if (newStatus === "succeed" || newStatus === "fail") {
           this.spinners[name].status = newStatus;
           this.spinners[name].color = this.options[`${newStatus}Color`];
         } else {
-          this.spinners[name].status = 'stopped';
-          this.spinners[name].color = 'grey';
+          this.spinners[name].status = "stopped";
+          this.spinners[name].color = "grey";
         }
       }
     });
@@ -101,14 +117,18 @@ export class Spinnies {
   }
 
   hasActiveSpinners() {
-    return !!Object.values(this.spinners).find(({ status }) => status === 'spinning');
+    return !!Object.values(this.spinners).find(
+      ({ status }) => status === "spinning"
+    );
   }
 
   setSpinnerProperties(name, options, status) {
-    if (typeof name !== 'string') throw Error('A spinner reference name must be specified');
-    if (!this.spinners[name]) throw Error(`No spinner initialized with name ${name}`);
+    if (typeof name !== "string")
+      throw Error("A spinner reference name must be specified");
+    if (!this.spinners[name])
+      throw Error(`No spinner initialized with name ${name}`);
     options = purgeSpinnerOptions(options);
-    status = status || 'spinning';
+    status = status || "spinning";
 
     this.spinners[name] = { ...this.spinners[name], ...options, status };
   }
@@ -129,29 +149,41 @@ export class Spinnies {
     const { frames, interval } = this.options.spinner;
     return setInterval(() => {
       this.setStreamOutput(frames[this.currentFrameIndex]);
-      this.currentFrameIndex = this.currentFrameIndex === frames.length - 1 ? 0 : ++this.currentFrameIndex
+      this.currentFrameIndex =
+        this.currentFrameIndex === frames.length - 1
+          ? 0
+          : ++this.currentFrameIndex;
     }, interval);
   }
 
-  setStreamOutput(frame = '') {
-    let output = '';
+  setStreamOutput(frame = "") {
+    let output = "";
     const linesLength = [];
     const hasActiveSpinners = this.hasActiveSpinners();
-    Object
-      .values(this.spinners)
-      .map(({ text, status, color, spinnerColor, succeedColor, failColor, succeedPrefix, failPrefix, indent }) => {
+    Object.values(this.spinners).map(
+      ({
+        text,
+        status,
+        color,
+        spinnerColor,
+        succeedColor,
+        failColor,
+        succeedPrefix,
+        failPrefix,
+        indent,
+      }) => {
         let line;
         let prefixLength = indent || 0;
-        if (status === 'spinning') {
+        if (status === "spinning") {
           prefixLength += frame.length + 1;
           text = breakText(text, prefixLength);
           line = `${chalk[spinnerColor](frame)} ${color ? chalk[color](text) : text}`;
         } else {
-          if (status === 'succeed') {
+          if (status === "succeed") {
             prefixLength += succeedPrefix.length + 1;
             if (hasActiveSpinners) text = breakText(text, prefixLength);
             line = `${chalk.green(succeedPrefix)} ${chalk[succeedColor](text)}`;
-          } else if (status === 'fail') {
+          } else if (status === "fail") {
             prefixLength += failPrefix.length + 1;
             if (hasActiveSpinners) text = breakText(text, prefixLength);
             line = `${chalk.red(failPrefix)} ${chalk[failColor](text)}`;
@@ -162,16 +194,17 @@ export class Spinnies {
         }
         linesLength.push(...getLinesLength(text, prefixLength));
         output += indent ? `${" ".repeat(indent)}${line}\n` : `${line}\n`;
-      });
+      }
+    );
 
-    if(!hasActiveSpinners) readline.clearScreenDown(this.stream);
+    if (!hasActiveSpinners) readline.clearScreenDown(this.stream);
     writeStream(this.stream, output, linesLength);
     if (hasActiveSpinners) cleanStream(this.stream, linesLength);
     this.lineCount = linesLength.length;
   }
 
   setRawStreamOutput() {
-    Object.values(this.spinners).forEach(i => {
+    Object.values(this.spinners).forEach((i) => {
       process.stderr.write(`- ${i.text}\n`);
     });
   }
@@ -190,8 +223,8 @@ export class Spinnies {
   }
 
   bindSigint(lines) {
-    process.removeAllListeners('SIGINT');
-    process.on('SIGINT', () => {
+    process.removeAllListeners("SIGINT");
+    process.on("SIGINT", () => {
       cliCursor.show();
       readline.moveCursor(process.stderr, 0, this.lineCount);
       process.exit(0);