index.test.mjs

import { strictEqual, deepStrictEqual } from 'node:assert';
import { describe, it } from 'node:test';

import {
  parseYAMLIntoMetadata,
  transformTypeToReferenceLink,
  parseHeadingIntoMetadata,
  normalizeYamlSyntax,
} from '../index.mjs';

describe('transformTypeToReferenceLink', () => {
  it('should transform a JavaScript primitive type into a Markdown link', () => {
    strictEqual(
      transformTypeToReferenceLink('string'),
      '[`<string>`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#string_type)'
    );
  });

  it('should transform a JavaScript global type into a Markdown link', () => {
    strictEqual(
      transformTypeToReferenceLink('Array'),
      '[`<Array>`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)'
    );
  });

  it('should transform a type into a Markdown link', () => {
    strictEqual(
      transformTypeToReferenceLink('SomeOtherType', {
        SomeOtherType: 'fromTypeMap',
      }),
      '[`<SomeOtherType>`](fromTypeMap)'
    );
  });

  it('should transform a basic Generic type into a Markdown link', () => {
    strictEqual(
      transformTypeToReferenceLink('{Promise<string>}'),
      '[`<Promise>`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[`<string>`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#string_type)&gt;'
    );
  });

  it('should partially transform a Generic type if only one part is known', () => {
    strictEqual(
      transformTypeToReferenceLink('{CustomType<string>}', {}),
      '`<CustomType>`&lt;[`<string>`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#string_type)&gt;'
    );
  });

  it('should transform a Generic type with an inner union like {Promise<string|boolean>}', () => {
    strictEqual(
      transformTypeToReferenceLink('{Promise<string|boolean>}', {}),
      '[`<Promise>`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[`<string>`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#string_type) | [`<boolean>`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#boolean_type)&gt;'
    );
  });

  it('should transform multi-parameter generics like {Map<string, number>}', () => {
    strictEqual(
      transformTypeToReferenceLink('{Map<string, number>}', {}),
      '[`<Map>`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map)&lt;[`<string>`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#string_type), [`<number>`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#number_type)&gt;'
    );
  });

  it('should handle outer unions with generics like {Promise<string|number> | boolean}', () => {
    strictEqual(
      transformTypeToReferenceLink('{Promise<string|number> | boolean}', {}),
      '[`<Promise>`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[`<string>`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#string_type) | [`<number>`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#number_type)&gt; | [`<boolean>`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#boolean_type)'
    );
  });
});

describe('normalizeYamlSyntax', () => {
  it('should normalize YAML syntax by fixing noncompliant properties', () => {
    const input = `introduced_in=v0.1.21
source_link=lib/test.js
type=module
name=test_module
llm_description=This is a test module`;

    const normalizedYaml = normalizeYamlSyntax(input);

    strictEqual(
      normalizedYaml,
      `introduced_in: v0.1.21
source_link: lib/test.js
type: module
name: test_module
llm_description: This is a test module`
    );
  });

  it('should remove leading and trailing newlines', () => {
    const input = '\nintroduced_in=v0.1.21\n';

    const normalizedYaml = normalizeYamlSyntax(input);

    strictEqual(normalizedYaml, 'introduced_in: v0.1.21');
  });
});

describe('parseYAMLIntoMetadata', () => {
  it('should parse a YAML string into a JavaScript object', () => {
    const input = 'name: test\ntype: module\nintroduced_in: v1.0.0';
    const expectedOutput = {
      name: 'test',
      type: 'module',
      introduced_in: 'v1.0.0',
    };
    deepStrictEqual(parseYAMLIntoMetadata(input), expectedOutput);
  });

  it('should parse a YAML string with multiple versions into a JavaScript object', () => {
    const input = 'name: test\ntype: module\nintroduced_in: [v1.0.0, v1.1.0]';
    const expectedOutput = {
      name: 'test',
      type: 'module',
      introduced_in: ['v1.0.0', 'v1.1.0'],
    };
    deepStrictEqual(parseYAMLIntoMetadata(input), expectedOutput);
  });

  it('should parse a YAML string with source_link into a JavaScript object', () => {
    const input =
      'name: test\ntype: module\nintroduced_in: v1.0.0\nsource_link: https://github.com/nodejs/node';
    const expectedOutput = {
      name: 'test',
      type: 'module',
      introduced_in: 'v1.0.0',
      source_link: 'https://github.com/nodejs/node',
    };
    deepStrictEqual(parseYAMLIntoMetadata(input), expectedOutput);
  });

  it('should parse a raw Heading string into Heading metadata', () => {
    const input = '## test';
    const expectedOutput = {
      text: '## test',
      name: '## test',
      depth: 2,
    };
    deepStrictEqual(parseHeadingIntoMetadata(input, 2), expectedOutput);
  });
});