add test/urls.js and test/exceptions.js

docs/test/exceptions.js

@@ -0,0 +1,25 @@
+const {yellow, green, red} = require('colorette')
+
+/**
+ * Each exception type may resolve to either:
+ *
+ * 1. A string, which will be treated as a message listed alongside the
+ *    "excepted" path; or
+ *
+ * 2. A function in the form: `f(paths) : {pass:Boolean, message:String}`
+ *
+ * In the case of `moved(path)`, it returns a _function_ that checks for
+ * whether the provided path exists in `paths` and returns the appropriate
+ * status object with `pass` and `message` props.
+ */
+module.exports = {
+  removed: yellow('removed'),
+  deprecated: yellow('deprecated'),
+  moved: path => paths => {
+    if (paths.includes(path)) {
+      return {pass: true, message: `→ ${green(path)}`}
+    } else {
+      return {pass: false, message: `→ ${red(path)} is missing`}
+    }
+  }
+}

docs/test/urls.js

@@ -0,0 +1,145 @@
+const execa = require('execa')
+const klaw = require('klaw')
+const {basename, dirname, join, resolve} = require('path')
+const {promisify} = require('util')
+const {readFile, writeFile} = require('fs-extra')
+const {bold, yellow, green, red} = require('colorette')
+const {deprecated, removed, moved} = require('./exceptions')
+
+/**
+ * This is where we track "exceptions" to paths that don't have 1:1 matches
+ * between the styleguide and here. Stating them this way _should_ make it easier
+ * to replace URLs that moved (for instance) with the appropriate redirects.
+ *
+ * In most cases, the "exception" value is just a string ('removed', 'deprecated'),
+ * but in the case of renamed/moved pages we have a `moved(newPath)` function that,
+ * given the list of generated URLs, additionally checks that `newPath` exists in
+ * the list and returns a helpful status object. (See ./exceptions.js if you want
+ * to understand how this works.)
+ */
+const exceptions = {
+  '/components/octicons': removed,
+  '/components/page-headers': deprecated,
+  '/components/page-sections': deprecated,
+  '/components/tables': deprecated,
+  '/getting_started': moved('/getting-started/contributing'),
+  '/getting_started/contributing': moved('/getting-started/contributing'),
+  '/packages/primer': removed,
+  '/packages/primer-core': removed,
+  '/packages/primer-marketing': removed,
+  '/packages/primer-product': removed,
+  '/principles/HTML': moved('/principles/html'),
+  '/principles/SCSS': moved('/principles/scss'),
+  '/whats_new': removed,
+  '/whats_new/changelog': removed,
+  '/whats_new/changelog/archived_changelog': removed,
+  '/whats_new/status-key': moved('/status-key')
+}
+
+const {CI} = process.env
+const CLEAN = process.argv.slice(2).includes('--clean')
+
+const log = console.warn
+
+const before = getStyleguidePaths()
+  .then(paths => paths.filter(path => !path.includes('code_example.html')))
+  .then(normalizePaths)
+  .then(writeLines('before.txt'))
+
+const after = getPaths(resolve(__dirname, '../pages/css'))
+  .then(normalizePaths)
+  .then(writeLines('after.txt'))
+
+Promise.all([before, after])
+  .then(([beforePaths, afterPaths]) => {
+    log(`got ${beforePaths.length} pages in github/styleguide, ${afterPaths.length} here`)
+    const excepted = []
+    const missing = beforePaths.filter(path => !afterPaths.includes(path))
+      .filter(path => {
+        if (path in exceptions) {
+          excepted.push(path)
+          return false
+        }
+        return true
+      })
+    if (excepted.length) {
+      log(`Some files were missing, but these had known exceptions:`)
+      for (const path of excepted) {
+        const exception = exceptions[path]
+        const prefix = `✓ ${yellow(path)}`
+        if (typeof exception === 'function') {
+          const {pass, message} = exception(afterPaths)
+          if (pass) {
+            log(`${prefix} - ${message}`)
+          } else {
+            log(`${red('x')} ${yellow(path)} fail: ${message}`)
+            missing.push(path)
+          }
+        } else {
+          log(`${prefix} - ${exception}`)
+        }
+      }
+    }
+    return missing
+  })
+  .then(writeLines('diff.txt'))
+  .then(missing => {
+    if (missing.length) {
+      log(`${red('x')} missing ${bold(missing.length)} path(s):`) // : \n${missing.join('\n')}`)
+      for (const path of missing) {
+        log(`${red('x')} ${bold(path)}`)
+      }
+      process.exitCode = 1
+    } else {
+      log(`${green('✓')} All good!`)
+    }
+  })
+
+function getStyleguidePaths() {
+  if (CI) {
+    return readLines('before.txt')
+  }
+  return buildStyleguide()
+    .then(root => getPaths(join(root, '_site/primer')))
+}
+
+function buildStyleguide() {
+  const root = resolve(__dirname, '../../../../github/styleguide')
+  if (CLEAN) {
+    return execa('script/bootstrap', {cwd: root})
+      .then(() => execa('npm', ['run', 'build-site'], {cwd: root}))
+      .then(() => root)
+  } else {
+    return Promise.resolve(root)
+  }
+}
+
+function getPaths(dir, options) {
+  const paths = []
+  return new Promise((resolve, reject) => {
+    klaw(dir, options)
+      .on('data', item => paths.push(item.path.substr(dir.length)))
+      .on('error', reject)
+      .on('end', () => {
+        // log(`${paths.length} paths in: ${dir}`)
+        resolve(paths)
+      })
+  })
+}
+
+function readLines(filename) {
+  return readFile(filename, 'utf8').then(str => str.trim().split(/[\r\n]+/))
+}
+
+function writeLines(filename) {
+  return lines => writeFile(filename, lines.join('\n'), 'utf8').then(() => lines)
+}
+
+function normalizePaths(paths) {
+  const normal = paths.map(path => path.replace(/(\/index)?\.([a-z]+)$/, ''))
+  return unique(normal).sort()
+}
+
+function unique(list) {
+  return list.filter((d, i) => list.indexOf(d) === i)
+}