11797595674

Committed 12 Nov 2024 12:48PM UTC coverage: 80.664% (+0.6%) from 80.067%

Build # 11797595674

Build Type

Pull #327

github

Committed by

web-flow

Commit Message

Merge 92aa8e43a into dd2e5a9be

Pull Request Pull Request #327: feat: Add ui5lint-disable directives

Run Details

1816 of 2377 branches covered (76.4%)

Branch coverage included in aggregate %.

113 of 118 new or added lines in 8 files covered. (95.76%)

22 existing lines in 2 files now uncovered.

2631 of 3136 relevant lines covered (83.9%)

1748.82 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

1.0

/src/formatter/text.ts

import chalk from "chalk";
import path from "node:path";
import {LintResult, LintMessage} from "../linter/LinterContext.js";
import {LintMessageSeverity} from "../linter/messages.js";

const detailsHeader = chalk.white.bold("Details:");

function formatSeverity(severity: LintMessageSeverity) {
        if (severity === LintMessageSeverity.Error) {
                return chalk.red("error");
        } else if (severity === LintMessageSeverity.Warning) {
                return chalk.yellow("warning");
        } else {
                throw new Error(`Unknown severity: ${LintMessageSeverity[severity]}`);
        }
}

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

        return chalk.dim(`${lineStr}:${columnStr}`);
}

function formatMessageDetails(msg: LintMessage, showDetails: boolean) {
        if (!showDetails || !msg.messageDetails) {
                return "";
        }
        // Ensure that details are not containing line breaks as every message should be just a single line.
        // In addition, some integrations understand two whitespace chars (e.g. two spaces) as a separator
        // for a message code (e.g. $eslint-stylish problems matcher in VS Code).
        // Therefore, two or more whitespace chars are reduced to a single space.
        return `. ${detailsHeader} ${chalk.italic(msg.messageDetails.replace(/\s\s+|\n/g, " "))}`;
}

function formatRule(ruleId: string) {
        return chalk.dim(`  ${ruleId}`);
}

export class Text {
        #buffer = "";

        format(lintResults: LintResult[], showDetails: boolean) {
                this.#writeln(`UI5 linter report:`);
                this.#writeln("");
                let totalErrorCount = 0;
                let totalWarningCount = 0;
                let totalFatalErrorCount = 0;
                lintResults.forEach(({filePath, messages, errorCount, warningCount, fatalErrorCount}) => {
                        if (!errorCount && !warningCount) {
                                return;
                        }
                        totalErrorCount += errorCount;
                        totalWarningCount += warningCount;
                        totalFatalErrorCount += fatalErrorCount;

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

                        // Determine maximum line and column for position formatting
                        let maxLine = 0;
                        let maxColumn = 0;
                        messages.forEach((msg) => {
                                if (msg.line && msg.line > maxLine) {
                                        maxLine = msg.line;
                                }
                                if (msg.column && msg.column > maxColumn) {
                                        maxColumn = msg.column;
                                }
                        });

                        const lineInfoLength = maxLine.toString().length;
                        const columnInfoLength = maxColumn.toString().length;

                        // 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);

                                this.#writeln(
                                        `  ${formattedLocation} ` +
                                        `${formatSeverity(msg.severity)} ` +
                                        `${msg.fatal ? "Fatal error: " : ""}` +
                                        `${msg.message}` +
                                        `${formatMessageDetails(msg, showDetails)}` +
                                        `${formatRule(msg.ruleId)}`);
                        });

                        this.#writeln("");
                });

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

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

                if (!showDetails && (totalErrorCount + totalWarningCount + totalFatalErrorCount) > 0) {
                        this.#writeln("");
                        this.#writeln(chalk.dim.bold("Note: ") +
                                chalk.dim(`Use "ui5lint --details" to show more information about the findings`));
                }

                return this.#buffer;
        }

        // eslint-disable-next-line no-unused-private-class-members
        #write(str: string) {
                this.#buffer += str;
        }

        #writeln(str: string) {
                this.#buffer += str + "\n";
        }
}

