| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181 |
- // NOTICE: This file is generated by Rollup. To modify it,
- // please instead edit the ESM counterpart and rebuild with Rollup (npm run build).
- 'use strict';
- const picocolors = require('picocolors');
- const pluralize = require('../utils/pluralize.cjs');
- const stringFormatter = require('./stringFormatter.cjs');
- const terminalLink = require('./terminalLink.cjs');
- const { underline, red, yellow, dim, green } = picocolors;
- /** @import {Formatter, LintResult, RuleMeta, Severity, Warning} from 'stylelint' */
- /**
- * @type {Formatter}
- */
- function verboseFormatter(results, returnValue) {
- let output = stringFormatter(results, returnValue);
- if (output === '') {
- output = '\n';
- }
- const ignoredCount = results.filter((result) => result.ignored).length;
- const checkedDisplay = ignoredCount
- ? `${results.length - ignoredCount} of ${results.length}`
- : results.length;
- output += underline(`${checkedDisplay} ${pluralize('source', results.length)} checked\n`);
- for (const result of results) {
- let formatting = green;
- if (result.errored) {
- formatting = red;
- } else if (result.warnings.length) {
- formatting = yellow;
- } else if (result.ignored) {
- formatting = dim;
- }
- let sourceText = fileLink(result.source);
- if (result.ignored) {
- sourceText += ' (ignored)';
- }
- output += formatting(` ${sourceText}\n`);
- }
- const warnings = results.flatMap((r) => r.warnings);
- if (warnings.length === 0) {
- output += '\n0 problems found\n';
- } else {
- const warningsBySeverity = groupBy(warnings, (w) => w.severity);
- /**
- * @param {Severity} severity
- */
- const printProblems = (severity) => {
- const problems = warningsBySeverity[severity];
- if (problems === undefined) return;
- output += '\n';
- output += underline(`${problems.length} ${pluralize(severity, problems.length)} found\n`);
- const problemsByRule = groupBy(problems, (w) => w.rule);
- const metadata = returnValue.ruleMetadata;
- for (const [rule, list] of Object.entries(problemsByRule)) {
- const meta = metadata[rule] || {};
- let additional = [meta.fixable ? 'maybe fixable' : '', meta.deprecated ? 'deprecated' : '']
- .filter(Boolean)
- .join(', ');
- additional = additional ? ` (${additional})` : '';
- output += dim(` ${ruleLink(rule, meta)}: ${list.length}${additional}\n`);
- }
- };
- printProblems('error');
- printProblems('warning');
- }
- const fixedRules = getFixedRules(results);
- if (fixedRules.size) {
- let lines = '\n';
- let total = 0;
- for (const [name, count] of fixedRules) {
- const meta = returnValue.ruleMetadata[name];
- lines += dim(` ${ruleLink(name, meta)}: ${count}\n`);
- total += count;
- }
- output += '\n';
- output += underline(`${total} ${pluralize('problem', total)} fixed`);
- output += lines;
- }
- return `${output}\n`;
- }
- /**
- * @template {string} K
- * @param {Warning[]} array
- * @param {(w: Warning) => K} keyFn
- * @returns {Record<K, Warning[]>}
- * @todo replace by Object.groupBy once support for Node.js version 20 is dropped
- */
- function groupBy(array, keyFn) {
- /** @type {Record<string, Warning[]>} */
- const result = {};
- for (const item of array) {
- const key = keyFn(item);
- let warnings = result[key];
- if (warnings === undefined) {
- result[key] = warnings = [];
- }
- warnings.push(item);
- }
- return result;
- }
- /**
- * @param {string | undefined} source
- * @returns {string}
- */
- function fileLink(source) {
- if (!source || source.startsWith('<')) {
- return `${source}`;
- }
- return terminalLink(source, `file://${source}`);
- }
- /**
- * @param {string} rule
- * @param {Partial<RuleMeta> | undefined} metadata
- * @returns {string}
- */
- function ruleLink(rule, metadata) {
- if (metadata && metadata.url) {
- return terminalLink(rule, metadata.url);
- }
- return rule;
- }
- /** @param {LintResult[]} results */
- function getFixedRules(results) {
- /** @type {Map<string, number>} */
- const rules = new Map();
- for (const { _postcssResult } of results) {
- if (!_postcssResult) continue; // CSS syntax error
- const {
- stylelint: { fixersData },
- } = _postcssResult;
- const entries = Object.entries(fixersData);
- for (const [ruleName, count] of entries) {
- if (count) rules.set(ruleName, count);
- }
- }
- return rules;
- }
- module.exports = verboseFormatter;
|