stylelint-formatter-pretty - npm Package Compare versions

Comparing version 3.2.1 to 4.0.0

index.js

@@ -0,4 +1,231 @@
+import path from 'node:path';
+import process from 'node:process';
+import pico from 'picocolors';
+import logSymbols from 'log-symbols';
+import plur from 'plur';
+import stringWidth from 'string-width';
+import ansiEscapes from 'ansi-escapes';
+import {supportsHyperlink} from 'supports-hyperlinks';
+
 /**
+ * @param {string|undefined} rule Stylelint rule
+ * @param {import('stylelint').LinterResult} linterResult Linter result
+ * @returns {string|undefined} URL
+ */
+function getRuleUrl(rule, linterResult) {
+	let ruleUrl;
+
+	try {
+		ruleUrl = linterResult.ruleMetadata[rule].url;
+	} catch {}
+
+	return ruleUrl;
+}
+
+/**
  * @type {import('stylelint').Formatter}
  */
-export {default} from './index.cjs';
+function formatter(results, returnValue) {
+	if (Array.isArray(results) && results.length > 0) {
+		const lines = [];
+		let errorCount = 0;
+		let warningsCount = 0;
+		let deprecationsCount = 0;
+		let invalidOptionWarningsCount = 0;
+		let maxLineWidth = 0;
+		let maxColumnWidth = 0;
+		let maxMessageWidth = 0;
+		let showLineNumbers = false;
+		let deprecations = [];
+		let invalidOptionWarnings = [];
+
+		const cleanUpAdditionals = items => items
+			.sort((a, b) => a.text === b.text)
+			.filter((item, idx, array) => array.findIndex(d => d.text === item.text) === idx)
+			.map(item => ({
+				text: item.text.replaceAll(/\B"(.*?)"\B|\B'(.*?)'\B/g, (m, p1, p2) => pico.bold(p1 || p2)),
+			}));
+
+		results
+			.sort((a, b) => a.warnings.length - b.warnings.length)
+			.forEach(result => {
+				const {warnings} = result;
+
+				for (const x of result.deprecations) {
+					deprecations.push(x);
+				}
+
+				for (const x of result.invalidOptionWarnings) {
+					invalidOptionWarnings.push(x);
+				}
+
+				if (Array.isArray(result.parseErrors)) {
+					for (const x of result.parseErrors) {
+						warnings.push(x);
+					}
+				}
+
+				if (warnings.length === 0) {
+					return;
+				}
+
+				if (lines.length > 0) {
+					lines.push({type: 'separator'});
+				}
+
+				const filePath = result.source;
+
+				lines.push({
+					type: 'header',
+					filePath,
+					relativeFilePath: path.relative('.', filePath),
+					firstLineCol: warnings[0].line + ':' + warnings[0].column,
+				});
+
+				warnings
+					.sort((a, b) => {
+						if (a.severity === b.severity) {
+							if (a.line === b.line) {
+								return a.column < b.column ? -1 : 1;
+							}
+
+							return a.line < b.line ? -1 : 1;
+						}
+
+						if (a.severity === 2 && b.severity !== 2) {
+							return 1;
+						}
+
+						return -1;
+					})
+					.forEach(x => {
+						let message = x.text;
+
+						// Remove rule ID from message
+						message = message.replaceAll(/\s\(.+\)$/g, '');
+
+						// Stylize inline code blocks
+						message = message.replaceAll(/\B"(.*?)"\B|\B'(.*?)'\B/g, (m, p1, p2) => pico.bold(p1 || p2));
+
+						const line = String(x.line || 0);
+						const column = String(x.column || 0);
+						const lineWidth = stringWidth(line);
+						const columnWidth = stringWidth(column);
+						const messageWidth = stringWidth(message);
+						let severity = 'warning';
+						if (x.severity === 2 || x.severity === 'error') {
+							severity = 'error';
+							errorCount++;
+						} else {
+							warningsCount++;
+						}
+
+						maxLineWidth = Math.max(lineWidth, maxLineWidth);
+						maxColumnWidth = Math.max(columnWidth, maxColumnWidth);
+						maxMessageWidth = Math.max(messageWidth, maxMessageWidth);
+						showLineNumbers = showLineNumbers || x.line || x.column;
+
+						lines.push({
+							type: 'message',
+							severity,
+							line,
+							lineWidth,
+							column,
+							columnWidth,
+							message,
+							messageWidth,
+							ruleId: x.rule || '',
+							ruleUrl: getRuleUrl(x.rule, returnValue),
+						});
+					});
+			});
+
+		deprecations = cleanUpAdditionals(deprecations);
+		deprecationsCount = deprecations.length;
+
+		invalidOptionWarnings = cleanUpAdditionals(invalidOptionWarnings);
+		invalidOptionWarningsCount = invalidOptionWarnings.length;
+
+		let output = '\n';
+
+		if (process.stdout.isTTY && !process.env.CI) {
+			// Make relative paths Cmd+click'able in iTerm
+			output += ansiEscapes.iTerm.setCwd();
+		}
+
+		output += lines.map(x => {
+			if (x.type === 'header') {
+				// Add the line number so it's Cmd+click'able in some terminals
+				// Use dim & gray for terminals like iTerm that doesn't support `hidden`
+				const position = showLineNumbers ? pico.hidden(pico.dim(pico.gray(`:${x.firstLineCol}`))) : '';
+
+				return '  ' + pico.underline(x.relativeFilePath + position);
+			}
+
+			if (x.type === 'message') {
+				const rule = (x.ruleUrl && supportsHyperlink(process.stdout) ? ansiEscapes.link(x.ruleId, x.ruleUrl) : x.ruleId);
+				const line = [
+					'',
+					x.severity === 'warning' ? logSymbols.warning : logSymbols.error,
+					' '.repeat(maxLineWidth - x.lineWidth) + pico.dim(x.line + pico.gray(':') + x.column),
+					' '.repeat(maxColumnWidth - x.columnWidth) + x.message,
+					' '.repeat(maxMessageWidth - x.messageWidth) + pico.dim(rule),
+				];
+
+				if (!showLineNumbers) {
+					line.splice(2, 1);
+				}
+
+				return line.join('  ');
+			}
+
+			return '';
+		}).join('\n');
+
+		if (warningsCount + errorCount > 0) {
+			output += '\n\n';
+		}
+
+		if (deprecationsCount + invalidOptionWarningsCount > 0) {
+			output += `  ${pico.underline('Stylelint Configuration')}\n`;
+		}
+
+		output += deprecations.map(x => '  ' + logSymbols.info + ' ' + x.text).join('\n');
+
+		if (deprecationsCount > 0) {
+			output += '\n';
+		}
+
+		output += invalidOptionWarnings.map(x => '  ' + logSymbols.error + ' ' + x.text).join('\n');
+
+		if (invalidOptionWarningsCount > 0) {
+			output += '\n';
+		}
+
+		if (deprecationsCount + invalidOptionWarningsCount > 0) {
+			output += '\n';
+		}
+
+		if (warningsCount > 0) {
+			output += '  ' + pico.yellow(`${warningsCount} ${plur('warning', warningsCount)}`) + '\n';
+		}
+
+		if (errorCount > 0) {
+			output += '  ' + pico.red(`${errorCount} ${plur('error', errorCount)}`) + '\n';
+		}
+
+		if (deprecationsCount > 0) {
+			output += '  ' + pico.blue(`${deprecationsCount} ${plur('deprecation', deprecationsCount)}`) + '\n';
+		}
+
+		if (invalidOptionWarningsCount > 0) {
+			output += '  ' + pico.red(`${invalidOptionWarningsCount} invalid ${plur('option', invalidOptionWarningsCount)}`) + '\n';
+		}
+
+		return (errorCount + warningsCount + deprecationsCount + invalidOptionWarningsCount) > 0 ? output : '';
+	}
+
+	return '';
+}
+
+export default formatter;

