getFormatter.mjs 1.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243
  1. import { existsSync } from 'node:fs';
  2. import { resolve } from 'node:path';
  3. import dynamicImport from './dynamicImport.mjs';
  4. import formatters from '../formatters/index.mjs';
  5. import getFormatterOptionsText from './getFormatterOptionsText.mjs';
  6. import resolveOptionValue from './resolveOptionValue.mjs';
  7. /** @import {Formatter, FormatterType, InternalApi} from 'stylelint' */
  8. /**
  9. * @param {InternalApi} stylelint
  10. * @returns {Promise<Formatter>}
  11. */
  12. export default async function getFormatter(stylelint) {
  13. /** @type {FormatterType | undefined} */
  14. let formatter = await resolveOptionValue({ stylelint, name: 'formatter' });
  15. if (typeof formatter === 'string') {
  16. let formatterFunction = formatters[formatter];
  17. if (formatterFunction === undefined) {
  18. if (existsSync(formatter)) {
  19. formatterFunction = await dynamicImport(resolve(formatter)).then((m) => m.default);
  20. } else {
  21. const formattersText = getFormatterOptionsText(', ', '"');
  22. throw new Error(`You must use a valid formatter option: ${formattersText} or a function`);
  23. }
  24. }
  25. return formatterFunction;
  26. }
  27. // Assume a function or a promise of a function.
  28. if (typeof formatter === 'function' || formatter) {
  29. return Promise.resolve(formatter);
  30. }
  31. formatter ??= stylelint._options._defaultFormatter ?? 'json';
  32. return formatters[formatter];
  33. }