[feat] support show eslint documentation in vscode quick fix

[tjx666]

like:

[johnsoncodehk]

This is how it is implemented via the plugin API in v1.2:

import { defineConfig } from '@tsslint/config';

export default defineConfig({
	// ...
	plugins: [createShowDocsPlugin()],
});

import { definePlugin, Rules } from '@tsslint/config';
import { exec } from 'child_process';

function createShowDocsPlugin() {
	return definePlugin(({ languageService }) => {
		const cmd = 'tsslint:open-eslint-rule-docs';
		const ruleId2Meta = new Map<string, { docs?: { url: string; }; }>();
		const { applyCodeActionCommand } = languageService;

		languageService.applyCodeActionCommand = async (command, ...rest: any) => {
			if (typeof command === 'object' && command?.command === cmd) {
				const start = process.platform == 'darwin' ? 'open' : process.platform == 'win32' ? 'start' : 'xdg-open';
				exec(`${start} ${command.url}`);
				return {};
			}
			return await applyCodeActionCommand(command, ...rest) as any;
		};

		return {
			resolveRules(fileName, rules) {
				collectMetadata(rules);
				return rules;
			},
			resolveCodeFixes(fileName, diagnostic, codeFixes) {
				const ruleMeta = ruleId2Meta.get(diagnostic.code as any);
				if (!ruleMeta?.docs?.url) {
					return codeFixes;
				}
				return [
					...codeFixes,
					{
						changes: [],
						description: `Show documentation for ${diagnostic.code}`,
						fixName: 'Show documentation',
						commands: [{
							command: cmd,
							file: fileName,
							url: ruleMeta.docs.url,
						}],
					},
				];
			},
		};

		function collectMetadata(rules: Rules, paths: string[] = []) {
			for (const [path, rule] of Object.entries(rules)) {
				if (typeof rule === 'object') {
					collectMetadata(rule, [...paths, path]);
					continue;
				}
				const meta = (rule as any).meta;
				if (typeof meta === 'object' && meta) {
					const ruleId = [...paths, path].join('/');
					ruleId2Meta.set(ruleId, meta);
				}
			}
		};
	});
}

[johnsoncodehk]

This can now be enabled using the createShowDocsActionPlugin API, see #12 (comment).