docs/packages/doc-gen/test/index.test.ts

import { expect, test } from 'vitest';
import { remarkDocGen } from '@/remark-docgen';
import { createProcessor } from '@mdx-js/mdx';
import { fileGenerator } from '@/file-generator';
import * as path from 'node:path';
import { fileURLToPath } from 'node:url';
import { remarkInstall } from '@/remark-install';
import { remark } from 'remark';
import { remarkTypeScriptToJavaScript } from '@/remark-ts2js';
import { readFile } from 'node:fs/promises';
import { remarkShow } from '@/remark-show';

const cwd = path.dirname(fileURLToPath(import.meta.url));

test('File Generator', async () => {
  const content = await readFile(path.resolve(cwd, './fixtures/file-gen.md'));

  const processor = remark().use(remarkDocGen, {
    generators: [fileGenerator()],
  });

  const result = await processor.process({ cwd, value: content });

  await expect(result.toString()).toMatchFileSnapshot(
    path.resolve(cwd, './fixtures/file-gen.output.md'),
  );
});

test('File Generator - Relative', async () => {
  const file = path.resolve(cwd, './fixtures/file-gen.relative.md');
  const content = await readFile(file);

  const result = await remark()
    .use(remarkDocGen, {
      generators: [fileGenerator({ relative: true })],
    })
    .process({ path: file, value: content, cwd });

  await expect(result.toString()).toMatchFileSnapshot(
    path.resolve(cwd, './fixtures/file-gen.relative.output.md'),
  );
});

test('Remark Install', async () => {
  const file = path.resolve(cwd, './fixtures/remark-install.md');
  const content = await readFile(file);

  const result = await createProcessor({
    remarkPlugins: [remarkInstall],
    jsx: true,
  }).process(content);

  await expect(result.toString()).toMatchFileSnapshot(
    path.resolve(cwd, './fixtures/remark-install.output.jsx'),
  );
});

test('Remark Install', async () => {
  const file = path.resolve(cwd, './fixtures/remark-install-persist.md');
  const content = await readFile(file);

  const result = await createProcessor({
    jsx: true,
    remarkPlugins: [
      [
        remarkInstall,
        {
          persist: {
            id: 'package_install',
          },
        },
      ],
    ],
  }).process(content);

  await expect(result.toString()).toMatchFileSnapshot(
    path.resolve(cwd, './fixtures/remark-install-persist.output.jsx'),
  );
});

test('TS to JS', async () => {
  const file = path.resolve(cwd, './fixtures/ts2js.md');
  const content = await readFile(file);

  const result = await createProcessor({
    remarkPlugins: [remarkTypeScriptToJavaScript],
    jsx: true,
  }).process(content);

  await expect(result.toString()).toMatchFileSnapshot(
    path.resolve(cwd, './fixtures/ts2js.output.jsx'),
  );
});

test('Remark Show', async () => {
  const file = path.resolve(cwd, './fixtures/remark-show.mdx');
  const content = await readFile(file);

  const result = await createProcessor({
    remarkPlugins: [
      [
        remarkShow,
        {
          variables: {
            async test() {
              return false;
            },
          },
        },
      ],
    ],
    jsx: true,
  }).process(content);

  await expect(result.toString()).toMatchFileSnapshot(
    path.resolve(cwd, './fixtures/remark-show.output.jsx'),
  );
});