Extract title from the RFCs and return with the frontmatter

Author: kategengler

lib/frontmatter.mjs

@@ -1,6 +1,7 @@
 import githubFrontmatter from '@github-docs/frontmatter';
+import { title } from './title.mjs';
 
 export function frontmatter(markdown) {
   let { content, data, errors } = githubFrontmatter(markdown);
-  return { content, data, errors };
+  return { content, data: { title: title(markdown), ...data }, errors };
 }

lib/title.mjs

@@ -0,0 +1,28 @@
+import { unified } from 'unified';
+import remarkParse from 'remark-parse';
+import remarkFrontmatter from 'remark-frontmatter';
+import remarkGfm from 'remark-gfm';
+import { visit } from 'unist-util-visit';
+import { toString } from 'mdast-util-to-string';
+
+function topLevelHeaderText(tree) {
+  let heading;
+
+  visit(tree, 'heading', node => {
+    if (node.depth !== 1) {
+      return;
+    }
+    heading = node;
+  });
+  return heading;
+}
+
+export function title(markdown) {
+  const tree = unified()
+    .use(remarkParse)
+    .use(remarkGfm)
+    .use(remarkFrontmatter)
+    .parse(markdown)
+  const headingTree = topLevelHeaderText(tree);
+  return toString(headingTree);
+}

package.json

@@ -24,8 +24,14 @@
     "@github-docs/frontmatter": "^1.3.1",
     "chalk": "^5.2.0",
     "deepmerge": "^4.3.0",
+    "remark-frontmatter": "^4.0.1",
+    "remark-gfm": "^3.0.1",
+    "remark-parse": "^10.0.1",
+    "remark-stringify": "^10.0.2",
     "semver": "^7.3.8",
     "simple-git": "^3.16.0",
+    "unified": "^10.1.2",
+    "unist-util-visit": "^4.1.2",
     "yargs": "^17.6.2"
   },
   "engines": {

test/lib/title-test.mjs

@@ -0,0 +1,56 @@
+import chai from 'chai';
+import { title } from '../../lib/title.mjs';
+
+const expect = chai.expect;
+
+const RFC = `---
+stage: accepted
+start-date: 2022-08-28
+release-date: Unreleased
+release-versions:
+ember-source: vX.Y.Z
+ember-data: vX.Y.Z
+teams:
+  - framework
+prs:
+  accepted:
+---
+
+# My New RFC
+
+My grand plans...
+
+## Another heading
+
+some stuff we will do
+`
+
+const RfcWithBlocksInHeader = `---
+stage: accepted
+start-date: 2022-08-28
+release-date: Unreleased
+release-versions:
+ember-source: vX.Y.Z
+ember-data: vX.Y.Z
+teams:
+  - framework
+prs:
+  accepted:
+---
+
+# Deprecate \`foo\` and \`bar\`; immediately
+## Another heading
+`
+
+
+describe('title', function() {
+  it('returns the contents of the first top-level header in the doc', async function() {
+    let header = title(RFC);
+    expect(header).to.equal('My New RFC');
+  });
+
+  it('returns the text contents of the first top-level header in the doc when there are blocks', async function() {
+    let header = title(RfcWithBlocksInHeader);
+    expect(header).to.equal('Deprecate foo and bar; immediately');
+  });
+});

test/scripts/list-frontmatter-test.mjs

@@ -21,6 +21,7 @@ describe('list-frontmatter', function () {
         prs: {
           accepted: null,
         },
+        title: "My New RFC"
       },
       {
         name: 'test/fixtures/0923-already-recommended.md',
@@ -34,6 +35,7 @@ describe('list-frontmatter', function () {
         prs: {
           accepted: null,
         },
+        title: "My Completely finished RFC"
       },
     ]);
   });

test/scripts/rfc-frontmatter-test.mjs

@@ -16,6 +16,7 @@ describe('rfc-frontmatter', function () {
       prs: {
         accepted: null,
       },
+      title: "My New RFC"
     });
   });