package.json

 {
   "name": "stylelint-formatter-pretty",
-  "version": "3.2.1",
+  "version": "4.0.0",
   "description": "A pretty Stylelint formatter.",
@@ -23,13 +23,6 @@ "license": "MIT",
   "engines": {
-    "node": ">=14"
+    "node": ">=18.12.0"
   },
   "type": "module",
-  "main": "index.cjs",
-  "module": "index.js",
-  "exports": {
-    ".": {
-      "require": "./index.cjs",
-      "default": "./index.js"
-    }
-  },
+  "exports": "./index.js",
   "scripts": {
@@ -40,3 +33,2 @@ "test": "xo && c8 ava",
   "files": [
-    "index.cjs",
     "index.js"
@@ -53,19 +45,22 @@ ],
   "dependencies": {
-    "ansi-escapes": "~4.3.2",
-    "log-symbols": "~4.1.0",
+    "ansi-escapes": "^6.2.0",
+    "log-symbols": "^6.0.0",
     "picocolors": "^1.0.0",
-    "plur": "~4.0.0",
-    "string-width": "~4.2.2",
+    "plur": "^5.1.0",
+    "string-width": "^7.0.0",
     "supports-hyperlinks": "^3.0.0"
   },
   "devDependencies": {
-    "ava": "^5.3.0",
+    "ava": "^6.0.1",
     "c8": "^8.0.0",
     "husky": "^8.0.1",
-    "lint-staged": "^13.2.2",
+    "lint-staged": "^15.2.0",
     "strip-ansi": "^7.1.0",
-    "xo": "^0.54.2"
+    "xo": "^0.56.0"
   },
+  "peerDependencies": {
+    "stylelint": ">=16.0.0"
+  },
   "lint-staged": {
-    "*.?({c,m})js": "xo --fix"
+    "*.js": "xo --fix"
   },
@@ -72,0 +67,0 @@ "xo": {

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

11615

decreased by-1.7%

Dependency count

7

increased by16.67%

Number of package files

4

decreased by-20%

Lines of code

185

decreased by-2.12%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Added@babel/code-frame@7.26.2(transitive)

• + Added@babel/helper-validator-identifier@7.25.9(transitive)

• + Added@csstools/css-parser-algorithms@3.0.4(transitive)

• + Added@csstools/css-tokenizer@3.0.3(transitive)

• + Added@csstools/selector-specificity@5.0.0(transitive)

• + Added@dual-bundle/import-meta-resolve@4.1.0(transitive)

• + Added@keyv/serialize@1.0.2(transitive)

• + Added@nodelib/fs.scandir@2.1.5(transitive)

• + Added@nodelib/fs.stat@2.0.5(transitive)

• + Added@nodelib/fs.walk@1.2.8(transitive)

• + Addedajv@8.17.1(transitive)

• + Addedansi-escapes@6.2.1(transitive)

• + Addedansi-regex@6.1.0(transitive)

• + Addedargparse@2.0.1(transitive)

• + Addedarray-union@2.1.0(transitive)

• + Addedastral-regex@2.0.0(transitive)

• + Addedbalanced-match@2.0.0(transitive)

• + Addedbase64-js@1.5.1(transitive)

• + Addedbraces@3.0.3(transitive)

• + Addedbuffer@6.0.3(transitive)

• + Addedcacheable@1.8.8(transitive)

• + Addedcallsites@3.1.0(transitive)

• + Addedchalk@5.4.1(transitive)

• + Addedcolord@2.9.3(transitive)

• + Addedcosmiconfig@9.0.0(transitive)

• + Addedcss-functions-list@3.2.3(transitive)

• + Addedcss-tree@3.1.0(transitive)

• + Addedcssesc@3.0.0(transitive)

• + Addeddebug@4.4.0(transitive)

• + Addeddir-glob@3.0.1(transitive)

• + Addedemoji-regex@10.4.0(transitive)

• + Addedenv-paths@2.2.1(transitive)

• + Addederror-ex@1.3.2(transitive)

• + Addedfast-deep-equal@3.1.3(transitive)

• + Addedfast-glob@3.3.3(transitive)

• + Addedfast-uri@3.0.6(transitive)

• + Addedfastest-levenshtein@1.0.16(transitive)

• + Addedfastq@1.19.0(transitive)

• + Addedfile-entry-cache@10.0.6(transitive)

• + Addedfill-range@7.1.1(transitive)

• + Addedflat-cache@6.1.6(transitive)

• + Addedflatted@3.3.2(transitive)

• + Addedget-east-asian-width@1.3.0(transitive)

• + Addedglob-parent@5.1.2(transitive)

• + Addedglobal-modules@2.0.0(transitive)

• + Addedglobal-prefix@3.0.0(transitive)

• + Addedglobby@11.1.0(transitive)

• + Addedglobjoin@0.1.4(transitive)

• + Addedhookified@1.7.0(transitive)

• + Addedhtml-tags@3.3.1(transitive)

• + Addedieee754@1.2.1(transitive)

• + Addedignore@5.3.27.0.3(transitive)

• + Addedimport-fresh@3.3.0(transitive)

• + Addedimurmurhash@0.1.4(transitive)

• + Addedini@1.3.8(transitive)

• + Addedis-arrayish@0.2.1(transitive)

• + Addedis-extglob@2.1.1(transitive)

• + Addedis-glob@4.0.3(transitive)

• + Addedis-number@7.0.0(transitive)

• + Addedis-plain-object@5.0.0(transitive)

• + Addedis-unicode-supported@1.3.0(transitive)

• + Addedisexe@2.0.0(transitive)

• + Addedjs-tokens@4.0.0(transitive)

• + Addedjs-yaml@4.1.0(transitive)

• + Addedjson-parse-even-better-errors@2.3.1(transitive)

• + Addedjson-schema-traverse@1.0.0(transitive)

• + Addedkeyv@5.2.3(transitive)

• + Addedkind-of@6.0.3(transitive)

• + Addedknown-css-properties@0.35.0(transitive)

• + Addedlines-and-columns@1.2.4(transitive)

• + Addedlodash.truncate@4.4.2(transitive)

• + Addedlog-symbols@6.0.0(transitive)

• + Addedmathml-tag-names@2.1.3(transitive)

• + Addedmdn-data@2.12.2(transitive)

• + Addedmeow@13.2.0(transitive)

• + Addedmerge2@1.4.1(transitive)

• + Addedmicromatch@4.0.8(transitive)

• + Addedms@2.1.3(transitive)

• + Addednanoid@3.3.8(transitive)

• + Addednormalize-path@3.0.0(transitive)

• + Addedparent-module@1.0.1(transitive)

• + Addedparse-json@5.2.0(transitive)

• + Addedpath-type@4.0.0(transitive)

• + Addedpicomatch@2.3.1(transitive)

• + Addedplur@5.1.0(transitive)

• + Addedpostcss@8.5.1(transitive)

• + Addedpostcss-resolve-nested-selector@0.1.6(transitive)

• + Addedpostcss-safe-parser@7.0.1(transitive)

• + Addedpostcss-selector-parser@7.0.0(transitive)

• + Addedpostcss-value-parser@4.2.0(transitive)

• + Addedqueue-microtask@1.2.3(transitive)

• + Addedrequire-from-string@2.0.2(transitive)

• + Addedresolve-from@4.0.05.0.0(transitive)

• + Addedreusify@1.0.4(transitive)

• + Addedrun-parallel@1.2.0(transitive)

• + Addedsignal-exit@4.1.0(transitive)

• + Addedslash@3.0.0(transitive)

• + Addedslice-ansi@4.0.0(transitive)

• + Addedsource-map-js@1.2.1(transitive)

• + Addedstring-width@7.2.0(transitive)

• + Addedstrip-ansi@7.1.0(transitive)

• + Addedstylelint@16.14.1(transitive)

• + Addedsvg-tags@1.0.0(transitive)

• + Addedtable@6.9.0(transitive)

• + Addedto-regex-range@5.0.1(transitive)

• + Addedutil-deprecate@1.0.2(transitive)

• + Addedwhich@1.3.1(transitive)

• + Addedwrite-file-atomic@5.0.1(transitive)

• - Removedansi-escapes@4.3.2(transitive)

• - Removedchalk@4.1.2(transitive)

• - Removedis-unicode-supported@0.1.0(transitive)

• - Removedlog-symbols@4.1.0(transitive)

• - Removedplur@4.0.0(transitive)

• - Removedtype-fest@0.21.3(transitive)

• Updatedansi-escapes@^6.2.0

• Updatedlog-symbols@^6.0.0

• Updatedplur@^5.1.0

• Updatedstring-width@^7.0.0