feat(config): implement importTSLintRules (#78)

Author: johnsoncodehk

README.md

@@ -190,16 +190,37 @@ import { defineConfig, importESLintRules } from '@tsslint/config';
 export default defineConfig({
   rules: {
     ...await importESLintRules({
-      'no-unused-vars': 'error',
-      '@typescript-eslint/no-explicit-any': 'warn',
+      'no-unused-vars': true,
+      '@typescript-eslint/no-explicit-any': true,
     }),
   },
 });
 ```
 
+`importESLintRules` will automatically resolve and load rules from ESLint plugins (e.g., `@typescript-eslint/eslint-plugin`) by searching your `node_modules`. Plugin rules are identified by their prefix (e.g., `@typescript-eslint/`).
+
 #### TSLint
 Convert TSLint rules via `@tsslint/compat-tslint`.
 
+```bash
+npm install @tsslint/compat-tslint --save-dev
+```
+
+```ts
+import { defineConfig, importTSLintRules } from '@tsslint/config';
+
+export default defineConfig({
+  rules: {
+    ...await importTSLintRules({
+      'no-console': true,
+      'member-ordering': [true, { order: 'fields-first' }],
+    }),
+  },
+});
+```
+
+`importTSLintRules` will automatically read `rulesDirectory` from your `tslint.json` to support third-party TSLint plugins.
+
 #### TSL
 Convert TSL rules via `@tsslint/compat-tsl`.
 

fixtures/define-tslint-rules/tsslint.config.ts

@@ -1,8 +1,7 @@
-import { convertRule } from '@tsslint/compat-tslint';
-import { defineConfig } from '@tsslint/config';
+import { defineConfig, importTSLintRules } from '@tsslint/config';
 
 export default defineConfig({
-	rules: {
-		'strict-boolean-expressions': convertRule((await import('tslint/lib/rules/strictBooleanExpressionsRule.js')).Rule),
-	},
+	rules: await importTSLintRules({
+		'strict-boolean-expressions': true,
+	}),
 });

packages/compat-tslint/index.ts

@@ -16,7 +16,14 @@ export function convertRule(
 		ruleSeverity: 'warning',
 		disabledIntervals: [],
 	}) as IRule | ITypedRule;
-	return ({ file, report, ...ctx }) => {
+	return ({ typescript: ts, file, report, ...ctx }) => {
+		if (Rule.metadata?.typescriptOnly) {
+			const scriptKind = (file as any).scriptKind;
+			if (scriptKind === ts.ScriptKind.JS || scriptKind === ts.ScriptKind.JSX) {
+				return;
+			}
+		}
+
 		const failures = 'applyWithProgram' in rule
 			? rule.applyWithProgram(file, ctx.program)
 			: rule.apply(file);

packages/config/bin/tsslint-config-update.js

@@ -26,6 +26,8 @@ if (fs.existsSync(dtsGeneratePath)) {
 
 try {
 	const { generateESlintTypes } = require('../lib/eslint-gen');
+	const { generateTSLintTypes } = require('../lib/tslint-gen');
+
 	generateESlintTypes(nodeModulesDirs).then(({ dts, stats }) => {
 		fs.writeFileSync(path.resolve(__dirname, '..', 'lib', 'eslint-types.d.ts'), dts);
 
@@ -51,8 +53,39 @@ try {
  *
  * ${statsTable}
  *
- * ---
  * If you have added new ESLint plugins, please run \`npx tsslint-config-update\` to update this list.
+ */`;
+				indexContent = indexContent.slice(0, jsDocStart) + newJsDoc + indexContent.slice(jsDocEnd);
+				fs.writeFileSync(indexPath, indexContent);
+			}
+		}
+	});
+	generateTSLintTypes(nodeModulesDirs).then(({ dts, stats }) => {
+		fs.writeFileSync(path.resolve(__dirname, '..', 'lib', 'tslint-types.d.ts'), dts);
+
+		const indexPath = path.resolve(__dirname, '..', 'lib', 'tslint.d.ts');
+		if (fs.existsSync(indexPath)) {
+			let indexContent = fs.readFileSync(indexPath, 'utf8');
+			const fnIndex = indexContent.indexOf('export declare function importTSLintRules');
+			const jsDocEnd = indexContent.lastIndexOf('*/', fnIndex) + 2;
+			const jsDocStart = indexContent.lastIndexOf('/**', jsDocEnd);
+
+			if (jsDocStart !== -1 && jsDocEnd !== -1 && jsDocStart < fnIndex) {
+				const statsTable = [
+					'| Dir | Rules |',
+					'| :--- | :--- |',
+					...Object.entries(stats)
+						.filter(([_, count]) => count > 0)
+						.sort((a, b) => b[1] - a[1])
+						.map(([name, count]) => `| <span>${name}</span> | ${count} |`),
+				].join('\n * ');
+
+				const newJsDoc = `/**
+ * Converts a TSLint rules configuration to TSSLint rules.
+ *
+ * ${statsTable}
+ *
+ * If you have added new TSLint plugins, please run \`npx tsslint-config-update\` to update this list.
  */`;
 				indexContent = indexContent.slice(0, jsDocStart) + newJsDoc + indexContent.slice(jsDocEnd);
 				fs.writeFileSync(indexPath, indexContent);

packages/config/index.ts

@@ -3,6 +3,7 @@ export * from './lib/eslint.js';
 export { create as createCategoryPlugin } from './lib/plugins/category.js';
 export { create as createDiagnosticsPlugin } from './lib/plugins/diagnostics.js';
 export { create as createIgnorePlugin } from './lib/plugins/ignore.js';
+export * from './lib/tslint.js';
 
 import type { Config, Plugin, Rule } from '@tsslint/types';
 

packages/config/lib/eslint.ts

@@ -30,10 +30,11 @@ const loader = async (moduleName: string) => {
 	return mod as any;
 };
 
+type Severity = boolean | 'error' | 'warn';
+
 /**
  * Converts an ESLint rules configuration to TSSLint rules.
  *
- * ---
  * ⚠️ **Type definitions not generated**
  *
  * Please add `@tsslint/config` to `pnpm.onlyBuiltDependencies` in your `package.json` to allow the postinstall script to run.
@@ -51,9 +52,8 @@ const loader = async (moduleName: string) => {
  * If the type definitions become outdated, please run `npx tsslint-config-update` to update them.
  */
 export async function importESLintRules(
-	config: { [K in keyof ESLintRulesConfig]: boolean | ESLintRulesConfig[K] },
+	config: { [K in keyof ESLintRulesConfig]: Severity | [Severity, ESLintRulesConfig[K]] },
 	context: Partial<ESLint.Rule.RuleContext> = {},
-	category: ts.DiagnosticCategory = 3 satisfies ts.DiagnosticCategory.Message,
 ) {
 	let convertRule: typeof import('@tsslint/compat-eslint').convertRule;
 	try {
@@ -65,11 +65,10 @@ export async function importESLintRules(
 
 	const rules: TSSLint.Rules = {};
 	for (const [rule, severityOrOptions] of Object.entries(config)) {
-		let severity: boolean;
+		let severity: Severity;
 		let options: any[];
 		if (Array.isArray(severityOrOptions)) {
-			severity = true;
-			options = severityOrOptions;
+			[severity, ...options] = severityOrOptions;
 		}
 		else {
 			severity = severityOrOptions;
@@ -87,7 +86,11 @@ export async function importESLintRules(
 			ruleModule,
 			options,
 			{ id: rule, ...context },
-			category,
+			severity === 'error'
+				? 1 satisfies ts.DiagnosticCategory.Error
+				: severity === 'warn'
+				? 0 satisfies ts.DiagnosticCategory.Warning
+				: 3 satisfies ts.DiagnosticCategory.Message,
 		);
 	}
 	return rules;