refactor: combine err: Error, stackOffset: number to reportAt: [Error, number]

Author: johnsoncodehk

packages/core/index.ts

@@ -26,7 +26,7 @@ export function createLinter(
 	ctx: LinterContext,
 	rootDir: string,
 	config: Config | Config[],
-	handleError: (diag: ts.DiagnosticWithLocation, err: Error, stackOffset: number) => void,
+	handleError: (diag: ts.DiagnosticWithLocation, reportAt: [Error, number]) => void,
 	syntaxOnlyLanguageService?: ts.LanguageService & {
 		getNonBoundSourceFile?(fileName: string): ts.SourceFile;
 	}
@@ -140,9 +140,9 @@ export function createLinter(
 						rule2Mode.set(currentRuleId, true);
 						shouldRetry = true;
 					} else if (err instanceof Error) {
-						report(err.stack ?? err.message, 0, 0, ts.DiagnosticCategory.Message, 0, err);
+						report(err.stack ?? err.message, 0, 0, ts.DiagnosticCategory.Message, [err, 0]);
 					} else {
-						report(String(err), 0, 0, ts.DiagnosticCategory.Message, Number.MAX_VALUE);
+						report(String(err), 0, 0, ts.DiagnosticCategory.Message, [new Error(), Number.MAX_VALUE]);
 					}
 				}
 
@@ -202,7 +202,7 @@ export function createLinter(
 
 			return diagnostics;
 
-			function report(message: string, start: number, end: number, category: ts.DiagnosticCategory = ts.DiagnosticCategory.Message, stackOffset: number = 1, err?: Error): Reporter {
+			function report(message: string, start: number, end: number, category: ts.DiagnosticCategory = ts.DiagnosticCategory.Message, reportAt: [Error, number] = [new Error(), 1]): Reporter {
 				const error: ts.DiagnosticWithLocation = {
 					category,
 					code: currentRuleId as any,
@@ -226,7 +226,7 @@ export function createLinter(
 					});
 				}
 
-				handleError(error, err ?? new Error(), stackOffset);
+				handleError(error, reportAt);
 
 				let lintResult = lintResults.get(fileName);
 				if (!lintResult) {

packages/eslint/index.ts

@@ -253,7 +253,7 @@ export function convertRule(
 						}
 					}
 				} catch { }
-				const reporter = report(message, start, end, category, 2);
+				const reporter = report(message, start, end, category, [new Error(), 1]);
 				if (descriptor.fix) {
 					// @ts-expect-error
 					const textChanges = getTextChanges(descriptor.fix);

packages/tslint/index.ts

@@ -28,7 +28,7 @@ export function convertRule<T extends Partial<TSLintRule> | TSLintRule>(
 				failure.getStartPosition().getPosition(),
 				failure.getEndPosition().getPosition(),
 				category,
-				Number.MAX_VALUE
+				[new Error(), Number.MAX_VALUE]
 			);
 			if (failure.hasFix()) {
 				const fix = failure.getFix();

packages/types/index.ts

@@ -47,7 +47,7 @@ export interface RuleContext {
 	languageService: LanguageService;
 	program: Program;
 	file: SourceFile;
-	report(message: string, start: number, end: number, category?: DiagnosticCategory, stackOffset?: number): Reporter;
+	report(message: string, start: number, end: number, category?: DiagnosticCategory, reportAt?: [Error, number]): Reporter;
 }
 
 export interface Reporter {

packages/typescript-plugin/index.ts

@@ -152,8 +152,12 @@ function decorateLanguageService(
 
 			try {
 				config = (await import(configFile)).default;
-				linter = core.createLinter(projectContext, path.dirname(configFile), config!, (diag, err, stackOffset) => {
-					const relatedInfo = createRelatedInformation(ts, err, stackOffset);
+				linter = core.createLinter(projectContext, path.dirname(configFile), config!, (diag, reportAt) => {
+					const stacks = ErrorStackParser.parse(reportAt[0]);
+					if (stacks.length <= reportAt[1]) {
+						return;
+					}
+					const relatedInfo = createRelatedInformation(ts, stacks[reportAt[1]]);
 					if (relatedInfo) {
 						diag.relatedInformation!.push(relatedInfo);
 					}
@@ -163,7 +167,7 @@ function decorateLanguageService(
 				linter = undefined;
 				const prevLength = configFileDiagnostics.length;
 				if (err instanceof Error) {
-					const relatedInfo = createRelatedInformation(ts, err, 0);
+					const relatedInfo = createRelatedInformation(ts, ErrorStackParser.parse(err)[0]);
 					if (relatedInfo) {
 						configFileDiagnostics.push({
 							category: ts.DiagnosticCategory.Message,
@@ -185,12 +189,7 @@ function decorateLanguageService(
 	}
 }
 
-function createRelatedInformation(ts: typeof import('typescript'), err: Error, stackOffset: number): ts.DiagnosticRelatedInformation | undefined {
-	const stacks = ErrorStackParser.parse(err);
-	if (stacks.length <= stackOffset) {
-		return;
-	}
-	const stack = stacks[stackOffset];
+function createRelatedInformation(ts: typeof import('typescript'), stack: ErrorStackParser.StackFrame): ts.DiagnosticRelatedInformation | undefined {
 	if (stack.fileName && stack.lineNumber !== undefined && stack.columnNumber !== undefined) {
 		let fileName = stack.fileName.replace(/\\/g, '/');
 		if (fileName.startsWith('file://')) {