Make locations visible (Intellij) (#149)

.changeset/early-knives-type.md

@@ -0,0 +1,5 @@
+---
+'@steiger/pretty-reporter': minor
+---
+
+Make printed diagnostic location more readable

packages/pretty-reporter/package.json

@@ -41,6 +41,7 @@
   "dependencies": {
     "chalk": "^5.3.0",
     "figures": "^6.1.0",
+    "picocolors": "^1.1.1",
     "terminal-link": "^3.0.0"
   }
 }

packages/pretty-reporter/src/format-single-diagnostic.ts

@@ -1,18 +1,18 @@
 import { relative } from 'node:path'
 import figures from 'figures'
 import terminalLink from 'terminal-link'
-import chalk from 'chalk'
+import pc from 'picocolors'
 import type { Diagnostic } from '@steiger/types'
 
 export function formatSingleDiagnostic(d: Diagnostic, cwd: string): string {
-  const x = d.severity === 'error' ? chalk.red(figures.cross) : chalk.yellow(figures.warning)
-  const s = chalk.reset(figures.lineDownRight)
-  const bar = chalk.reset(figures.lineVertical)
-  const e = chalk.reset(figures.lineUpRight)
-  const message = chalk.reset(d.message)
-  const autofixable = d.fixes !== undefined && d.fixes.length > 0 ? chalk.green(`${figures.tick} Auto-fixable`) : null
-  const location = chalk.gray(formatLocation(d.location, cwd))
-  const ruleName = chalk.blue(terminalLink(d.ruleName, d.getRuleDescriptionUrl(d.ruleName).toString()))
+  const x = d.severity === 'error' ? pc.red(figures.cross) : pc.yellow(figures.warning)
+  const s = pc.reset(figures.lineDownRight)
+  const bar = pc.reset(figures.lineVertical)
+  const e = pc.reset(figures.lineUpRight)
+  const message = pc.reset(d.message)
+  const autofixable = d.fixes !== undefined && d.fixes.length > 0 ? pc.green(`${figures.tick} Auto-fixable`) : null
+  const location = pc.underline(formatLocation(d.location, cwd))
+  const ruleName = pc.blue(terminalLink(d.ruleName, d.getRuleDescriptionUrl(d.ruleName).toString()))
 
   return `
 ${s} ${location}

packages/pretty-reporter/src/index.ts

@@ -1,4 +1,4 @@
-import chalk from 'chalk'
+import pc from 'picocolors'
 import figures from 'figures'
 import type { Diagnostic } from '@steiger/types'
 
@@ -7,7 +7,7 @@ import { s } from './pluralization.js'
 
 export function formatPretty(diagnostics: Array<Diagnostic>, cwd: string) {
   if (diagnostics.length === 0) {
-    return chalk.green(`${figures.tick} No problems found!`)
+    return pc.green(`${figures.tick} No problems found!`)
   }
 
   const errors = diagnostics.filter((d) => d.severity === 'error')
@@ -16,17 +16,17 @@ export function formatPretty(diagnostics: Array<Diagnostic>, cwd: string) {
   let footer =
     'Found ' +
     [
-      errors.length > 0 && chalk.red.bold(`${errors.length} error${s(errors.length)}`),
-      warnings.length > 0 && chalk.yellow.bold(`${warnings.length} warning${s(warnings.length)}`),
+      errors.length > 0 && pc.bold(pc.red(`${errors.length} error${s(errors.length)}`)),
+      warnings.length > 0 && pc.bold(pc.yellow(`${warnings.length} warning${s(warnings.length)}`)),
     ]
       .filter(Boolean)
       .join(' and ')
 
   const autofixable = diagnostics.filter((d) => (d.fixes?.length ?? 0) > 0)
   if (autofixable.length === diagnostics.length) {
-    footer += ` (all can be fixed automatically with ${chalk.green.bold('--fix')})`
+    footer += ` (all can be fixed automatically with ${pc.bold(pc.green('--fix'))})`
   } else if (autofixable.length > 0) {
-    footer += ` (${autofixable.length} can be fixed automatically with ${chalk.green.bold('--fix')})`
+    footer += ` (${autofixable.length} can be fixed automatically with ${pc.bold(pc.green('--fix'))})`
   } else {
     footer += ' (none can be fixed automatically)'
   }
@@ -36,7 +36,7 @@ export function formatPretty(diagnostics: Array<Diagnostic>, cwd: string) {
     diagnostics.map((d) => formatSingleDiagnostic(d, cwd)).join('\n\n') +
     '\n\n' +
     // Due to formatting characters, it won't be exactly the size of the footer, that is okay
-    chalk.gray(figures.line.repeat(footer.length)) +
+    pc.gray(figures.line.repeat(footer.length)) +
     '\n ' +
     footer +
     '\n'