prettier-plugin-imports/tests/run-test.ts

A prettier plugins to sort imports in provided RegEx order

'use strict';

import fs from 'fs';
import { extname } from 'path';
import { format } from 'prettier';
import { expect, test } from 'vitest';
import * as plugin from '../src';

export async function runTest(dirname, parsers, options) {
  options = Object.assign(
    {
      plugins: options.plugins ?? [plugin],
      tabWidth: 4,
    },
    options,
  );

  /* instabul ignore if */
  if (!parsers || !parsers.length) {
    throw new Error(`No parsers were specified for ${dirname}`);
  }

  for (const filename of fs.readdirSync(dirname)) {
    const path = dirname + '/' + filename;
    if (
      extname(filename) !== '.snap' &&
      fs.lstatSync(path).isFile() &&
      filename[0] !== '.' &&
      filename !== 'plugin.test.ts'
    ) {
      const source = read(path).replace(/\r\n/g, '\n');

      const mergedOptions = Object.assign({}, options, {
        parser: parsers[0],
      });
      test(`${filename} - ${mergedOptions.parser}-verify`, async () => {
        const output = await prettyprint(source, path, mergedOptions);
        expect(raw(source + '~'.repeat(80) + '\n' + output)).toMatchSnapshot(
          filename,
        );
      });

      for (const parserName of parsers.slice(1)) {
        test(`${filename} - ${parserName}-verify`, async () => {
          const output = await prettyprint(source, path, mergedOptions);
          const verifyOptions = Object.assign(mergedOptions, {
            parser: parserName,
          });
          const verifyOutput = await prettyprint(source, path, verifyOptions);
          expect(output).toEqual(verifyOutput);
        });
      }
    }
  }
}

export async function expectError(
  dirname: string,
  parser: string,
  expectedError: string | Error | RegExp,
  options,
) {
  options = Object.assign(
    {
      plugins: options.plugins ?? [plugin],
      tabWidth: 4,
    },
    options,
  );

  /* instabul ignore if */
  if (!parser) {
    throw new Error(`No parser was specified for ${dirname}`);
  }

  for (const filename of fs.readdirSync(dirname)) {
    const path = dirname + '/' + filename;
    if (
      extname(filename) !== '.snap' &&
      fs.lstatSync(path).isFile() &&
      filename[0] !== '.' &&
      filename !== 'plugin.test.ts'
    ) {
      const source = read(path).replace(/\r\n/g, '\n');

      const mergedOptions = Object.assign({}, options, {
        parser,
      });
      test(`${filename} - verify-error`, async () => {
        expect(() =>
          prettyprint(source, path, mergedOptions),
        ).rejects.toThrowError(expectedError);
      });
    }
  }
}

async function prettyprint(src, filename, options) {
  return await format(
    src,
    Object.assign(
      {
        filepath: filename,
      },
      options,
    ),
  );
}

function read(filename) {
  return fs.readFileSync(filename, 'utf8');
}

/**
 * Wraps a string in a marker object that is used by `./raw-serializer.js` to
 * directly print that string in a snapshot without escaping all double quotes.
 * Backticks will still be escaped.
 */
function raw(string) {
  if (typeof string !== 'string') {
    throw new Error('Raw snapshots have to be strings.');
  }
  return { [Symbol.for('raw')]: string };
}