Improve readability of console output

Author: hyperupcall

commands/lint.ts

@@ -2,7 +2,7 @@
 // SPDX-FileCopyrightText: Copyright 2023 Edwin Kofler
 import * as path from 'node:path'
 import * as fs from 'node:fs/promises'
-import * as readline from 'node:readline/promises'
+import * as inquirer from '@inquirer/prompts'
 import { styleText } from 'node:util'
 import os from 'node:os'
 import { fileExists, pkgRoot } from '#common'
@@ -273,7 +273,7 @@ async function fixFromFile(
 				}
 			}
 
-			console.info(`[EVAL] ${fixId}: Found issue`)
+			console.info(`[EVAL] ${fixId}`)
 			if (Array.isArray(issue.message)) {
 				for (const message of issue.message) {
 					console.info(` -> ${message}`)
@@ -294,15 +294,20 @@ async function fixFromFile(
 			if (options.yes) {
 				shouldRunFix = true
 			} else {
-				const rl = readline.createInterface({
-					input: process.stdin,
-					output: process.stdout,
-				})
-				const input = await rl.question(
-					`Would you like to fix this issue? (y/n): `,
-				)
-				rl.close()
-				shouldRunFix = yn(input)
+				try {
+					shouldRunFix = await inquirer.confirm({
+						message: 'Would you like to fix this issue?',
+						default: true,
+					}, { clearPromptOnDone: true })
+				} catch (err) {
+					if (err.name === 'ExitPromptError') {
+						printWithTips(`[${styleText('red', 'FAIL')}] ${fixId}`, [
+							'Failed because the user exited the prompt',
+						])
+						Deno.exit(1)
+					}
+					throw err
+				}
 			}
 
 			if (shouldRunFix) {

config/common.ts

@@ -45,15 +45,28 @@ export async function* filesMustHaveContent(
 				const content = await fs.readFile(file, 'utf-8')
 				if (content !== expectedContent) {
 					yield {
-						message:
-							`  -> Expected file "${file}" to have content:\n---\n${expectedContent}\n---\n  -> But, the file has content:\n---\n${content}\n---\n`,
+						message: dedent`
+							-> Expected file "${file}" to have content:
+							${'='.repeat(80)}
+							${expectedContent}
+							${'='.repeat(80)}
+							-> But, the file has content:
+							${'='.repeat(80)}
+							${content}
+							${'='.repeat(80)}
+							`,
 						fix: () => fs.writeFile(file, expectedContent),
 					}
 				}
 			} else {
 				yield {
-					message:
-						`  -> Expected file "${file}" to exist and have content:\n---\n${expectedContent}\n---\n  -> But, the file does not exist`,
+					message: dedent`
+						-> Expected file "${file}" to exist and have content:
+						${'='.repeat(80)}
+						${expectedContent}
+						${'='.repeat(80)}
+						-> But, the file does not exist
+						`,
 					fix: () => fs.writeFile(file, expectedContent),
 				}
 			}
@@ -88,8 +101,7 @@ export async function* filesMustHaveShape(
 				.replaceAll(/\n-(?!\-)/g, '\n' + styleText('red', '-'))
 
 			yield {
-				message: '  ' +
-					dedent`
+				message: dedent`
 					-> Expected file "${file}" to have the correct shape:
 					${'='.repeat(80)}
 					${patch.replaceAll('\n', '\n' + '\t'.repeat(5))}${'='.repeat(80)}

config/lint-rules/400-ecosystem/nodejs/tsconfig.ts

@@ -59,8 +59,7 @@ export const issues: Issues = async function* issues({ project }) {
 				.replaceAll(/\n-(?!\-)/g, '\n' + styleText('red', '-'))
 
 			yield {
-				message: '  ' +
-					dedent`
+				message: dedent`
 					-> Expected file "${configFile}" to have the correct shape:
 					${'='.repeat(80)}
 					${patch.replaceAll('\n', '\n' + '\t'.repeat(5))}${'='.repeat(80)}