Skip to content
Source
Sign inSign up
TanStack/ai
Open History to see the last commit

markdown-plugins.test.ts

76 lines2.5 KB

1import { describe, expect, it } from 'vitest'
2import remarkGfm from 'remark-gfm'
3import rehypeRaw from 'rehype-raw'
4import rehypeSanitize from 'rehype-sanitize'
5import rehypeHighlight from 'rehype-highlight'
6import {
7 DEFAULT_REHYPE_PLUGINS_AFTER_USER,
8 DEFAULT_REHYPE_PLUGINS_BEFORE_USER,
9 DEFAULT_REMARK_PLUGINS,
10 resolveMarkdownPlugins,
11} from '../src/markdown-plugins'
12​
13const userRemark = () => () => {}
14const userRehype = () => () => {}
15​
16describe('resolveMarkdownPlugins (solid)', () => {
17 it('returns defaults when no user plugins are supplied', () => {
18 const { remarkPlugins, rehypePlugins } = resolveMarkdownPlugins({})
19 expect(remarkPlugins).toEqual([remarkGfm])
20 expect(rehypePlugins).toEqual([rehypeRaw, rehypeHighlight, rehypeSanitize])
21 })
22​
23 it('appends user remark plugins after defaults', () => {
24 const { remarkPlugins } = resolveMarkdownPlugins({
25 remarkPlugins: [userRemark],
26 })
27 expect(remarkPlugins).toEqual([remarkGfm, userRemark])
28 })
29​
30 it('inserts user rehype plugins before rehype-sanitize so sanitize always runs last', () => {
31 const { rehypePlugins } = resolveMarkdownPlugins({
32 rehypePlugins: [userRehype],
33 })
34 expect(rehypePlugins).toEqual([
35 rehypeRaw,
36 rehypeHighlight,
37 userRehype,
38 rehypeSanitize,
39 ])
40 })
41​
42 it('drops defaults entirely when disableDefaultPlugins is true', () => {
43 const { remarkPlugins, rehypePlugins } = resolveMarkdownPlugins({
44 remarkPlugins: [userRemark],
45 rehypePlugins: [userRehype],
46 disableDefaultPlugins: true,
47 })
48 expect(remarkPlugins).toEqual([userRemark])
49 expect(rehypePlugins).toEqual([userRehype])
50 })
51​
52 it('returns empty arrays when defaults disabled and no user plugins given', () => {
53 const { remarkPlugins, rehypePlugins } = resolveMarkdownPlugins({
54 disableDefaultPlugins: true,
55 })
56 expect(remarkPlugins).toEqual([])
57 expect(rehypePlugins).toEqual([])
58 })
59​
60 it('does not mutate the user-supplied arrays', () => {
61 const userR = [userRemark]
62 const userH = [userRehype]
63 resolveMarkdownPlugins({ remarkPlugins: userR, rehypePlugins: userH })
64 expect(userR).toEqual([userRemark])
65 expect(userH).toEqual([userRehype])
66 })
67​
68 it('exposes default constants for documentation/reuse', () => {
69 expect(DEFAULT_REMARK_PLUGINS).toEqual([remarkGfm])
70 expect(DEFAULT_REHYPE_PLUGINS_BEFORE_USER).toEqual([
71 rehypeRaw,
72 rehypeHighlight,
73 ])
74 expect(DEFAULT_REHYPE_PLUGINS_AFTER_USER).toEqual([rehypeSanitize])
75 })
76})