replace annotations jest test with linter rule (#43673)

Co-authored-by: Peter Bengtsson <[email protected]>

Author: rachmari

src/content-linter/lib/linting-rules/annotate-frontmatter.js

@@ -0,0 +1,26 @@
+import { addError, filterTokens } from 'markdownlint-rule-helpers'
+import matter from 'gray-matter'
+
+export const annotateFrontmatter = {
+  names: ['GHD040', 'annotate-frontmatter'],
+  description:
+    'Annotations defined in Markdown must contain a specific layout frontmatter property.',
+  tags: ['code', 'annotate'],
+  information: new URL('https://github.com/github/docs/blob/main/src/content-linter/README.md'),
+  function: function GHD040(params, onError) {
+    filterTokens(params, 'fence', (token) => {
+      if (!token.info.includes('annotate')) return
+      const fm = matter(params.frontMatterLines.join('\n')).data
+      if (fm.layout && fm.layout === 'inline') return
+
+      addError(
+        onError,
+        token.lineNumber,
+        `When you include 'annotate' in a code fence, you must also include 'layout: inline' in the frontmatter.`,
+        token.line,
+        [1, token.line.length],
+        null, // No fix possible
+      )
+    })
+  },
+}

src/content-linter/lib/linting-rules/index.js

@@ -16,6 +16,7 @@ import { internalLinksOldVersion } from './internal-links-old-version.js'
 import { hardcodedDataVariable } from './hardcoded-data-variable.js'
 import { githubOwnedActionReferences } from './github-owned-action-references.js'
 import { liquidQuotedConditionalArg } from './liquid-quoted-conditional-arg.js'
+import { annotateFrontmatter } from './annotate-frontmatter.js'
 
 const noDefaultAltText = markdownlintGitHub.find((elem) =>
   elem.names.includes('no-default-alt-text'),
@@ -44,5 +45,6 @@ export const gitHubDocsMarkdownlint = {
     hardcodedDataVariable,
     githubOwnedActionReferences,
     liquidQuotedConditionalArg,
+    annotateFrontmatter,
   ],
 }

src/content-linter/style/github-docs.js

@@ -72,6 +72,11 @@ const githubDocsConfig = {
     severity: 'error',
     'partial-markdown-files': true,
   },
+  'annotate-frontmatter': {
+    // GH040
+    severity: 'error',
+    'partial-markdown-files': false,
+  },
 }
 
 const githubMarkdownlintConfig = {

src/content-linter/tests/lint-annotate.js

@@ -0,0 +1,30 @@
+import { runRule } from '../../lib/init-test.js'
+import { annotateFrontmatter } from '../../lib/linting-rules/annotate-frontmatter.js'
+
+describe(annotateFrontmatter.names.join(' - '), () => {
+  test('No layout property fails', async () => {
+    const markdown = ['---', 'title: Title', '---', '```shell annotate', 'hello', '```'].join('\n')
+    const result = await runRule(annotateFrontmatter, { strings: { markdown } })
+    const errors = result.markdown
+    expect(errors.length).toBe(1)
+    expect(errors[0].lineNumber).toBe(4)
+    expect(errors[0].errorRange).toEqual([1, 17])
+    expect(errors[0].fixInfo).toBeNull()
+  })
+  test('Incorrect layout property fails', async () => {
+    const markdown = ['---', 'layout: default', '---', '```shell annotate', 'hello', '```'].join(
+      '\n',
+    )
+    const result = await runRule(annotateFrontmatter, { strings: { markdown } })
+    const errors = result.markdown
+    expect(errors.length).toBe(1)
+  })
+  test('Correct layout property passes', async () => {
+    const markdown = ['---', 'layout: inline', '---', '```shell annotate', 'hello', '```'].join(
+      '\n',
+    )
+    const result = await runRule(annotateFrontmatter, { strings: { markdown } })
+    const errors = result.markdown
+    expect(errors.length).toBe(0)
+  })
+})