docs: [site] add robots.txt generation to postbuild tasks

Signed-off-by: Lexus Drumgold <unicornware@flexdevelopment.llc>

Author: unicornware

docs/.vitepress/config.ts

@@ -12,6 +12,7 @@ import { globby } from 'globby'
 import fs from 'node:fs/promises'
 import path from 'node:path'
 import { fileURLToPath } from 'node:url'
+import pupa from 'pupa'
 import { SitemapStream, streamToPromise } from 'sitemap'
 import tsconfigpaths from 'vite-tsconfig-paths'
 import {
@@ -59,32 +60,34 @@ const index: string = pkg.name.replace(/.+\//, '')
 const config: UserConfig = defineConfig({
   appearance: 'dark',
   /**
-   * Performs post-build tasks.
+   * Performs postbuild tasks.
    *
    * This includes:
    *
-   * - Building and writing `sitemap.xml`
+   * 1. Writing `sitemap.xml` to `config.outDir`
+   * 2. Writing `robots.txt` to `config.outDir`
    *
    * @async
    *
    * @param {SiteConfig} config - Site configuration
    * @param {string} config.outDir - Absolute path to output directory
+   * @param {string} config.root - Absolute path to project directory
    * @return {Promise<void>} Nothing when complete
    */
-  async buildEnd({ outDir }: SiteConfig): Promise<void> {
+  async buildEnd({ outDir, root }: SiteConfig): Promise<void> {
     /**
-     * Sitemap stream.
+     * Sitemap routes.
      *
-     * @var {SitemapStream} stream
+     * @const {[string, CheerioAPI][]} routes
      */
-    let stream: SitemapStream = new SitemapStream({ hostname: HOSTNAME })
+    const routes: [string, CheerioAPI][] = []
 
     /**
-     * Sitemap routes.
+     * Sitemap stream.
      *
-     * @const {[string, CheerioAPI][]} routes
+     * @const {SitemapStream} stream
      */
-    const routes: [string, CheerioAPI][] = []
+    const stream: SitemapStream = new SitemapStream({ hostname: HOSTNAME })
 
     // get sitemap routes
     for (const route of await globby('**.html', { cwd: outDir })) {
@@ -105,11 +108,24 @@ const config: UserConfig = defineConfig({
       })
     }
 
-    // end stream
-    stream = stream.end()
-
     // write sitemap.xml
-    await fs.writeFile(`${outDir}/sitemap.xml`, await streamToPromise(stream))
+    await fs.writeFile(
+      path.resolve(outDir, 'sitemap.xml'),
+      await streamToPromise(stream.end())
+    )
+
+    /**
+     * `robots.txt` template file path.
+     *
+     * @const {string} robots
+     */
+    const robots: string = path.resolve(root, '.vitepress/templates/robots.txt')
+
+    // write robots.txt
+    await fs.writeFile(
+      path.resolve(outDir, 'robots.txt'),
+      pupa(await fs.readFile(robots, 'utf8'), { HOSTNAME })
+    )
 
     return void 0
   },

docs/.vitepress/templates/robots.txt

@@ -0,0 +1,4 @@
+User-agent: *
+Disallow: /404
+Allow: /
+Sitemap: {HOSTNAME}/sitemap.xml

package.json

@@ -142,6 +142,7 @@
     "prettier": "2.7.1",
     "prettier-plugin-sh": "0.12.8",
     "pretty-format": "29.2.1",
+    "pupa": "3.1.0",
     "serve": "14.0.1",
     "sitemap": "7.1.1",
     "trash-cli": "5.0.0",

yarn.lock

@@ -1135,6 +1135,7 @@ __metadata:
     prettier: "npm:2.7.1"
     prettier-plugin-sh: "npm:0.12.8"
     pretty-format: "npm:29.2.1"
+    pupa: "npm:3.1.0"
     read-pkg-up: "npm:9.1.0"
     serve: "npm:14.0.1"
     sitemap: "npm:7.1.1"
@@ -4822,6 +4823,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"escape-goat@npm:^4.0.0":
+  version: 4.0.0
+  resolution: "escape-goat@npm:4.0.0"
+  checksum: 5878a265bf82e3c74fc87a1ca57fc7ad4b51c3f6d2d8a0f6dc18f43c003546d0b42999b5cf7edfb72352df1bd94676cec9cfda2b94828df96a8046123725eed0
+  languageName: node
+  linkType: hard
+
 "escape-string-regexp@npm:5.0.0":
   version: 5.0.0
   resolution: "escape-string-regexp@npm:5.0.0"
@@ -8257,6 +8265,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"pupa@npm:3.1.0":
+  version: 3.1.0
+  resolution: "pupa@npm:3.1.0"
+  dependencies:
+    escape-goat: "npm:^4.0.0"
+  checksum: 948dd9a0a7587374a5aff7b773a41ad5c5173a295de4e060064394f9f36dee97a53a76f5550b6bc8ba82f78951f43fd6238e671cbea36ee8d1ec48b86ffe272d
+  languageName: node
+  linkType: hard
+
 "pupa@npm:^2.1.1":
   version: 2.1.1
   resolution: "pupa@npm:2.1.1"