feat(eslint): add tsslint-eslint-update and improve defineRules JSDocs (#74)

Author: johnsoncodehk

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

@@ -0,0 +1,60 @@
+#!/usr/bin/env node
+
+const path = require('path');
+const fs = require('fs');
+const nodeModulesDirs = [];
+
+let dir = __dirname;
+
+while (true) {
+	const nodeModuleDir = path.join(dir, 'node_modules');
+	if (fs.existsSync(nodeModuleDir)) {
+		nodeModulesDirs.push(nodeModuleDir);
+	}
+	const parentDir = path.resolve(dir, '..');
+	if (parentDir === dir) {
+		break;
+	}
+	dir = parentDir;
+}
+
+try {
+	const { generate } = require('../lib/dtsGenerate.js');
+	generate(nodeModulesDirs).then(({ dts, stats }) => {
+		fs.writeFileSync(path.resolve(__dirname, '..', 'lib', 'types.d.ts'), dts);
+
+		const indexPath = path.resolve(__dirname, '..', 'index.d.ts');
+		if (fs.existsSync(indexPath)) {
+			let indexContent = fs.readFileSync(indexPath, 'utf8');
+			const defineRulesIndex = indexContent.indexOf('export declare function defineRules');
+			const jsDocEnd = indexContent.lastIndexOf('*/', defineRulesIndex) + 2;
+			const jsDocStart = indexContent.lastIndexOf('/**', jsDocEnd);
+
+			if (jsDocStart !== -1 && jsDocEnd !== -1 && jsDocStart < defineRulesIndex) {
+				const statsTable = [
+					'| Plugin | 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 an ESLint rules configuration to TSSLint rules.
+ *
+ * ${statsTable}
+ *
+ * ---
+ * If you have added new ESLint plugins, please run \`npx tsslint-eslint-update\` to update this list.
+ * 
+ * ---
+ */`;
+				indexContent = indexContent.slice(0, jsDocStart) + newJsDoc + indexContent.slice(jsDocEnd);
+				fs.writeFileSync(indexPath, indexContent);
+			}
+		}
+	});
+} catch (err) {
+	console.error(err);
+}

packages/eslint/index.ts

@@ -76,9 +76,24 @@ export async function convertRules(
 /**
  * Converts an ESLint rules configuration to TSSLint rules.
  *
- * The type definitions are generated when `@tsslint/eslint` is installed.
- * If the type definitions become outdated, please run
- * `node node_modules/@tsslint/eslint/scripts/generateDts.js` to update them.
+ * ---
+ * ⚠️ **Type definitions not generated**
+ *
+ * Please add `@tsslint/eslint` to `pnpm.onlyBuiltDependencies` in your `package.json` to allow the postinstall script to run.
+ *
+ * ```json
+ * {
+ *   "pnpm": {
+ *     "onlyBuiltDependencies": ["@tsslint/eslint"]
+ *   }
+ * }
+ * ```
+ *
+ * After that, run `pnpm install` again to generate type definitions.
+ *
+ * If the type definitions become outdated, please run `npx tsslint-eslint-update` to update them.
+ * 
+ * ---
  */
 export async function defineRules(
 	config: { [K in keyof ESLintRulesConfig]: boolean | ESLintRulesConfig[K] },

packages/eslint/lib/dtsGenerate.ts

@@ -22,6 +22,7 @@ export async function generate(
 
 	const visited = new Set<string>();
 	const defs = new Map<any, [string, string]>();
+	const stats: Record<string, number> = {};
 
 	for (const nodeModulesDir of nodeModulesDirs) {
 		const pkgs = readdirDirSync(nodeModulesDir);
@@ -37,12 +38,17 @@ export async function generate(
 							plugin = plugin.default;
 						}
 						if (plugin.rules) {
+							stats[pluginName] = 0;
 							for (const ruleName in plugin.rules) {
 								const rule = plugin.rules[ruleName];
 								if (subPkg === 'eslint-plugin') {
-									addRule(pkg, ruleName, rule);
+									if (addRule(pkg, ruleName, rule)) {
+										stats[pluginName]++;
+									}
 								} else {
-									addRule(pkg, `${subPkg.slice('eslint-plugin-'.length)}/${ruleName}`, rule);
+									if (addRule(pkg, `${subPkg.slice('eslint-plugin-'.length)}/${ruleName}`, rule)) {
+										stats[pluginName]++;
+									}
 								}
 							}
 						}
@@ -56,20 +62,26 @@ export async function generate(
 				}
 				if (plugin.rules) {
 					const scope = pkg.replace('eslint-plugin-', '');
+					stats[pkg] = 0;
 					for (const ruleName in plugin.rules) {
 						const rule = plugin.rules[ruleName];
-						addRule(scope, ruleName, rule);
+						if (addRule(scope, ruleName, rule)) {
+							stats[pkg]++;
+						}
 					}
 				}
 			}
 			else if (pkg === 'eslint') {
 				const rulesDir = path.join(nodeModulesDir, pkg, 'lib', 'rules');
 				const ruleFiles = fs.readdirSync(rulesDir);
+				stats['eslint'] = 0;
 				for (const ruleFile of ruleFiles) {
 					if (ruleFile.endsWith('.js')) {
 						const ruleName = ruleFile.replace('.js', '');
 						const rule = await loader(path.join(rulesDir, ruleFile));
-						addRule(undefined, ruleName, rule);
+						if (addRule(undefined, ruleName, rule)) {
+							stats['eslint']++;
+						}
 					}
 				}
 			}
@@ -84,7 +96,7 @@ export async function generate(
 		line(`type ${typeName} = ${typeString};`);
 	}
 
-	return dts;
+	return { dts, stats };
 
 	function addRule(scope: string | undefined, ruleName: string, rule: any) {
 		let ruleKey: string;
@@ -95,7 +107,7 @@ export async function generate(
 		}
 
 		if (visited.has(ruleKey)) {
-			return;
+			return false;
 		}
 		visited.add(ruleKey);
 
@@ -138,6 +150,7 @@ export async function generate(
 		} else {
 			line(`'${ruleKey}'?: any[],`);
 		}
+		return true;
 	}
 
 	function line(line: string) {

packages/eslint/package.json

@@ -4,15 +4,19 @@
 	"license": "MIT",
 	"files": [
 		"**/*.js",
-		"**/*.d.ts"
+		"**/*.d.ts",
+		"bin"
 	],
+	"bin": {
+		"tsslint-eslint-update": "bin/tsslint-eslint-update.js"
+	},
 	"repository": {
 		"type": "git",
 		"url": "https://github.com/johnsoncodehk/tsslint.git",
 		"directory": "packages/eslint"
 	},
 	"scripts": {
-		"postinstall": "node scripts/generateDts.js"
+		"postinstall": "node bin/tsslint-eslint-update.js"
 	},
 	"devDependencies": {
 		"@tsslint/types": "3.0.0-alpha.0",