1	import chalk from "chalk";
2	import path from "node:path";
3	import {LintResult, LintMessage} from "../linter/LinterContext.js";
4	import {LintMessageSeverity} from "../linter/messages.js";
5
6	const detailsHeader = chalk.white.bold("Details:");	3✔
7
8	function formatSeverity(severity: LintMessageSeverity) {
9	if (severity === LintMessageSeverity.Error) {	×
10	return chalk.red("error");	×
11	} else if (severity === LintMessageSeverity.Warning) {	×
12	return chalk.yellow("warning");	×
13	} else {
14	throw new Error(`Unknown severity: ${LintMessageSeverity[severity]}`);	×
15	}
16	}
17
18	function formatLocation(line: LintMessage["line"], column: LintMessage["column"],
19	lineInfoLength: number, columnInfoLength: number) {
20	const lineStr = (line === undefined ? "0" : line.toString()).padStart(lineInfoLength, " ");	×
21	const columnStr = (column === undefined ? "0" : column.toString()).padEnd(columnInfoLength, " ");	×
22
23	return chalk.dim(`${lineStr}:${columnStr}`);	×
24	}
25
26	function formatMessageDetails(msg: LintMessage, showDetails: boolean) {
27	if (!showDetails \|\| !msg.messageDetails) {	×
28	return "";	×
29	}
30	// Ensure that details are not containing line breaks as every message should be just a single line.
31	// In addition, some integrations understand two whitespace chars (e.g. two spaces) as a separator
32	// for a message code (e.g. $eslint-stylish problems matcher in VS Code).
33	// Therefore, two or more whitespace chars are reduced to a single space.
34	return `. ${detailsHeader} ${chalk.italic(msg.messageDetails.replace(/\s\s+\|\n/g, " "))}`;	×
35	}
36
37	function formatRule(ruleId: string) {
NEW 38	return chalk.dim(` ${ruleId}`);	×
39	}
40
41	export class Text {
42	#buffer = "";	×
43
44	format(lintResults: LintResult[], showDetails: boolean) {
45	this.#writeln(`UI5 linter report:`);	×
46	this.#writeln("");	×
47	let totalErrorCount = 0;	×
48	let totalWarningCount = 0;	×
49	let totalFatalErrorCount = 0;	×
50	lintResults.forEach(({filePath, messages, errorCount, warningCount, fatalErrorCount}) => {	×
51	if (!errorCount && !warningCount) {	×
52	return;	×
53	}
54	totalErrorCount += errorCount;	×
55	totalWarningCount += warningCount;	×
UNCOV 56	totalFatalErrorCount += fatalErrorCount;	×
57
58	this.#writeln(chalk.inverse(path.resolve(process.cwd(), filePath)));	×
59
60	// Determine maximum line and column for position formatting
61	let maxLine = 0;	×
UNCOV 62	let maxColumn = 0;	×
UNCOV 63	messages.forEach((msg) => {	×
64	if (msg.line && msg.line > maxLine) {	×
65	maxLine = msg.line;	×
66	}
67	if (msg.column && msg.column > maxColumn) {	×
68	maxColumn = msg.column;	×
69	}
70	});
71
UNCOV 72	const lineInfoLength = maxLine.toString().length;	×
UNCOV 73	const columnInfoLength = maxColumn.toString().length;	×
74
75	// Sort by line, then by column. Use 0 if not set.
76	messages.sort((a, b) => (a.line ?? 0) - (b.line ?? 0) \|\| (a.column ?? 0) - (b.column ?? 0));	×
77
UNCOV 78	messages.forEach((msg) => {	×
79	const formattedLocation =
UNCOV 80	formatLocation(msg.line, msg.column, lineInfoLength, columnInfoLength);	×
81
UNCOV 82	this.#writeln(	×
83	` ${formattedLocation} ` +
84	`${formatSeverity(msg.severity)} ` +
85	`${msg.fatal ? "Fatal error: " : ""}` +	×
86	`${msg.message}` +
87	`${formatMessageDetails(msg, showDetails)}` +
88	`${formatRule(msg.ruleId)}`);
89	});
90
91	this.#writeln("");	×
92	});
93
94	let summaryColor = chalk.green;	×
UNCOV 95	if (totalErrorCount > 0) {	×
UNCOV 96	summaryColor = chalk.red;	×
97	} else if (totalWarningCount > 0) {	×
98	summaryColor = chalk.yellow;	×
99	}
100
101	this.#writeln(	×
102	summaryColor(
103	`${totalErrorCount + totalWarningCount} problems ` +
104	`(${totalErrorCount} errors, ${totalWarningCount} warnings)`
105	)
106	);
UNCOV 107	if (totalFatalErrorCount) {	×
UNCOV 108	this.#writeln(summaryColor(`${totalFatalErrorCount} fatal errors`));	×
109	}
110
111	if (!showDetails && (totalErrorCount + totalWarningCount + totalFatalErrorCount) > 0) {	×
UNCOV 112	this.#writeln("");	×
UNCOV 113	this.#writeln(chalk.dim.bold("Note: ") +	×
114	chalk.dim(`Use "ui5lint --details" to show more information about the findings`));
115	}
116
UNCOV 117	return this.#buffer;	×
118	}
119
120	// eslint-disable-next-line no-unused-private-class-members
121	#write(str: string) {
UNCOV 122	this.#buffer += str;	×
123	}
124
125	#writeln(str: string) {
UNCOV 126	this.#buffer += str + "\n";	×
127	}
128	}

SAP / ui5-linter / 11797595674

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous