Add manifest check step and add missing items (#27934)

.github/workflows/build_test_deploy.yml

@@ -41,6 +41,7 @@ jobs:
         with:
           path: ./*
           key: ${{ github.sha }}
+      - run: ./scripts/check-manifests.js
       - run: yarn lint
 
   checkPrecompiled:

errors/manifest.json

@@ -430,6 +430,14 @@
         {
           "title": "sharp-missing-in-production",
           "path": "/errors/sharp-missing-in-production.md"
+        },
+        {
+          "title": "max-custom-routes-reached",
+          "path": "/errors/max-custom-routes-reached.md"
+        },
+        {
+          "title": "module-not-found",
+          "path": "/errors/module-not-found.md"
         }
       ]
     }

scripts/check-manifests.js

@@ -0,0 +1,55 @@
+#!/usr/bin/env node
+
+const fs = require('fs')
+const path = require('path')
+const globOrig = require('glob')
+const { promisify } = require('util')
+const glob = promisify(globOrig)
+
+function collectPaths(routes, paths = []) {
+  for (const route of routes) {
+    if (route.path) {
+      paths.push(route.path)
+    }
+
+    if (route.routes) {
+      collectPaths(route.routes, paths)
+    }
+  }
+}
+
+async function main() {
+  const manifests = ['errors/manifest.json', 'docs/manifest.json']
+  let hadMissing = false
+
+  for (const manifest of manifests) {
+    const dir = path.dirname(manifest)
+    const files = await glob(path.join(dir, '**/*.md'))
+
+    const manifestData = JSON.parse(
+      await fs.promises.readFile(manifest, 'utf8')
+    )
+
+    const paths = []
+    collectPaths(manifestData.routes, paths)
+
+    const missingFiles = files.filter(
+      (file) => !paths.includes(`/${file}`) && file !== 'errors/template.md'
+    )
+
+    if (missingFiles.length) {
+      hadMissing = true
+      console.log(`Missing paths in ${manifest}:\n${missingFiles.join('\n')}`)
+    } else {
+      console.log(`No missing paths in ${manifest}`)
+    }
+  }
+
+  if (hadMissing) {
+    throw new Error('missing manifest items detected see above')
+  }
+}
+
+main()
+  .then(() => console.log('success'))
+  .catch(console.error)