refactor: disallow severity configuration by default (#62)

Author: johnsoncodehk

README.md

@@ -61,7 +61,7 @@ To enable TSSLint in VSCode, follow these steps:
 
 ### Create a Rule
 
-To create a rule, you need to define a function that receives the context of the current diagnostic task. Within this function, you can call `reportError()` or `reportWarning()` to report an error.
+To create a rule, you need to define a function that receives the context of the current diagnostic task. Within this function, you can call `report()` to report an error.
 
 As an example, let's create a `no-console` rule under `[project root]/rules/`.
 
@@ -71,14 +71,14 @@ Here's the code for `[project root]/rules/noConsoleRule.ts`:
 import { defineRule } from '@tsslint/config';
 
 export function create() {
-	return defineRule(({ typescript: ts, sourceFile, reportWarning }) => {
+	return defineRule(({ typescript: ts, sourceFile, report }) => {
 		ts.forEachChild(sourceFile, function cb(node) {
 			if (
 				ts.isPropertyAccessExpression(node) &&
 				ts.isIdentifier(node.expression) &&
 				node.expression.text === 'console'
 			) {
-				reportWarning(
+				report(
 					`Calls to 'console.x' are not allowed.`,
 					node.parent.getStart(sourceFile),
 					node.parent.getEnd()
@@ -114,7 +114,7 @@ export default defineConfig({
 });
 ```
 
-After saving the config file, you will notice that `console.log` is now reporting errors in the editor. The error message will also display the specific line of code where the error occurred. Clicking on the error message will take you to line 11 in `noConsoleRule.ts`, where the `reportWarning()` code is located.
+After saving the config file, you will notice that `console.log` is now reporting errors in the editor. The error message will also display the specific line of code where the error occurred. Clicking on the error message will take you to line 11 in `noConsoleRule.ts`, where the `report()` code is located.
 
 > Full example: https://github.com/johnsoncodehk/tsslint/tree/master/fixtures/define-a-rule
 

fixtures/noConsoleRule.ts

@@ -1,14 +1,14 @@
 import { defineRule } from '@tsslint/config';
 
 export function create() {
-	return defineRule(({ typescript: ts, sourceFile, reportWarning }) => {
+	return defineRule(({ typescript: ts, sourceFile, report }) => {
 		ts.forEachChild(sourceFile, function cb(node) {
 			if (
 				ts.isPropertyAccessExpression(node) &&
 				ts.isIdentifier(node.expression) &&
 				node.expression.text === 'console'
 			) {
-				reportWarning(
+				report(
 					`Calls to 'console.x' are not allowed.`,
 					node.parent.getStart(sourceFile),
 					node.parent.getEnd()

packages/core/index.ts

@@ -77,19 +77,19 @@ export function createLinter(
 				? {
 					...ctx,
 					sourceFile: ctx.languageService.getProgram()!.getSourceFile(fileName)!,
-					report: reportMessage,
-					reportError,
-					reportWarning,
-					reportSuggestion,
+					report,
+					reportError: report,
+					reportWarning: report,
+					reportSuggestion: report,
 				}
 				: {
 					...ctx,
 					languageService: syntaxOnlyLanguageService,
 					sourceFile: getNonBoundSourceFile(fileName),
-					report: reportMessage,
-					reportError,
-					reportWarning,
-					reportSuggestion,
+					report,
+					reportError: report,
+					reportWarning: report,
+					reportSuggestion: report,
 				};
 			const token = ctx.languageServiceHost.getCancellationToken?.();
 			const configs = getConfigsForFile(fileName, cache?.[2]);
@@ -138,9 +138,9 @@ export function createLinter(
 						rule2Mode.set(currentRuleId, true);
 						shouldRetry = true;
 					} else if (err instanceof Error) {
-						report(ts.DiagnosticCategory.Error, err.stack ?? err.message, 0, 0, 0, err);
+						report(err.stack ?? err.message, 0, 0, 0, err);
 					} else {
-						report(ts.DiagnosticCategory.Error, String(err), 0, 0, false);
+						report(String(err), 0, 0, Number.MAX_VALUE);
 					}
 				}
 
@@ -192,25 +192,9 @@ export function createLinter(
 
 			return diagnostics;
 
-			function reportMessage(message: string, start: number, end: number, stackOffset?: false | number) {
-				return report(ts.DiagnosticCategory.Message, message, start, end, stackOffset);
-			}
-
-			function reportError(message: string, start: number, end: number, stackOffset?: false | number) {
-				return report(ts.DiagnosticCategory.Error, message, start, end, stackOffset);
-			}
-
-			function reportWarning(message: string, start: number, end: number, stackOffset?: false | number) {
-				return report(ts.DiagnosticCategory.Warning, message, start, end, stackOffset);
-			}
-
-			function reportSuggestion(message: string, start: number, end: number, stackOffset?: false | number) {
-				return report(ts.DiagnosticCategory.Suggestion, message, start, end, stackOffset);
-			}
-
-			function report(category: ts.DiagnosticCategory, message: string, start: number, end: number, stackOffset: false | number = 2, err?: Error): Reporter {
+			function report(message: string, start: number, end: number, stackOffset: number = 1, err?: Error): Reporter {
 				const error: ts.DiagnosticWithLocation = {
-					category,
+					category: ts.DiagnosticCategory.Message,
 					code: currentRuleId as any,
 					messageText: message,
 					file: rulesContext.sourceFile,
@@ -232,9 +216,7 @@ export function createLinter(
 					});
 				}
 
-				if (typeof stackOffset === 'number') {
-					handleError(error, err ?? new Error(), stackOffset);
-				}
+				handleError(error, err ?? new Error(), stackOffset);
 
 				let lintResult = lintResults.get(fileName);
 				if (!lintResult) {

packages/eslint/index.ts

@@ -42,31 +42,20 @@ export async function convertRules(
 ) {
 	const rules: TSSLint.Rules = {};
 	for (const [rule, severityOrOptions] of Object.entries(rulesConfig)) {
-		let rawSeverity: 'off' | 'error' | 'warn' | 'suggestion' | 'message' | 0 | 1 | 2 | 3;
+		let severity: boolean;
 		let options: any[];
 		if (Array.isArray(severityOrOptions)) {
-			[rawSeverity, ...options] = severityOrOptions;
+			[severity, ...options] = severityOrOptions;
 		}
 		else {
-			rawSeverity = severityOrOptions;
+			severity = severityOrOptions;
 			options = [];
 		}
-		let tsSeverity: ts.DiagnosticCategory | undefined;
-		if (rawSeverity === 'off' || rawSeverity === 0) {
-			tsSeverity = undefined;
+		// @ts-expect-error backward compatibility
+		if (severity === 'off' || severity === 0) {
+			severity = false;
 		}
-		else if (rawSeverity === 'warn' || rawSeverity === 1) {
-			tsSeverity = 0 satisfies ts.DiagnosticCategory.Warning;
-		}
-		else if (rawSeverity === 'error' || rawSeverity === 2) {
-			tsSeverity = 1 satisfies ts.DiagnosticCategory.Error;
-		}
-		else if (rawSeverity === 'suggestion') {
-			tsSeverity = 2 satisfies ts.DiagnosticCategory.Suggestion;
-		} else {
-			tsSeverity = 3 satisfies ts.DiagnosticCategory.Message;
-		}
-		if (tsSeverity === undefined) {
+		if (!severity) {
 			rules[rule] = noop;
 			continue;
 		}
@@ -77,7 +66,6 @@ export async function convertRules(
 		rules[rule] = convertRule(
 			ruleModule,
 			options,
-			tsSeverity,
 			{ id: rule, ...context }
 		);
 	}
@@ -133,11 +121,6 @@ async function getRule(pluginName: string | undefined, ruleName: string): Promis
 export function convertRule(
 	eslintRule: ESLint.Rule.RuleModule,
 	options: any[] = [],
-	severity: ts.DiagnosticCategory =
-		eslintRule.meta?.type === 'problem' ? 1 satisfies ts.DiagnosticCategory.Error
-			: eslintRule.meta?.type === 'suggestion' ? 0 satisfies ts.DiagnosticCategory.Warning
-				: eslintRule.meta?.type === 'layout' ? 2 satisfies ts.DiagnosticCategory.Suggestion
-					: 3 satisfies ts.DiagnosticCategory.Message,
 	context: Partial<ESLint.Rule.RuleContext> = {}
 ): TSSLint.Rule {
 	// ESLint internal scripts
@@ -154,11 +137,7 @@ export function convertRule(
 		Traverser = require(require.resolve('./node_modules/eslint/lib/shared/traverser.js'));
 	}
 
-	const tsslintRule: TSSLint.Rule = ({ typescript: ts, sourceFile, languageService, languageServiceHost, reportError, reportWarning, reportSuggestion }) => {
-		const report =
-			severity === ts.DiagnosticCategory.Error ? reportError
-				: severity === ts.DiagnosticCategory.Warning ? reportWarning
-					: reportSuggestion;
+	const tsslintRule: TSSLint.Rule = ({ sourceFile, languageService, languageServiceHost, report }) => {
 		const { sourceCode, eventQueue } = getEstree(
 			sourceFile,
 			languageService,
@@ -229,7 +208,7 @@ export function convertRule(
 						}
 					}
 				} catch { }
-				const reporter = report(message, start, end, 3);
+				const reporter = report(message, start, end, 2);
 				if (descriptor.fix) {
 					// @ts-expect-error
 					const textChanges = getTextChanges(descriptor.fix);

packages/eslint/lib/dtsGenerate.ts

@@ -17,8 +17,7 @@ export async function generate(
 	let dts = '';
 	let defId = 0;
 
-	line(`export type S = 'off' | 'error' | 'warn' | 'suggestion' | 'message' | 0 | 1 | 2 | 3;`);
-	line(`export type O<T extends any[]> = S | [S, ...options: T];`);
+	line(`export type O<T extends any[]> = boolean | [boolean, ...options: T];`);
 	line(``);
 	line(`export interface ESLintRulesConfig {`);
 	indentLevel++;

packages/eslint/lib/types.ts

@@ -1,5 +1,4 @@
-export type S = 'off' | 'error' | 'warn' | 'suggestion' | 'message' | 0 | 1 | 2 | 3;
-export type O<T extends any[]> = S | [S, ...options: T];
+export type O<T extends any[]> = boolean | [boolean, ...options: T];
 
 export interface ESLintRulesConfig {
 	[key: string]: O<any[]>;

packages/tslint/index.ts

@@ -1,30 +1,20 @@
 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[] = [],
-	severity: ts.DiagnosticCategory =
-		!Rule.metadata || Rule.metadata.type === 'functionality' || Rule.metadata.type === 'typescript' ? 1 satisfies ts.DiagnosticCategory.Error
-			: Rule.metadata.type === 'maintainability' || Rule.metadata.type === 'style' ? 0 satisfies ts.DiagnosticCategory.Warning
-				: Rule.metadata.type === 'formatting' ? 2 satisfies ts.DiagnosticCategory.Suggestion
-					: 3 satisfies ts.DiagnosticCategory.Message
 ): TSSLint.Rule {
 	const rule = new (Rule as TSLintRule)({
 		ruleName: Rule.metadata?.ruleName ?? 'unknown',
 		ruleArguments,
-		ruleSeverity: severity === 1 ? 'error' : severity === 2 ? 'warning' : 'off',
+		ruleSeverity: 'warning',
 		disabledIntervals: [],
 	}) as TSLint.IRule | TSLint.ITypedRule;
-	return ({ typescript: ts, sourceFile, languageService, reportError, reportWarning, reportSuggestion }) => {
+	return ({ sourceFile, languageService, report }) => {
 		let lastFailure: TSLint.RuleFailure | undefined;
-		const report =
-			severity === ts.DiagnosticCategory.Error ? reportError
-				: severity === ts.DiagnosticCategory.Warning ? reportWarning
-					: reportSuggestion;
 		const onAddFailure = (failure: TSLint.RuleFailure) => {
 			if (lastFailure === failure) {
 				return;
@@ -34,7 +24,7 @@ export function convertRule<T extends Partial<TSLintRule> | TSLintRule>(
 				failure.getFailure(),
 				failure.getStartPosition().getPosition(),
 				failure.getEndPosition().getPosition(),
-				false
+				Number.MAX_VALUE
 			);
 			if (failure.hasFix()) {
 				const fix = failure.getFix();

packages/types/index.ts

@@ -44,19 +44,19 @@ export interface RuleContext {
 	languageServiceHost: LanguageServiceHost;
 	languageService: LanguageService;
 	sourceFile: SourceFile;
-	report(message: string, start: number, end: number, stackOffset?: number | false): Reporter;
+	report(message: string, start: number, end: number, stackOffset?: number): Reporter;
 	/**
 	 * @deprecated Use `report` instead.
 	 */
-	reportError(message: string, start: number, end: number, stackOffset?: number | false): Reporter;
+	reportError(message: string, start: number, end: number, stackOffset?: number): Reporter;
 	/**
 	 * @deprecated Use `report` instead.
 	 */
-	reportWarning(message: string, start: number, end: number, stackOffset?: number | false): Reporter;
+	reportWarning(message: string, start: number, end: number, stackOffset?: number): Reporter;
 	/**
 	 * @deprecated Use `report` instead.
 	 */
-	reportSuggestion(message: string, start: number, end: number, stackOffset?: number | false): Reporter;
+	reportSuggestion(message: string, start: number, end: number, stackOffset?: number): Reporter;
 }
 
 export interface Reporter {