Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Enable links in VS Code terminal #6

Merged
merged 6 commits into from
Mar 13, 2024
Merged

feat: Enable links in VS Code terminal #6

Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c14c5d0
feat: Enable VS Code links
d3xter666 Mar 8, 2024
7955deb
fix: Include messageDetails in VS Code links
d3xter666 Mar 8, 2024
bc3237b
fix: Remove grouping, line breaks, use relative path
matz3 Mar 11, 2024
200a307
fix: Log issues with absolute path
d3xter666 Mar 13, 2024
3c67b93
fix: Resolve merge conflicts
d3xter666 Mar 13, 2024
e2a5821
docs: Update ui5lint example output
matz3 Mar 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 35 additions & 36 deletions src/formatter/text.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import chalk from "chalk";
import path from "node:path";
import {LintMessageSeverity, LintResult, LintMessage} from "../detectors/AbstractDetector.js";

function formatSeverity(severity: LintMessageSeverity) {
Expand All @@ -13,8 +14,8 @@ function formatSeverity(severity: LintMessageSeverity) {

function formatLocation(line: LintMessage["line"], column: LintMessage["column"],
lineInfoLength: number, columnInfoLength: number) {
const lineStr = (line === undefined ? "?" : line.toString()).padStart(lineInfoLength, " ");
const columnStr = (column === undefined ? "?" : column.toString()).padEnd(columnInfoLength, " ");
const lineStr = (line === undefined ? "0" : line.toString()).padStart(lineInfoLength, " ");
const columnStr = (column === undefined ? "0" : column.toString()).padEnd(columnInfoLength, " ");

return chalk.dim(`${lineStr}:${columnStr}`);
}
Expand All @@ -41,7 +42,7 @@ export class Text {
totalWarningCount += warningCount;
totalFatalErrorCount += fatalErrorCount;

this.#writeln(chalk.inverse(filePath));
this.#writeln(chalk.inverse(path.resolve(process.cwd(), filePath)));

// Group messages by rule
const rules = new Map<string, LintMessage[]>();
Expand All @@ -65,45 +66,43 @@ export class Text {
const lineInfoLength = maxLine.toString().length;
const columnInfoLength = maxColumn.toString().length;

let addNewLineAfterModule = true;
// Sort rules alphabetically
Array.from(rules.keys()).sort((a, b) => {
return a.localeCompare(b);
}).forEach((ruleId) => {
const messages = rules.get(ruleId);
if (messages) {
this.#writeln(chalk.bold(` ${ruleId} (${messages.length})`));
messages.forEach((msg) => {
const messageDetails = (showDetails && msg.messageDetails) ?
(`\n ${chalk.white.bold("Details:")}\n ` +
`${chalk.italic(msg.messageDetails.replaceAll("\n", "\n "))}`) :
"";

this.#writeln(
` ${formatLocation(msg.line, msg.column, lineInfoLength, columnInfoLength)} ` +
`${formatSeverity(msg.severity)} ` +
`${msg.message}` +
`${messageDetails}`);

addNewLineAfterModule = true;
if (messageDetails) {
this.#writeln("");
addNewLineAfterModule = false;
}
});
}
// Sort by line, then by column. Use 0 if not set.
messages.sort((a, b) => (a.line ?? 0) - (b.line ?? 0) || (a.column ?? 0) - (b.column ?? 0));

messages.forEach((msg) => {
const formattedLocation =
formatLocation(msg.line, msg.column, lineInfoLength, columnInfoLength);

const messageDetails = (showDetails && msg.messageDetails) ?
(`\n ${formattedLocation} ${chalk.white.bold("Details:")} ` +
`${chalk.italic(msg.messageDetails.replaceAll("\n", " "))}`) :
"";

this.#writeln(
` ${formattedLocation} ` +
`${formatSeverity(msg.severity)} ` +
`${msg.message}` +
`${messageDetails}`);
});

if (addNewLineAfterModule) {
this.#writeln("");
}
this.#writeln("");
});

let summaryColor = chalk.green;
if (totalErrorCount > 0) {
summaryColor = chalk.red;
} else if (totalWarningCount > 0) {
summaryColor = chalk.yellow;
}

this.#writeln(
`${totalErrorCount + totalWarningCount} problems ` +
`(${totalErrorCount} errors, ${totalWarningCount} warnings)`);
summaryColor(
`${totalErrorCount + totalWarningCount} problems ` +
`(${totalErrorCount} errors, ${totalWarningCount} warnings)`
)
);
if (totalFatalErrorCount) {
this.#writeln(`${totalFatalErrorCount} fatal errors`);
this.#writeln(summaryColor(`${totalFatalErrorCount} fatal errors`));
}

if (!showDetails && (totalErrorCount + totalWarningCount + totalFatalErrorCount) > 0) {
Expand Down