HAST Link Body OK Checker

Common errors

• ERR_REQUIRE_ESM

  cause Attempting to use `require('hast-util-is-body-ok-link')` in a CommonJS environment, but the package is ESM-only.
  fix Switch to ES module import syntax: `import { isBodyOkLink } from 'hast-util-is-body-ok-link';`.

• TypeError: isBodyOkLink is not a function

  cause The `isBodyOkLink` function was imported incorrectly, likely as a default import (`import isBodyOkLink from '...'`) when it is a named export.
  fix Use a named import: `import { isBodyOkLink } from 'hast-util-is-body-ok-link';`.

• TypeError: Cannot read properties of undefined (reading 'type')

  cause The `node` argument passed to `isBodyOkLink` is `undefined`, `null`, or an object that does not conform to the expected HAST `Node` structure, preventing access to its `type` property.
  fix Ensure the `node` argument is a properly constructed HAST `Node` object before passing it to `isBodyOkLink`.

Warnings

• breaking Version 3.0.0 and later of `hast-util-is-body-ok-link` (and the `unified` ecosystem it belongs to) require Node.js 16 or newer. Older Node.js versions are no longer supported.
  Fix: Upgrade your Node.js environment to version 16 or higher.
• breaking `hast-util-is-body-ok-link` is an ESM-only package since version 3.0.0. Attempting to use CommonJS `require()` statements will result in an `ERR_REQUIRE_ESM` error.
  Fix: Refactor your import statements to use ES Modules (e.g., `import { isBodyOkLink } from 'hast-util-is-body-ok-link';`).
• breaking Version 3.0.0 aligns with major updates across the `unified` and `hast` ecosystems (e.g., `unified` v11, `@types/hast` updates). This may necessitate updating other `hast` utilities and plugins to their latest compatible major versions.
  Fix: Ensure all related `unified`, `rehype`, and `hast` packages in your project are updated to their latest compatible major versions.
• gotcha When processing untrusted HTML content, directly using `rehype` and its utilities like this without explicit sanitization can lead to Cross-Site Scripting (XSS) vulnerabilities.
  Fix: Always integrate `rehype-sanitize` into your `rehype` processing pipeline when dealing with HTML from untrusted sources to mitigate XSS risks.

Install

• npm install hast-util-is-body-ok-link npm
• yarn add hast-util-is-body-ok-link yarn
• pnpm add hast-util-is-body-ok-link pnpm

Imports

• isBodyOkLink
  wrong:

  const isBodyOkLink = require('hast-util-is-body-ok-link')

  correct:

  import { isBodyOkLink } from 'hast-util-is-body-ok-link'

  This package is ESM-only since version 3.0.0, and has no default export.
• isBodyOkLink
  wrong:

  import isBodyOkLink from 'hast-util-is-body-ok-link'

  correct:

  import { isBodyOkLink } from 'hast-util-is-body-ok-link'

  There is no default export; the function is a named export.
• Node

  import type { Node } from 'hast'

  While not directly from this package, importing `Node` type from `hast` is common for type-checking when working with HAST utilities.

Quickstart

Demonstrates how to import and use `isBodyOkLink` to check various HAST `link` nodes and a non-link node for 'Body OK' compatibility according to WHATWG HTML specifications.

import { h } from 'hastscript';
import { isBodyOkLink } from 'hast-util-is-body-ok-link';

// Example 1: Link with itemProp (Body OK)
const link1 = h('link', { itemProp: 'foo' });
console.log('Link with itemProp:', isBodyOkLink(link1)); // Expected: true

// Example 2: Stylesheet link (Body OK)
const link2 = h('link', { rel: ['stylesheet'], href: 'index.css' });
console.log('Stylesheet link:', isBodyOkLink(link2)); // Expected: true

// Example 3: Author link (Not Body OK)
const link3 = h('link', { rel: ['author'], href: 'index.css' });
console.log('Author link:', isBodyOkLink(link3)); // Expected: false

// Example 4: Pingback link (Body OK)
const link4 = h('link', { rel: ['pingback'], href: 'ping.xml' });
console.log('Pingback link:', isBodyOkLink(link4)); // Expected: true

// Example 5: Non-link element
const div = h('div', 'Hello');
console.log('Non-link element:', isBodyOkLink(div)); // Expected: false (or handles as invalid HAST Node gracefully)