lint/utils.test.js

/* This file is a part of @mdn/browser-compat-data
 * See LICENSE file for more information. */

/** @import {InternalSimpleSupportStatement} from '../types/index.js' */

import { describe, it } from 'node:test';
import assert from 'node:assert/strict';

import {
  createStatementGroupKey,
  escapeInvisibles,
  jsonDiff,
  replaceCodeTagsWithBackticks,
  replaceLinkTagsWithMarkdown,
} from './utils.js';

describe('utils', () => {
  it('`escapeInvisibles()` works correctly', () => {
    const EXPECTED = [
      /* ␀ */ ['\0', '\\0'],
      /* ␁ */ '\x01',
      /* ␂ */ '\x02',
      /* ␃ */ '\x03',
      /* ␄ */ '\x04',
      /* ␅ */ '\x05',
      /* ␆ */ '\x06',
      /* ␇ */ '\x07',
      /* ␈ */ ['\b', '\\b'],
      /* ␉ */ ['\t', '\\t'],
      /* ␊ */ ['\n', '\\n'],
      /* ␋ */ ['\v', '\\v'],
      /* ␌ */ ['\f', '\\f'],
      /* ␍ */ ['\r', '\\r'],
      /* ␏ */ '\x0F',
      /* ␎ */ '\x0E',
      /* ␐ */ '\x10',
      /* ␑ */ '\x11',
      /* ␒ */ '\x12',
      /* ␓ */ '\x13',
      /* ␔ */ '\x14',
      /* ␕ */ '\x15',
      /* ␖ */ '\x16',
      /* ␗ */ '\x17',
      /* ␘ */ '\x18',
      /* ␙ */ '\x19',
      /* ␚ */ '\x1A',
      /* ␛ */ '\x1B',
      /* ␜ */ '\x1C',
      /* ␝ */ '\x1D',
      /* ␞ */ '\x1E',
      /* ␟ */ '\x1F',
      /* ␠ */ ' ',
      /* ␡ */ '\x7F',
    ];

    for (const data of EXPECTED) {
      let char, expected;
      if (typeof data === 'string') {
        char = data;
        expected = data;
      } else {
        [char, expected = char] = data;
      }
      assert.equal(escapeInvisibles(char), expected);
    }
  });

  it('jsonDiff() works correctly', () => {
    assert.notEqual(
      jsonDiff(
        JSON.stringify({ a: 1, b: 2 }, null, 2),
        JSON.stringify({ a: 1 }, null, 2),
      ),
      null,
    );
    assert.notEqual(
      jsonDiff(
        JSON.stringify({ a: 1 }, null, 2),
        JSON.stringify({ a: 2 }, null, 2),
      ),
      null,
    );
  });

  it('`replaceCodeTagsWithBackticks()` works correctly', () => {
    assert.equal(
      replaceCodeTagsWithBackticks('<code>transient_attachment</code> usage'),
      '`transient_attachment` usage',
    );
    assert.equal(
      replaceCodeTagsWithBackticks('<code>foo</code> and <code>bar</code>'),
      '`foo` and `bar`',
    );
    assert.equal(
      replaceCodeTagsWithBackticks('`already` markdown'),
      '`already` markdown',
    );
    assert.equal(
      replaceCodeTagsWithBackticks('Use `<code>` element'),
      'Use `<code>` element',
    );
  });

  it('`replaceLinkTagsWithMarkdown()` works correctly', () => {
    assert.equal(
      replaceLinkTagsWithMarkdown(
        "See <a href='https://bugzil.la/1'>bug 1</a>.",
      ),
      'See [bug 1](https://bugzil.la/1).',
    );
    assert.equal(
      replaceLinkTagsWithMarkdown(
        'See <a href="https://bugzil.la/1">bug 1</a>.',
      ),
      'See [bug 1](https://bugzil.la/1).',
    );
    assert.equal(
      replaceLinkTagsWithMarkdown(
        "<a href='https://bugzil.la/1'>bug 1</a> and <a href='https://bugzil.la/2'>bug 2</a>",
      ),
      '[bug 1](https://bugzil.la/1) and [bug 2](https://bugzil.la/2)',
    );
    assert.equal(
      replaceLinkTagsWithMarkdown(
        "<a href='https://example.com'>`code` text</a>",
      ),
      '[`code` text](https://example.com)',
    );
    assert.equal(
      replaceLinkTagsWithMarkdown('[already](https://example.com) markdown'),
      '[already](https://example.com) markdown',
    );
    assert.equal(
      replaceLinkTagsWithMarkdown(
        "<a href='https://example.com'><code>code</code></a>",
      ),
      "<a href='https://example.com'><code>code</code></a>",
    );
  });

  it('createStatementGroupKey() works correctly', () => {
    /** @type {Record<string, InternalSimpleSupportStatement>} */
    const tests = {
      'normal name': {
        version_added: '1',
      },
      'alt. name: foobar': {
        version_added: '2',
        alternative_name: 'foobar',
      },
      'prefix: -moz-': {
        version_added: '3',
        prefix: '-moz-',
      },
      'preference: #service-worker-payment-apps': {
        version_added: '4',
        flags: [
          {
            type: 'preference',
            name: '#service-worker-payment-apps',
            value_to_set: 'Enabled',
          },
        ],
      },
      'alt. name: foobar / preference: #service-worker-payment-apps': {
        version_added: '4',
        alternative_name: 'foobar',
        flags: [
          {
            type: 'preference',
            name: '#service-worker-payment-apps',
            value_to_set: 'Enabled',
          },
        ],
      },
    };

    for (const [expected, input] of Object.entries(tests)) {
      assert.equal(createStatementGroupKey(input), expected);
    }
  });
});