lint/fixer/feature-order.test.js

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

import assert from 'node:assert/strict';

import fixFeatureOrder from './feature-order.js';

const compat = {
  support: { chrome: { version_added: '1' } },
  status: { experimental: false, standard_track: true, deprecated: false },
};

describe('fix -> feature order', () => {
  it('sorts subfeatures of a feature that has __compat', () => {
    const input = JSON.stringify({
      api: {
        MyInterface: {
          __compat: compat,
          zebra: { __compat: compat },
          alpha: { __compat: compat },
        },
      },
    });

    const result = JSON.parse(fixFeatureOrder('api/MyInterface.json', input));
    const keys = Object.keys(result.api.MyInterface);
    assert.deepStrictEqual(keys, ['__compat', 'alpha', 'zebra']);
  });

  it('sorts two levels of nested namespace containers', () => {
    const input = JSON.stringify({
      svg: {
        elements: {
          zebra_group: {
            zebra: { __compat: compat },
            alpha: { __compat: compat },
          },
          alpha_group: {
            zebra: { __compat: compat },
            alpha: { __compat: compat },
          },
        },
      },
    });

    const result = JSON.parse(fixFeatureOrder('svg/elements.json', input));
    const { elements } = result.svg;
    assert.deepStrictEqual(Object.keys(elements), [
      'alpha_group',
      'zebra_group',
    ]);
    assert.deepStrictEqual(Object.keys(elements.alpha_group), [
      'alpha',
      'zebra',
    ]);
    assert.deepStrictEqual(Object.keys(elements.zebra_group), [
      'alpha',
      'zebra',
    ]);
  });

  it('sorts subfeatures of a namespace container that has no __compat', () => {
    const input = JSON.stringify({
      svg: {
        global_attributes: {
          zebra: { __compat: compat },
          alpha: { __compat: compat },
        },
      },
    });

    const result = JSON.parse(
      fixFeatureOrder('svg/global_attributes.json', input),
    );
    const keys = Object.keys(result.svg.global_attributes);
    assert.deepStrictEqual(keys, ['alpha', 'zebra']);
  });

  it('returns input unchanged for browsers/ files', () => {
    const input = JSON.stringify({
      browsers: {
        firefox: {
          name: 'Firefox',
          type: 'desktop',
          preview_name: 'Nightly',
          pref_url: 'about:config',
          accepts_flags: true,
          accepts_webextensions: true,
        },
      },
    });

    const result = fixFeatureOrder('path/to/browsers/firefox.json', input);
    assert.strictEqual(result, input);
  });
});