adding script and tests for checking h2 header start

Author: gracepark

script/content-migrations/update-headers.js

@@ -0,0 +1,47 @@
+#!/usr/bin/env node
+
+// [start-readme]
+//
+// Run this one time script to update headers for accessibility
+// Changing H3 to H2, H4 to H3, H5 to H4, and H6 to H5
+//
+// [end-readme]
+
+const fs = require('fs')
+const path = require('path')
+const walk = require('walk-sync')
+
+async function updateMdHeaders (dir) {
+  walk(dir, { includeBasePath: true, directories: false })
+    .filter(file => !file.endsWith('README.md'))
+    .forEach(file => {
+      fs.readFile(file, 'utf8', (err, data) => {
+        if (err) return console.error(err)
+
+        const result = data
+          .replace(/^### /gm, '## ')
+          .replace(/^#### /gm, '### ')
+          .replace(/^##### /gm, '#### ')
+          .replace(/^###### /gm, '##### ')
+
+        fs.writeFile(file, result, 'utf8', function (err) {
+          if (err) return console.log(err)
+        })
+      })
+    })
+}
+
+async function main () {
+  const mdDirPaths = [
+    path.join(__dirname, '../../content'),
+    path.join(__dirname, '../../data/reusables')
+  ]
+
+  for (const dir of mdDirPaths) {
+    await updateMdHeaders(dir)
+  }
+}
+
+main()
+  .catch(console.error)
+  .finally(() => console.log('Done'))

tests/content/content-md-header.js

@@ -0,0 +1,42 @@
+const path = require('path')
+const walk = require('walk-sync')
+const { zip } = require('lodash')
+const readFileAsync = require('../../lib/readfile-async')
+
+const rootDir = path.join(__dirname, '../..')
+const contentDir = path.join(rootDir, 'content')
+const reusablesDir = path.join(rootDir, 'data/reusables')
+
+/*
+This will check if the markdown files in the content and data/reusables directorys starts with H3 headers
+*/
+
+describe('Check H2 header start in markdown content and reusables files', () => {
+  describe('must start with h2', () => {
+    const mdWalkOptions = {
+      globs: ['**/*.md'],
+      ignore: ['**/README.md'],
+      directories: false,
+      includeBasePath: true
+    }
+    const re = /^#.*\n/gm
+    const contentMarkdownAbsPaths = walk(contentDir, mdWalkOptions).sort()
+    const contentMarkdownRelPaths = contentMarkdownAbsPaths.map(p => path.relative(rootDir, p))
+    const contentMarkdownTuples = zip(contentMarkdownRelPaths, contentMarkdownAbsPaths)
+
+    const reusableMarkdownAbsPaths = walk(reusablesDir, mdWalkOptions).sort()
+    const reusableMarkdownRelPaths = reusableMarkdownAbsPaths.map(p => path.relative(rootDir, p))
+    const reusableMarkdownTuples = zip(reusableMarkdownRelPaths, reusableMarkdownAbsPaths)
+
+    test.each([...contentMarkdownTuples, ...reusableMarkdownTuples])(
+      'in "%s"',
+      async (markdownRelPath, markdownAbsPath) => {
+        const fileContents = await readFileAsync(markdownAbsPath, 'utf8')
+        const match = fileContents.match(re)
+        const firstHeader = (match) ? match[0].split(' ')[0] : null
+        const errorMessage = 'Found the wrong header:' + match
+        expect(['##', null], errorMessage).toContain(firstHeader)
+      }
+    )
+  })
+})