Dynamic Sitemap Copy Plugin (#1232)

[jstockdi]

Submitting a Pull Request

Submitting a copy plugin based approach for #1232

Summary of Changes

Adds a package with unit test example

1. Built plugin
2. Created test
3. Added jsdoc

[thescientist13]

Left a comment regarding technical approach, and I think this should also be in core, if we're going to support the static version through core too.

Let's chat during tomorrow's meeting though!

[thescientist13]

Interesting approach and maybe it's just something I'm missing here but the main concern / limitation I see with this approach is that there is no way to programmatically build your own sitemap. To me, the advantage of the dynamic sitemap option was that could automatically build it up whatever way you need, even tapping into your own frontmatter / page metadata.

Referencing my back of the napkin example in #1232, which is basically just taking a page out of the Next.js playbook, I would expect users to be able to make a sitemap.xml.(js|ts) file in the root of their workspace (e.g. src/sitemap.xml.js, which would just export a function in which we pass the compilation to them, and they can build it up themselves and set their own values for all supported properties, since there are things they might want

export async function sitemap(compilation) {
  const urls = compilation.graph.map((page) => {
    const { data, route } = route;

    return `
      <url>
        <loc>http://www.example.com${page.route}</loc>
        <changefreq>${data.freq}</changefreq>
        <priority>https://www.sitemaps.org/protocol.html#prioritydef>${data.priority ?? '1.0'}</priority>
      </url>
    `;
  });
  const sitemap = `
    <?xml version="1.0" encoding="UTF-8"?>
    <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
      ${urls.join('\n')}
    </urlset>
  `;

  return new Response(body, { headers: 'Content-Type' : 'text/xml' })
}

---

As far as how to do this through greenwood, I think the API Resource as a reference is probably going to get us halfway there at least for development, such that hitting https://localhost:1984/sitemap.xml returns something.

For build time, we maybe add something to the build step like we do for adapters, where if we have a sitemap (perhaps the graph can track this on init?) we import the that function from the user's file and write out the file for them?