remark-markdown-extensions/tests/aside.test.js

A set of remark plugins for extended markdown syntax, including FAQ blocks with Schema.org data and styled asides.

import fs from 'node:fs';
import path from 'node:path';
import { describe, it, expect } from 'vitest';
import { remark } from 'remark';
import remarkDirective  from 'remark-directive';
import remarkRehype from 'remark-rehype';
import rehypeStringify from 'rehype-stringify';
import asidePlugin  from '../plugins/aside.js';

const fixturePath = path.join(__dirname, 'fixtures', 'asidePlugin.md');
const md = fs.readFileSync(fixturePath, 'utf-8');

describe('Aside Plugin', () => {
  it('uses default class when no config provided', async () => {
    const file = await remark()
      .use(remarkDirective)
      .use(asidePlugin) // no options
      .use(remarkRehype).use(rehypeStringify)
      .process(md);

    expect(String(file)).toContain('aside-block');
  });

  it('uses provided class from options', async () => {
    const file = await remark()
      .use(remarkDirective)
      .use(asidePlugin, { className: 'custom-class-here' })
      .use(remarkRehype).use(rehypeStringify)
      .process(md);

    expect(String(file)).toContain('custom-class-here');
  });

  it('renders aside blocks with proper HTML and classes', async () => {
    const file = await remark()
      .use(remarkDirective)
      .use(asidePlugin)
      .use(remarkRehype).use(rehypeStringify)
      .process(md);

    const htmlOutput = String(file);

    expect(htmlOutput).toContain('<aside');
    expect(htmlOutput).toContain('aside-block');
    expect(htmlOutput).toContain('This is an aside note with extra context.');
  });

});