rehype-slug.js

/**
 * Forked from https://github.com/rehypejs/rehype-slug to support PlatformIdentifier nodes
 */

/**
 * @typedef {import('hast').Root} Root
 */

/**
 * @typedef Options
 *   Configuration (optional).
 * @property {string} [prefix='']
 *   Prefix to add in front of `id`s (default: `''`).
 */

import GithubSlugger from 'github-slugger';
import {headingRank} from 'hast-util-heading-rank';
import {toString} from 'hast-util-to-string';
import {visit} from 'unist-util-visit';

/** @type {Options} */
const emptyOptions = {};
const slugs = new GithubSlugger();

/**
 * Add `id`s to headings.
 *
 * @param {Options | null | undefined} [options]
 *   Configuration (optional).
 * @returns
 *   Transform.
 */
export default function rehypeSlug(options) {
  const settings = options || emptyOptions;
  const prefix = settings.prefix || '';

  /**
   * @param {Root} tree
   *   Tree.
   * @returns {undefined}
   *   Nothing.
   */
  return function (tree) {
    slugs.reset();

    // Custom function to handle PlatformIdentifier nodes
    /**
     * @param {Root} n
     * @returns {string}
     */
    const myToString = n =>
      n.children.length
        ? n.children
            .map(node =>
              node.name === 'PlatformIdentifier'
                ? node.attributes.find(att => att.name === 'name').value
                : toString(node)
            )
            .join('')
        : n.value;

    visit(tree, 'element', function (node) {
      if (headingRank(node) && !node.properties.id) {
        node.properties.id = prefix + slugs.slug(myToString(node));
      }
    });
  };
}