changed default behavior for pretty urls

lumeland · Oct 10, 2023 · 0a3bf0c · 0a3bf0c
1 parent 0e0efa1
commit 0a3bf0c
Show file tree

Hide file tree

Showing 10 changed files with 149 additions and 10 deletions.
diff --git a/MIGRATION.md b/MIGRATION.md
@@ -29,6 +29,7 @@
 - Removed `Entry.setContent()`
 - Replace `fn-date` with `Temporal` polyfill to convert dates.
 - Removed message to upgrade Lume.
+- Pretty URLs option doesn't affect to the `/404.html` page by default.
 
 ## `search` Plugin
 

diff --git a/core/source.ts b/core/source.ts
@@ -716,7 +716,8 @@ function getDefaultUrl(
     return url + page.src.ext;
   }
 
-  if (prettyUrls) {
+  // Pretty URLs affects to all pages but 404
+  if (prettyUrls && url !== "/404") {
     if (posix.basename(url) === "index") {
       return posix.join(posix.dirname(url), "/");
     }

diff --git a/tests/__snapshots__/feed.test.ts.snap b/tests/__snapshots__/feed.test.ts.snap
@@ -93,6 +93,7 @@ snapshot[`RSS plugin 1`] = `
   ],
   src: [
     "/",
+    "/404.md",
     "/_data.yml",
     "/favicon.png",
     "/page5.yaml",
@@ -122,9 +123,9 @@ snapshot[`RSS plugin 2`] = `[]`;
 snapshot[`RSS plugin 3`] = `
 [
   {
-    content: '{"version":"https://jsonfeed.org/version/1","title":"My RSS Feed","home_page_url":"https://example.com/","feed_url":"https://example.com/feed.json","description":"","items":[{"id":"https://example.com/pages/new-name/page7/","url":"https://example.com/pages/new-name/page7/","content_html":"Content of Page 7","date_published":"Sun, 02 Jan 2022 00:00:00 GMT"},{"id":"https://example.com/pages/page6/","url":"https://example.com/pages/page6/","title":"Page 6","content_html":"<p>Content of Page 6</p>\\\\n","date_published":"Sat, 01 Jan 2022 00:00:00 GMT"},{"id":"https://example.com/pages/page4/","url":"https://example.com/pages/page4/","title":"Page 4","content_html":"Content of Page 4 in Overrided site name, from the file /pages/2021-01-02-18-32_page4.page.ts","date_published":"Sat, 02 Jan 2021 18:32:00 GMT"},{"id":"https://example.com/overrided-page2/","url":"https://example.com/overrided-page2/","title":"Page 2","content_html":"Content of Page 2","date_published":"Sun, 21 Jun 2020 00:00:00 GMT"}]}',
+    content: '{"version":"https://jsonfeed.org/version/1","title":"My RSS Feed","home_page_url":"https://example.com/","feed_url":"https://example.com/feed.json","description":"","items":[{"id":"https://example.com/pages/new-name/page7/","url":"https://example.com/pages/new-name/page7/","content_html":"Content of Page 7","date_published":"Sun, 02 Jan 2022 00:00:00 GMT"},{"id":"https://example.com/pages/page6/","url":"https://example.com/pages/page6/","title":"Page 6","content_html":"<p>Content of Page 6</p>\\\\n","date_published":"Sat, 01 Jan 2022 00:00:00 GMT"},{"id":"https://example.com/pages/page4/","url":"https://example.com/pages/page4/","title":"Page 4","content_html":"Content of Page 4 in Overrided site name, from the file /pages/2021-01-02-18-32_page4.page.ts","date_published":"Sat, 02 Jan 2021 18:32:00 GMT"},{"id":"https://example.com/overrided-page2/","url":"https://example.com/overrided-page2/","title":"Page 2","content_html":"Content of Page 2","date_published":"Sun, 21 Jun 2020 00:00:00 GMT"},{"id":"https://example.com/page5/","url":"https://example.com/page5/","title":"Page 5","content_html":"Content of Page 5","date_published":"Thu, 21 Jun 1979 23:45:00 GMT"}]}',
     data: {
-      content: '{"version":"https://jsonfeed.org/version/1","title":"My RSS Feed","home_page_url":"https://example.com/","feed_url":"https://example.com/feed.json","description":"","items":[{"id":"https://example.com/pages/new-name/page7/","url":"https://example.com/pages/new-name/page7/","content_html":"Content of Page 7","date_published":"Sun, 02 Jan 2022 00:00:00 GMT"},{"id":"https://example.com/pages/page6/","url":"https://example.com/pages/page6/","title":"Page 6","content_html":"<p>Content of Page 6</p>\\\\n","date_published":"Sat, 01 Jan 2022 00:00:00 GMT"},{"id":"https://example.com/pages/page4/","url":"https://example.com/pages/page4/","title":"Page 4","content_html":"Content of Page 4 in Overrided site name, from the file /pages/2021-01-02-18-32_page4.page.ts","date_published":"Sat, 02 Jan 2021 18:32:00 GMT"},{"id":"https://example.com/overrided-page2/","url":"https://example.com/overrided-page2/","title":"Page 2","content_html":"Content of Page 2","date_published":"Sun, 21 Jun 2020 00:00:00 GMT"}]}',
+      content: '{"version":"https://jsonfeed.org/version/1","title":"My RSS Feed","home_page_url":"https://example.com/","feed_url":"https://example.com/feed.json","description":"","items":[{"id":"https://example.com/pages/new-name/page7/","url":"https://example.com/pages/new-name/page7/","content_html":"Content of Page 7","date_published":"Sun, 02 Jan 2022 00:00:00 GMT"},{"id":"https://example.com/pages/page6/","url":"https://example.com/pages/page6/","title":"Page 6","content_html":"<p>Content of Page 6</p>\\\\n","date_published":"Sat, 01 Jan 2022 00:00:00 GMT"},{"id":"https://example.com/pages/page4/","url":"https://example.com/pages/page4/","title":"Page 4","content_html":"Content of Page 4 in Overrided site name, from the file /pages/2021-01-02-18-32_page4.page.ts","date_published":"Sat, 02 Jan 2021 18:32:00 GMT"},{"id":"https://example.com/overrided-page2/","url":"https://example.com/overrided-page2/","title":"Page 2","content_html":"Content of Page 2","date_published":"Sun, 21 Jun 2020 00:00:00 GMT"},{"id":"https://example.com/page5/","url":"https://example.com/page5/","title":"Page 5","content_html":"Content of Page 5","date_published":"Thu, 21 Jun 1979 23:45:00 GMT"}]}',
       page: [
         "src",
         "data",
@@ -185,6 +186,14 @@ snapshot[`RSS plugin 3`] = `
       <content:encoded><![CDATA[Content of Page 2]]></content:encoded>
       <pubDate>Sun, 21 Jun 2020 00:00:00 GMT</pubDate>
     </item>
+    <item>
+      <title>Page 5</title>
+      <link>https://example.com/page5/</link>
+      <guid isPermaLink="false">https://example.com/page5/</guid>
+      <description/>
+      <content:encoded><![CDATA[Content of Page 5]]></content:encoded>
+      <pubDate>Thu, 21 Jun 1979 23:45:00 GMT</pubDate>
+    </item>
   </channel>
 </rss>',
     data: {
@@ -233,6 +242,14 @@ snapshot[`RSS plugin 3`] = `
       <content:encoded><![CDATA[Content of Page 2]]></content:encoded>
       <pubDate>Sun, 21 Jun 2020 00:00:00 GMT</pubDate>
     </item>
+    <item>
+      <title>Page 5</title>
+      <link>https://example.com/page5/</link>
+      <guid isPermaLink="false">https://example.com/page5/</guid>
+      <description/>
+      <content:encoded><![CDATA[Content of Page 5]]></content:encoded>
+      <pubDate>Thu, 21 Jun 1979 23:45:00 GMT</pubDate>
+    </item>
   </channel>
 </rss>',
       page: [
@@ -251,6 +268,44 @@ snapshot[`RSS plugin 3`] = `
   },
   {
     content: "<!DOCTYPE html>
+<p>This page is exported to <code>/404.html</code>, not <code>/404/index.html</code></p>
+",
+    data: {
+      children: "<p>This page is exported to <code>/404.html</code>, not <code>/404/index.html</code></p>
+",
+      content: "This page is exported to \`/404.html\`, not \`/404/index.html\`
+",
+      date: [],
+      imagick: "Array(1)",
+      mergedKeys: [
+        "tags",
+        "metas",
+        "imagick",
+      ],
+      metas: [
+        "title",
+        "description",
+      ],
+      page: [
+        "src",
+        "data",
+      ],
+      paginate: "paginate",
+      search: [],
+      site: "Default site name",
+      tags: "Array(0)",
+      url: "/404.html",
+    },
+    src: {
+      asset: false,
+      ext: ".md",
+      path: "/404",
+      remote: undefined,
+      slug: "404",
+    },
+  },
+  {
+    content: "<!DOCTYPE html>
 Content of Page 5",
     data: {
       children: "Content of Page 5",

diff --git a/tests/__snapshots__/loaders.test.ts.snap b/tests/__snapshots__/loaders.test.ts.snap
@@ -105,6 +105,7 @@ snapshot[`Load the pages of a site 1`] = `
   ],
   src: [
     "/",
+    "/404.md",
     "/_data.yml",
     "/favicon.png",
     "/page5.yaml",
@@ -141,6 +142,44 @@ snapshot[`Load the pages of a site 2`] = `
 
 snapshot[`Load the pages of a site 3`] = `
 [
+  {
+    content: "<!DOCTYPE html>
+<p>This page is exported to <code>/404.html</code>, not <code>/404/index.html</code></p>
+",
+    data: {
+      children: "<p>This page is exported to <code>/404.html</code>, not <code>/404/index.html</code></p>
+",
+      content: "This page is exported to \`/404.html\`, not \`/404/index.html\`
+",
+      date: [],
+      imagick: "Array(1)",
+      mergedKeys: [
+        "tags",
+        "metas",
+        "imagick",
+      ],
+      metas: [
+        "title",
+        "description",
+      ],
+      page: [
+        "src",
+        "data",
+      ],
+      paginate: "paginate",
+      search: [],
+      site: "Default site name",
+      tags: "Array(1)",
+      url: "/404.html",
+    },
+    src: {
+      asset: false,
+      ext: ".md",
+      path: "/404",
+      remote: undefined,
+      slug: "404",
+    },
+  },
   {
     content: "Uint8Array(1503)",
     data: {

diff --git a/tests/__snapshots__/search.test.ts.snap b/tests/__snapshots__/search.test.ts.snap
@@ -64,6 +64,7 @@ snapshot[`Sort by two fields, second is DESC 1`] = `[Function: anonymous]`;
 
 snapshot[`Test the file searcher 1`] = `
 [
+  "/404.html",
   "/favicon.png",
   "/overrided-page2/index.html",
   "/page5/index.html",

diff --git a/tests/__snapshots__/sitemap.test.ts.snap b/tests/__snapshots__/sitemap.test.ts.snap
@@ -93,6 +93,7 @@ snapshot[`Sitemap plugin 1`] = `
   ],
   src: [
     "/",
+    "/404.md",
     "/_data.yml",
     "/favicon.png",
     "/page5.yaml",
@@ -152,6 +153,10 @@ Sitemap: https://example.com/sitemap.xml",
     <loc>https://example.com/overrided-page2/</loc>
     <lastmod>2020-06-21T00:00:00.000Z</lastmod>
   </url>
+  <url>
+    <loc>https://example.com/page5/</loc>
+    <lastmod>1979-06-21T23:45:00.000Z</lastmod>
+  </url>
   <url>
     <loc>https://example.com/pages/new-name/page7/</loc>
     <lastmod>2022-01-02T00:00:00.000Z</lastmod>
@@ -172,6 +177,10 @@ Sitemap: https://example.com/sitemap.xml",
     <loc>https://example.com/overrided-page2/</loc>
     <lastmod>2020-06-21T00:00:00.000Z</lastmod>
   </url>
+  <url>
+    <loc>https://example.com/page5/</loc>
+    <lastmod>1979-06-21T23:45:00.000Z</lastmod>
+  </url>
   <url>
     <loc>https://example.com/pages/new-name/page7/</loc>
     <lastmod>2022-01-02T00:00:00.000Z</lastmod>
@@ -201,6 +210,44 @@ Sitemap: https://example.com/sitemap.xml",
   },
   {
     content: "<!DOCTYPE html>
+<p>This page is exported to <code>/404.html</code>, not <code>/404/index.html</code></p>
+",
+    data: {
+      children: "<p>This page is exported to <code>/404.html</code>, not <code>/404/index.html</code></p>
+",
+      content: "This page is exported to \`/404.html\`, not \`/404/index.html\`
+",
+      date: [],
+      imagick: "Array(1)",
+      mergedKeys: [
+        "tags",
+        "metas",
+        "imagick",
+      ],
+      metas: [
+        "title",
+        "description",
+      ],
+      page: [
+        "src",
+        "data",
+      ],
+      paginate: "paginate",
+      search: [],
+      site: "Default site name",
+      tags: "Array(0)",
+      url: "/404.html",
+    },
+    src: {
+      asset: false,
+      ext: ".md",
+      path: "/404",
+      remote: undefined,
+      slug: "404",
+    },
+  },
+  {
+    content: "<!DOCTYPE html>
 Content of Page 5",
     data: {
       children: "Content of Page 5",

diff --git a/tests/assets/normal/404.md b/tests/assets/normal/404.md
@@ -0,0 +1 @@
+This page is exported to `/404.html`, not `/404/index.html`
diff --git a/tests/feed.test.ts b/tests/feed.test.ts
@@ -5,9 +5,6 @@ Deno.test("RSS plugin", async (t) => {
   const site = getSite({
     src: "normal",
     location: new URL("https://example.com/"),
-    server: {
-      page404: "/page5/",
-    },
   });
 
   site.use(

diff --git a/tests/loaders.test.ts b/tests/loaders.test.ts
@@ -40,7 +40,7 @@ Deno.test("ignored draft pages on dev=false", async () => {
 
   await build(site);
 
-  assertStrictEquals(site.pages.length, 6);
+  assertStrictEquals(site.pages.length, 7);
 });
 
 Deno.test("textLoader with frontmatter containing just a comment", async () => {

diff --git a/tests/sitemap.test.ts b/tests/sitemap.test.ts
@@ -6,9 +6,6 @@ Deno.test("Sitemap plugin", async (t) => {
   const site = getSite({
     src: "normal",
     location: new URL("https://example.com/"),
-    server: {
-      page404: "/page5/",
-    },
   });
 
   site.use(sitemap());
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		This page is exported to `/404.html`, not `/404/index.html`