feat: add rule types (#735)

Author: olivermrose

.changeset/late-mirrors-drop.md

@@ -0,0 +1,5 @@
+---
+"eslint-plugin-svelte": minor
+---
+
+feat: add rule types

.eslintignore

@@ -29,6 +29,7 @@
 /docs-svelte-kit/src/routes/*.md
 /docs-svelte-kit/src/routes/**/*.md
 /docs-svelte-kit/src/app.html
+/src/rule-types.ts
 
 # JSONSchema bug?
 /.devcontainer/devcontainer.json

package.json

@@ -141,6 +141,7 @@
     "eslint-plugin-svelte": "^2.35.1",
     "eslint-plugin-yml": "^1.14.0",
     "eslint-scope": "^8.0.1",
+    "eslint-typegen": "^0.2.1",
     "eslint-visitor-keys": "^4.0.0",
     "espree": "^10.0.1",
     "estree-walker": "^3.0.3",

src/index.ts

@@ -1,3 +1,4 @@
+import './rule-types';
 import type { RuleModule } from './types';
 import { rules as ruleList } from './utils/rules';
 import base from './configs/base';

src/rule-types.ts

@@ -0,0 +1,21 @@
+import fs from 'fs';
+import path from 'path';
+import plugin from '../src/index';
+
+void main();
+
+async function main() {
+	const { pluginsToRulesDTS } = await import('eslint-typegen/core');
+
+	// @ts-expect-error - types are a bit strict here
+	const ruleTypes = await pluginsToRulesDTS({ svelte: plugin });
+
+	void fs.writeFileSync(
+		path.join(__dirname, '../src/rule-types.ts'),
+		`// IMPORTANT!
+// This file has been automatically generated,
+// in order to update its content execute "pnpm run update"
+
+${ruleTypes}`
+	);
+}

tools/update-rule-types.ts

@@ -5,3 +5,4 @@ import './update-readme';
 import './update-docs-rules-index';
 import './update-types-for-node';
 import './update-meta';
+import './update-rule-types';

tools/update.ts

@@ -6,8 +6,5 @@
 		"typings/**/*",
 		"vite.config.mts",
 		"docs-svelte-kit/**/*.mts"
-	],
-	"compilerOptions": {
-		"removeComments": true /* Do not emit comments to output. */
-	}
+	]
 }