test.js

import {Buffer} from 'node:buffer'
import {PassThrough} from 'node:stream'
import PluginError from 'plugin-error'
import Vinyl from 'vinyl'
import test from 'tape'
import remarkHtml from 'remark-html'
import {remark} from './index.js'

const fixture = new Vinyl({
  path: 'fixture.txt',
  contents: Buffer.from('_italic_, **bold**.')
})

const commonmarkFixture = new Vinyl({
  path: 'fixture-commonmark.txt',
  contents: Buffer.from('1) List in commonmark')
})

test('gulp-remark', (t) => {
  t.test('should not do anything', (t) => {
    t.plan(2)

    const stream = remark({silent: true})
    stream.write(fixture)

    stream.once('data', (/** @type {Vinyl} */ file) => {
      t.equal(file.relative, 'fixture.txt')
      t.equal(String(file.contents), '*italic*, **bold**.\n')
    })
  })

  t.test('should support settings', (t) => {
    const stream = remark({settings: {commonmark: true}, silent: true}).use(
      remarkHtml
    )

    t.plan(2)

    stream.write(commonmarkFixture)

    stream.once('data', (/** @type {Vinyl} */ file) => {
      t.equal(file.relative, 'fixture-commonmark.txt')
      t.equal(
        String(file.contents),
        '<ol>\n<li>List in commonmark</li>\n</ol>\n'
      )
    })
  })

  t.test('should use plugins', (t) => {
    const stream = remark({silent: true}).use(remarkHtml)

    t.plan(2)

    stream.write(fixture)

    stream.once('data', (/** @type {Vinyl} */ file) => {
      t.equal(file.relative, 'fixture.txt')
      t.equal(
        String(file.contents),
        '<p><em>italic</em>, <strong>bold</strong>.</p>\n'
      )
    })
  })

  t.test('should throw PluginError with streams', (t) => {
    const inStream = new PassThrough()

    const outStream = new Vinyl({contents: inStream})

    t.throws(write, PluginError)

    t.end()

    function write() {
      inStream.write('_italic_')
      inStream.write('**bold**')
      inStream.write('.')
      remark({}).write(outStream)
    }
  })

  t.end()
})