feat(core, eslint, tslint): expose category param

Author: johnsoncodehk

packages/core/index.ts

@@ -151,9 +151,9 @@ export function createLinter(
 						rule2Mode.set(currentRuleId, true);
 						shouldRetry = true;
 					} else if (err instanceof Error) {
-						report(err.stack ?? err.message, 0, 0, 0, err);
+						report(err.stack ?? err.message, 0, 0, ts.DiagnosticCategory.Message, 0, err);
 					} else {
-						report(String(err), 0, 0, Number.MAX_VALUE);
+						report(String(err), 0, 0, ts.DiagnosticCategory.Message, Number.MAX_VALUE);
 					}
 				}
 
@@ -213,9 +213,9 @@ export function createLinter(
 
 			return diagnostics;
 
-			function report(message: string, start: number, end: number, stackOffset: number = 1, err?: Error): Reporter {
+			function report(message: string, start: number, end: number, category: ts.DiagnosticCategory = ts.DiagnosticCategory.Message, stackOffset: number = 1, err?: Error): Reporter {
 				const error: ts.DiagnosticWithLocation = {
-					category: ts.DiagnosticCategory.Message,
+					category,
 					code: currentRuleId as any,
 					messageText: message,
 					file: rulesContext.file,

packages/eslint/index.ts

@@ -29,7 +29,7 @@ const loader = async (moduleName: string) => {
 	return mod as any;
 };
 
-type S = 'error' | 'warn' | 'suggestion' | 'off' | 0 | 1 | 2;
+type S = 'off' | 'error' | 'warn' | 'suggestion' | 'message' | 0 | 1 | 2 | 3 | 4;
 type O<T extends any[]> = S | [S, ...options: T];
 
 /**
@@ -41,22 +41,16 @@ export async function convertRules(
 ) {
 	const rules: TSSLint.Rules = {};
 	for (const [rule, severityOrOptions] of Object.entries(rulesConfig)) {
-		let severity: boolean;
+		let severity: S;
 		let options: any[];
 		if (Array.isArray(severityOrOptions)) {
-			// @ts-expect-error
 			[severity, ...options] = severityOrOptions;
 		}
 		else {
-			// @ts-expect-error
 			severity = severityOrOptions;
 			options = [];
 		}
-		// @ts-expect-error backward compatibility
 		if (severity === 'off' || severity === 0) {
-			severity = false;
-		}
-		if (!severity) {
 			rules[rule] = noop;
 			continue;
 		}
@@ -67,6 +61,13 @@ export async function convertRules(
 		rules[rule] = convertRule(
 			ruleModule,
 			options,
+			severity === 'warn' || severity === 1
+				? 0
+				: severity === 'error' || severity === 2
+					? 1
+					: severity === 'suggestion' || severity === 3
+						? 2
+						: 3,
 			{ id: rule, ...context }
 		);
 	}
@@ -82,6 +83,7 @@ export async function convertRules(
  */
 export async function defineRules(
 	rulesConfig: { [K in keyof ESLintRulesConfig]: boolean | ESLintRulesConfig[K] },
+	category: ts.DiagnosticCategory = 3 satisfies ts.DiagnosticCategory.Message,
 	context: Partial<ESLint.Rule.RuleContext> = {}
 ) {
 	const rules: TSSLint.Rules = {};
@@ -107,6 +109,7 @@ export async function defineRules(
 		rules[rule] = convertRule(
 			ruleModule,
 			options,
+			category,
 			{ id: rule, ...context }
 		);
 	}
@@ -162,6 +165,7 @@ async function loadRule(pluginName: string | undefined, ruleName: string): Promi
 export function convertRule(
 	eslintRule: ESLint.Rule.RuleModule,
 	options: any[] = [],
+	category: ts.DiagnosticCategory = 3 satisfies ts.DiagnosticCategory.Message,
 	context: Partial<ESLint.Rule.RuleContext> = {}
 ): TSSLint.Rule {
 	// ESLint internal scripts
@@ -249,7 +253,7 @@ export function convertRule(
 						}
 					}
 				} catch { }
-				const reporter = report(message, start, end, 2);
+				const reporter = report(message, start, end, category, 2);
 				if (descriptor.fix) {
 					// @ts-expect-error
 					const textChanges = getTextChanges(descriptor.fix);

packages/tslint/index.ts

@@ -1,11 +1,13 @@
 import type * as TSSLint from '@tsslint/types';
 import type * as TSLint from 'tslint';
+import type * as ts from 'typescript';
 
 type TSLintRule = import('tslint/lib/language/rule/rule').RuleConstructor;
 
 export function convertRule<T extends Partial<TSLintRule> | TSLintRule>(
 	Rule: T,
 	ruleArguments: any[] = [],
+	category: ts.DiagnosticCategory = 3 satisfies ts.DiagnosticCategory.Message,
 ): TSSLint.Rule {
 	const rule = new (Rule as TSLintRule)({
 		ruleName: Rule.metadata?.ruleName ?? 'unknown',
@@ -25,6 +27,7 @@ export function convertRule<T extends Partial<TSLintRule> | TSLintRule>(
 				failure.getFailure(),
 				failure.getStartPosition().getPosition(),
 				failure.getEndPosition().getPosition(),
+				category,
 				Number.MAX_VALUE
 			);
 			if (failure.hasFix()) {

packages/types/index.ts

@@ -1,6 +1,7 @@
 import type {
 	CodeFixAction,
 	Diagnostic,
+	DiagnosticCategory,
 	DiagnosticWithLocation,
 	FileTextChanges,
 	LanguageService,
@@ -46,7 +47,7 @@ export interface RuleContext {
 	languageService: LanguageService;
 	program: Program;
 	file: SourceFile;
-	report(message: string, start: number, end: number, stackOffset?: number): Reporter;
+	report(message: string, start: number, end: number, category?: DiagnosticCategory, stackOffset?: number): Reporter;
 
 	/**
 	 * @deprecated Use `file` instead.