test.js

import assert from 'node:assert/strict'
import test from 'node:test'
import {h} from 'hastscript'
import {excerpt} from 'hast-util-excerpt'
import {selectAll} from 'hast-util-select'
import {fromMarkdown} from 'mdast-util-from-markdown'
import {mdxFromMarkdown} from 'mdast-util-mdx'
import {toHast} from 'mdast-util-to-hast'
import {mdxjs} from 'micromark-extension-mdxjs'
import {u} from 'unist-builder'
import {removePosition} from 'unist-util-remove-position'

test('excerpt', async function (t) {
  await t.test('should expose the public api', async function () {
    assert.deepEqual(Object.keys(await import('hast-util-excerpt')).sort(), [
      'excerpt'
    ])
  })

  await t.test('should copy to an excerpt comment', async function () {
    assert.deepEqual(
      excerpt(
        h('div', [
          h('p', 'Lorem ipsum dolor sit amet.'),
          u('comment', 'more'),
          h('p', 'Consectetur adipisicing elit.')
        ])
      ),
      h('div', [h('p', 'Lorem ipsum dolor sit amet.')])
    )
  })

  await t.test('should support `maxSearchSize`', async function () {
    assert.deepEqual(
      excerpt(
        h('div', [
          h('p', 'Lorem ipsum dolor sit amet.'),
          u('comment', 'more'),
          h('p', 'Consectetur adipisicing elit.')
        ]),
        {maxSearchSize: 24}
      ),
      undefined
    )
  })

  await t.test(
    'should copy to an excerpt comment inside a paragraph',
    async function () {
      assert.deepEqual(
        excerpt(
          h('div', [
            h('p', [
              'Lorem ipsum dolor sit amet.',
              u('comment', 'more'),
              'Consectetur adipisicing elit.'
            ])
          ])
        ),
        h('div', [h('p', 'Lorem ipsum dolor sit amet.')])
      )
    }
  )

  await t.test(
    'should return `undefined` if there’s no comment',
    async function () {
      assert.deepEqual(
        excerpt(
          h('div', [
            h('p', 'Lorem ipsum dolor sit amet.'),
            h('p', 'Consectetur adipisicing elit.')
          ])
        ),
        undefined
      )
    }
  )

  await t.test(
    'should not match on comments with other values',
    async function () {
      assert.deepEqual(
        excerpt(
          h('div', [
            h('p', 'Lorem ipsum dolor sit amet.'),
            u('comment', 'just a comment'),
            h('p', 'Consectetur adipisicing elit.')
          ])
        ),
        undefined
      )
    }
  )

  await t.test(
    'should ignore trailing whitespace around comments',
    async function () {
      assert.deepEqual(
        excerpt(
          h('div', [
            h('p', 'Lorem ipsum dolor sit amet.'),
            u('comment', '\r\n stop here\t\n'),
            h('p', 'Consectetur adipisicing elit.')
          ]),
          {comment: 'stop here'}
        ),
        h('div', [h('p', 'Lorem ipsum dolor sit amet.')])
      )
    }
  )

  await t.test('should support `ignore`', async function () {
    const tree = h('div', [
      h('p', ['Lorem ipsum ', h('del', 'dolor'), ' sit amet.']),
      u('comment', 'more'),
      h('p', 'Consectetur adipisicing elit.')
    ])

    assert.deepEqual(
      excerpt(tree, {ignore: selectAll('del', tree)}),
      h('div', [h('p', ['Lorem ipsum ', ' sit amet.'])])
    )
  })

  await t.test(
    'should integrate w/ `mdast-util-mdx` (support `/* comments */`)',
    async function () {
      const tree = fromMarkdown('Some text\n\n{/* more */}\n\nSome more text', {
        extensions: [mdxjs()],
        mdastExtensions: [mdxFromMarkdown()]
      })
      removePosition(tree)

      assert.deepEqual(
        excerpt(
          toHast(tree, {
            passThrough: ['mdxFlowExpression', 'mdxTextExpression', 'mdxjsEsm']
          })
        ),
        u('root', [h('p', 'Some text'), u('text', '\n')])
      )
    }
  )
})