Bringing in forInlineEachChild and filterTokens from markdownlint-rule-helpers (#50895)

Author: gracepark

package-lock.json

@@ -247,6 +247,7 @@
     "lodash-es": "^4.17.21",
     "lowdb": "7.0.1",
     "lowlight": "3.1.0",
+    "markdownlint-rule-helpers": "^0.25.0",
     "mdast-util-from-markdown": "^2.0.0",
     "mdast-util-to-hast": "^13.1.0",
     "mdast-util-to-markdown": "2.1.0",
@@ -329,7 +330,6 @@
     "kill-port": "2.0.1",
     "lint-staged": "^15.2.2",
     "markdownlint": "^0.34.0",
-    "markdownlint-rule-helpers": "^0.19.0",
     "markdownlint-rule-search-replace": "^1.2.0",
     "mdast-util-gfm-table": "^2.0.0",
     "micromark-extension-gfm-table": "^2.0.0",

package.json

@@ -51,7 +51,7 @@ See the [custom rules](https://github.com/DavidAnson/markdownlint/blob/main/doc/
 
 ### Helper utilities
 
-Markdownlint provides several helper functions. Take a look at the many exports in [markdownlint-rule-helpers](https://github.com/DavidAnson/markdownlint/blob/main/helpers/helpers.js).
+Markdownlint provides several helper functions. Take a look at the many exports in [markdownlint-rule-helpers](https://github.com/DavidAnson/markdownlint/blob/main/helpers/helpers.js). Note, this is unsupported and may stop being published to in the future.
 
 We've also written a few of our own:
 

src/content-linter/README.md

@@ -1,11 +1,19 @@
-import { addError } from 'markdownlint-rule-helpers'
+import { addError, filterTokens } from 'markdownlint-rule-helpers'
 import matter from 'gray-matter'
 
 // Adds an error object with details conditionally via the onError callback
 export function addFixErrorDetail(onError, lineNumber, expected, actual, range, fixInfo) {
   addError(onError, lineNumber, `Expected: ${expected}`, ` Actual: ${actual}`, range, fixInfo)
 }
 
+export function forEachInlineChild(params, type, handler) {
+  filterTokens(params, 'inline', (token) => {
+    for (const child of token.children.filter((c) => c.type === type)) {
+      handler(child, token)
+    }
+  })
+}
+
 export function getRange(line, content) {
   if (content.length === 0) {
     // This function assumes that the content is something. If it's an

src/content-linter/lib/helpers/utils.js

@@ -1,11 +1,13 @@
 import { addError, filterTokens } from 'markdownlint-rule-helpers'
+
 import { getFrontmatter } from '../helpers/utils.js'
 
 export const codeAnnotations = {
   names: ['GHD007', 'code-annotations'],
   description:
     'Code annotations defined in Markdown must contain a specific layout frontmatter property',
   tags: ['code', 'feature', 'annotate', 'frontmatter'],
+  parser: 'markdownit',
   function: (params, onError) => {
     filterTokens(params, 'fence', (token) => {
       if (!token.info.includes('annotate')) return

src/content-linter/lib/linting-rules/code-annotations.js

@@ -4,6 +4,7 @@ export const codeFenceLineLength = {
   names: ['GHD030', 'code-fence-line-length'],
   description: 'Code fence lines should not exceed a maximum length',
   tags: ['code', 'accessibility'],
+  parser: 'markdownit',
   function: (params, onError) => {
     const MAX_LINE_LENGTH = String(params.config.maxLength || 60)
     filterTokens(params, 'fence', (token) => {

src/content-linter/lib/linting-rules/code-fence-line-length.js

@@ -1,7 +1,6 @@
-import { forEachInlineChild } from 'markdownlint-rule-helpers'
-
 import {
   addFixErrorDetail,
+  forEachInlineChild,
   getRange,
   isStringQuoted,
   isStringPunctuated,
@@ -11,6 +10,7 @@ export const imageAltTextEndPunctuation = {
   names: ['GHD032', 'image-alt-text-end-punctuation'],
   description: 'Alternate text for images should end with punctuation',
   tags: ['accessibility', 'images'],
+  parser: 'markdownit',
   function: (params, onError) => {
     forEachInlineChild(params, 'image', function forToken(token) {
       const imageAltText = token.content.trim()

src/content-linter/lib/linting-rules/image-alt-text-end-punctuation.js

@@ -1,6 +1,6 @@
-import { addError, forEachInlineChild } from 'markdownlint-rule-helpers'
+import { addError } from 'markdownlint-rule-helpers'
 
-import { getRange } from '../helpers/utils.js'
+import { forEachInlineChild, getRange } from '../helpers/utils.js'
 
 const excludeStartWords = ['image', 'graphic']
 
@@ -12,6 +12,7 @@ export const imageAltTextExcludeStartWords = {
   names: ['GHD031', 'image-alt-text-exclude-words'],
   description: 'Alternate text for images should not begin with words like "image" or "graphic"',
   tags: ['accessibility', 'images'],
+  parser: 'markdownit',
   function: (params, onError) => {
     forEachInlineChild(params, 'image', function forToken(token) {
       const imageAltText = token.content.trim()

src/content-linter/lib/linting-rules/image-alt-text-exclude-start-words.js

@@ -1,13 +1,14 @@
-import { addError, forEachInlineChild } from 'markdownlint-rule-helpers'
+import { addError } from 'markdownlint-rule-helpers'
 
 import { liquid } from '#src/content-render/index.js'
 import { allVersions } from '#src/versions/lib/all-versions.js'
-import { getRange } from '../helpers/utils.js'
+import { forEachInlineChild, getRange } from '../helpers/utils.js'
 
 export const incorrectAltTextLength = {
   names: ['GHD033', 'incorrect-alt-text-length'],
   description: 'Images alternate text should be between 40-150 characters',
   tags: ['accessibility', 'images'],
+  parser: 'markdownit',
   asynchronous: true,
   function: (params, onError) => {
     forEachInlineChild(params, 'image', async function forToken(token) {

src/content-linter/lib/linting-rules/image-alt-text-length.js

@@ -1,11 +1,10 @@
-import { forEachInlineChild } from 'markdownlint-rule-helpers'
-
-import { addFixErrorDetail } from '../helpers/utils.js'
+import { addFixErrorDetail, forEachInlineChild } from '../helpers/utils.js'
 
 export const imageFileKebabCase = {
   names: ['GHD004', 'image-file-kebab-case'],
   description: 'Image file names must use kebab-case',
   tags: ['images'],
+  parser: 'markdownit',
   function: (params, onError) => {
     forEachInlineChild(params, 'image', async function forToken(token) {
       const imageFileName = token.attrs[0][1].split('/').pop().split('.')[0]

src/content-linter/lib/linting-rules/image-file-kebab-case.js

@@ -1,10 +1,13 @@
-import { addError, forEachInlineChild } from 'markdownlint-rule-helpers'
+import { addError } from 'markdownlint-rule-helpers'
+
+import { forEachInlineChild } from '../helpers/utils.js'
 
 export const imageNoGif = {
   names: ['GHD036', 'image-no-gif'],
   description:
     'Image must not be a gif, styleguide reference: contributing/style-guide-and-content-model/style-guide.md#images',
   tags: ['images'],
+  parser: 'markdownit',
   function: (params, onError) => {
     forEachInlineChild(params, 'image', function forToken(token) {
       const imageFileName = token.attrs[0][1]

src/content-linter/lib/linting-rules/image-no-gif.js

@@ -1,11 +1,13 @@
 import { filterTokens } from 'markdownlint-rule-helpers'
+
 import { addFixErrorDetail, getRange } from '../helpers/utils.js'
 import { allLanguageKeys } from '#src/languages/lib/languages.js'
 
 export const internalLinksNoLang = {
   names: ['GHD002', 'internal-links-no-lang'],
   description: 'Internal links must not have a hardcoded language code',
   tags: ['links', 'url'],
+  parser: 'markdownit',
   function: (params, onError) => {
     filterTokens(params, 'inline', (token) => {
       for (const child of token.children) {

src/content-linter/lib/linting-rules/internal-links-no-lang.js

@@ -1,10 +1,12 @@
-import { filterTokens, addError } from 'markdownlint-rule-helpers'
+import { addError, filterTokens } from 'markdownlint-rule-helpers'
+
 import { getRange } from '../helpers/utils.js'
 
 export const internalLinksOldVersion = {
   names: ['GHD006', 'internal-links-old-version'],
   description: 'Internal links must not have a hardcoded version using old versioning syntax',
   tags: ['links', 'url', 'versioning'],
+  parser: 'markdownit',
   function: (params, onError) => {
     filterTokens(params, 'inline', (token) => {
       if (

src/content-linter/lib/linting-rules/internal-links-old-version.js

@@ -6,6 +6,7 @@ export const internalLinksSlash = {
   names: ['GHD003', 'internal-links-slash'],
   description: 'Internal links must start with a /',
   tags: ['links', 'url'],
+  parser: 'markdownit',
   function: (params, onError) => {
     filterTokens(params, 'inline', (token) => {
       for (const child of token.children) {

src/content-linter/lib/linting-rules/internal-links-slash.js

@@ -1,11 +1,12 @@
-import { filterTokens, addError } from 'markdownlint-rule-helpers'
+import { addError, filterTokens } from 'markdownlint-rule-helpers'
 
-import { getRange, isStringQuoted, doesStringEndWithPeriod } from '../helpers/utils.js'
+import { doesStringEndWithPeriod, getRange, isStringQuoted } from '../helpers/utils.js'
 
 export const linkPunctuation = {
   names: ['GHD001', 'link-punctuation'],
   description: 'Internal link titles must not contain punctuation',
   tags: ['links', 'url'],
+  parser: 'markdownit',
   function: (params, onError) => {
     filterTokens(params, 'inline', (token) => {
       const { children, line } = token

src/content-linter/lib/linting-rules/link-punctuation.js

@@ -1,8 +1,8 @@
 import yaml from 'js-yaml'
+import { addError, filterTokens } from 'markdownlint-rule-helpers'
 
 import { liquid } from '#src/content-render/index.js'
 import { allVersions } from '#src/versions/lib/all-versions.js'
-import { addError, filterTokens } from 'markdownlint-rule-helpers'
 
 const scheduledYamlJobs = []
 
@@ -11,6 +11,7 @@ export const yamlScheduledJobs = {
   description:
     'YAML snippets that include scheduled workflows must not run on the hour and must be unique',
   tags: ['feature', 'actions'],
+  parser: 'markdownit',
   asynchronous: true,
   function: (params, onError) => {
     filterTokens(params, 'fence', async (token) => {

src/content-linter/lib/linting-rules/yaml-scheduled-jobs.js

@@ -2,7 +2,6 @@
 import fs from 'fs'
 import path from 'path'
 import { execSync } from 'child_process'
-
 import { program, Option } from 'commander'
 import markdownlint from 'markdownlint'
 import { applyFixes } from 'markdownlint-rule-helpers'