@shopify/theme-language-server-common/src/docset/MarkdownRenderer.spec.ts

<h1 align="center" style="position: relative;" > <br> <img src="https://github.com/Shopify/theme-check-vscode/blob/main/images/shopify_glyph.png?raw=true" alt="logo" width="141" height="160"> <br> Theme Language Server </h1>

import { describe, it, expect } from 'vitest';

import { render, renderHtmlEntry, type HtmlEntry } from './MarkdownRenderer';
import type { DocsetEntry } from '@shopify/theme-check-common';

const DOC_ENTRY: DocsetEntry = {
  name: 'entry',
  summary: 'summary',
  description: 'description',
  deprecated: false,
};

const HTML_ENTRY: HtmlEntry = {
  name: 'entry',
  description: 'description',
};

describe('MarkdownRenderer', () => {
  describe('render()', () => {
    it('converts a docset entry to markdown', async () => {
      expect(render(DOC_ENTRY)).toEqual(`### entry\nsummary\n\n---\n\ndescription`);
    });

    describe('when the entry has syntax', () => {
      it('includes the syntax in the markdown', async () => {
        expect(render({ ...DOC_ENTRY, syntax: 'string | image_tag' })).toEqual(
          `### entry\n\`\`\`liquid\n{{ string | image_tag }}\n\`\`\`\n\n---\n\nsummary\n\n---\n\ndescription`,
        );
      });

      describe('and the syntax already includes liquid tags', () => {
        it('does not wrap the syntax in curly braces', async () => {
          expect(render({ ...DOC_ENTRY, syntax: '{% form %}' })).toEqual(
            `### entry\n\`\`\`liquid\n{% form %}\n\`\`\`\n\n---\n\nsummary\n\n---\n\ndescription`,
          );
        });
      });
    });
  });

  describe('renderHtmlEntry()', () => {
    it('converts a docset entry to markdown', async () => {
      expect(renderHtmlEntry(HTML_ENTRY)).toEqual(`### entry\ndescription`);
    });
  });
});