svgo/lib/svgo-node.test.js

'use strict';

/**
 * @typedef {import('../lib/types').Plugin} Plugin
 */

const os = require('os');
const path = require('path');
const { optimize, loadConfig } = require('./svgo-node.js');

const describeLF = os.EOL === '\r\n' ? describe.skip : describe;
const describeCRLF = os.EOL === '\r\n' ? describe : describe.skip;

describeLF('with LF line-endings', () => {
  test('should work', () => {
    const svg = `
      <?xml version="1.0" encoding="utf-8"?>
      <svg viewBox="0 0 120 120">
        <desc>
          Not standard description
        </desc>
        <circle fill="#ff0000" cx="60" cy="60" r="50"/>
      </svg>
    `;
    const { data } = optimize(svg);
    // using toEqual because line endings matter in these tests
    expect(data).toEqual(
      '<svg viewBox="0 0 120 120"><circle fill="red" cx="60" cy="60" r="50"/></svg>'
    );
  });

  test('should respect config', () => {
    const svg = `
      <?xml version="1.0" encoding="utf-8"?>
      <svg viewBox="0 0 120 120">
        <desc>
          Not standard description
        </desc>
        <circle fill="#ff0000" cx="60" cy="60" r="50"/>
      </svg>
    `;
    const { data } = optimize(svg, {
      js2svg: { pretty: true, indent: 2 },
    });
    // using toEqual because line endings matter in these tests
    expect(data).toEqual(
      '<svg viewBox="0 0 120 120">\n  <circle fill="red" cx="60" cy="60" r="50"/>\n</svg>\n'
    );
  });

  test('should respect line-ending config', () => {
    const svg = `
      <?xml version="1.0" encoding="utf-8"?>
      <svg viewBox="0 0 120 120">
        <desc>
          Not standard description
        </desc>
        <circle fill="#ff0000" cx="60" cy="60" r="50"/>
      </svg>
    `;
    const { data } = optimize(svg, {
      js2svg: { eol: 'crlf', pretty: true, indent: 2 },
    });
    // using toEqual because line endings matter in these tests
    expect(data).toEqual(
      '<svg viewBox="0 0 120 120">\r\n  <circle fill="red" cx="60" cy="60" r="50"/>\r\n</svg>\r\n'
    );
  });
});

describeCRLF('with CRLF line-endings', () => {
  test('should work', () => {
    const svg = `
      <?xml version="1.0" encoding="utf-8"?>
      <svg viewBox="0 0 120 120">
        <desc>
          Not standard description
        </desc>
        <circle fill="#ff0000" cx="60" cy="60" r="50"/>
      </svg>
    `;
    const { data } = optimize(svg);
    // using toEqual because line endings matter in these tests
    expect(data).toEqual(
      '<svg viewBox="0 0 120 120"><circle fill="red" cx="60" cy="60" r="50"/></svg>'
    );
  });

  test('should respect config', () => {
    const svg = `
      <?xml version="1.0" encoding="utf-8"?>
      <svg viewBox="0 0 120 120">
        <desc>
          Not standard description
        </desc>
        <circle fill="#ff0000" cx="60" cy="60" r="50"/>
      </svg>
    `;
    const { data } = optimize(svg, {
      js2svg: { pretty: true, indent: 2 },
    });
    // using toEqual because line endings matter in these tests
    expect(data).toEqual(
      '<svg viewBox="0 0 120 120">\r\n  <circle fill="red" cx="60" cy="60" r="50"/>\r\n</svg>\r\n'
    );
  });

  test('should respect line-ending config', () => {
    const svg = `
      <?xml version="1.0" encoding="utf-8"?>
      <svg viewBox="0 0 120 120">
        <desc>
          Not standard description
        </desc>
        <circle fill="#ff0000" cx="60" cy="60" r="50"/>
      </svg>
    `;
    const { data } = optimize(svg, {
      js2svg: { eol: 'lf', pretty: true, indent: 2 },
    });
    // using toEqual because line endings matter in these tests
    expect(data).toEqual(
      '<svg viewBox="0 0 120 120">\n  <circle fill="red" cx="60" cy="60" r="50"/>\n</svg>\n'
    );
  });
});

describe('loadConfig', () => {
  const cwd = process.cwd();
  const fixtures = path.join(cwd, './test/fixtures/config-loader');

  test('loads by absolute path', async () => {
    expect(await loadConfig(path.join(fixtures, 'one/two/config.js'))).toEqual({
      plugins: [],
    });
  });

  test('loads by relative path to cwd', async () => {
    const config = await loadConfig('one/two/config.js', fixtures);
    expect(config).toEqual({ plugins: [] });
  });

  test('searches in cwd and up', async () => {
    expect(await loadConfig(null, path.join(fixtures, 'one/two'))).toEqual({
      plugins: [],
    });
    expect(
      await loadConfig(null, path.join(cwd, './test/fixtures/missing'))
    ).toEqual(null);
    // TODO remove check in v3
    if (process.version.startsWith('v10.') === false) {
      expect(await loadConfig(null, path.join(fixtures, 'mjs'))).toEqual({
        plugins: ['mjs'],
      });
    }
    expect(await loadConfig(null, path.join(fixtures, 'cjs'))).toEqual({
      plugins: ['cjs'],
    });
  });

  test('fails when specified config does not exist', async () => {
    try {
      await loadConfig('{}');
      expect.fail('Config is loaded successfully');
    } catch (error) {
      expect(error.message).toMatch(/Cannot find module/);
    }
  });

  test('fails when exported config not an object', async () => {
    try {
      await loadConfig(path.join(fixtures, 'invalid-null.js'));
      expect.fail('Config is loaded successfully');
    } catch (error) {
      expect(error.message).toMatch(/Invalid config file/);
    }
    try {
      await loadConfig(path.join(fixtures, 'invalid-array.js'));
      expect.fail('Config is loaded successfully');
    } catch (error) {
      expect(error.message).toMatch(/Invalid config file/);
    }
    try {
      await loadConfig(path.join(fixtures, 'invalid-string.js'));
      expect.fail('Config is loaded successfully');
    } catch (error) {
      expect(error.message).toMatch(/Invalid config file/);
    }
  });

  test('handles runtime errors properly', async () => {
    try {
      await loadConfig(path.join(fixtures, 'invalid-runtime.js'));
      expect.fail('Config is loaded successfully');
    } catch (error) {
      expect(error.message).toMatch(/plugins is not defined/);
    }
    // TODO remove check in v3
    if (process.version.startsWith('v10.') === false) {
      try {
        await loadConfig(path.join(fixtures, 'invalid-runtime.mjs'));
        expect.fail('Config is loaded successfully');
      } catch (error) {
        expect(error.message).toMatch(/plugins is not defined/);
      }
    }
  });

  test('handles MODULE_NOT_FOUND properly', async () => {
    try {
      await loadConfig(path.join(fixtures, 'module-not-found.js'));
      expect.fail('Config is loaded successfully');
    } catch (error) {
      expect(error.message).toMatch(/Cannot find module 'unknown-module'/);
    }
  });
});