stylelint/lib/utils/getFormatter.mjs

A mighty CSS linter that helps you avoid errors and enforce conventions.

import { existsSync } from 'node:fs';
import { resolve } from 'node:path';

import dynamicImport from './dynamicImport.mjs';
import formatters from '../formatters/index.mjs';
import getFormatterOptionsText from './getFormatterOptionsText.mjs';
import resolveOptionValue from './resolveOptionValue.mjs';

/** @import {Formatter, FormatterType, InternalApi} from 'stylelint' */

/**
 * @param {InternalApi} stylelint
 * @returns {Promise<Formatter>}
 */
export default async function getFormatter(stylelint) {
	/** @type {FormatterType | undefined} */
	let formatter = await resolveOptionValue({ stylelint, name: 'formatter' });

	if (typeof formatter === 'string') {
		let formatterFunction = formatters[formatter];

		if (formatterFunction === undefined) {
			if (existsSync(formatter)) {
				formatterFunction = await dynamicImport(resolve(formatter)).then((m) => m.default);
			} else {
				const formattersText = getFormatterOptionsText(', ', '"');

				throw new Error(`You must use a valid formatter option: ${formattersText} or a function`);
			}
		}

		return formatterFunction;
	}

	// Assume a function or a promise of a function.
	if (typeof formatter === 'function' || formatter) {
		return Promise.resolve(formatter);
	}

	formatter ??= stylelint._options._defaultFormatter ?? 'json';

	return formatters[formatter];
}