@x-govuk/govuk-eleventy-plugin/src/filters/no-orphans.js

Write documentation using Markdown and publish it using GOV.UK styles

import { normalise } from '../utils.js'

/**
 * Insert non-breaking space between last two words of a string. This prevents
 * an orphaned word appearing by itself at the end of a paragraph.
 *
 * @param {string} string - Value to transform
 * @returns {string} `string` with non-breaking space inserted
 * @example
 * noOrphans('Department for Education') // Department for Education
 */
export function noOrphans(string) {
  string = normalise(string, '')

  const indexOfLastSpace = string.lastIndexOf(' ')

  // If there’s only one word, we don’t need this filter
  if (indexOfLastSpace === -1) {
    return string
  }

  const begin = string.substring(0, indexOfLastSpace)
  const end = string.substring(indexOfLastSpace + 1)
  return `${begin} ${end}`
}