Refactor create-rule script (#2832)

Author: fisker

eslint.config.js

@@ -63,6 +63,8 @@ const config = [
 			'func-names': 'off',
 			'@stylistic/function-paren-newline': 'off',
 			'@stylistic/curly-newline': 'off',
+			// https://github.com/sindresorhus/eslint-plugin-unicorn/issues/2833
+			'unicorn/template-indent': ['error', {indent: '\t'}],
 		},
 	},
 	{

eslint.dogfooding.config.js

@@ -37,6 +37,8 @@ const config = [
 			'unicorn/consistent-function-scoping': 'off',
 			// Annoying
 			'unicorn/no-keyword-prefix': 'off',
+			// https://github.com/sindresorhus/eslint-plugin-unicorn/issues/2833
+			'unicorn/template-indent': ['error', {indent: '\t'}],
 		},
 	},
 	{

package.json

@@ -96,13 +96,12 @@
 		"eslint-remote-tester-repositories": "^2.0.2",
 		"espree": "^10.4.0",
 		"listr2": "^9.0.5",
-		"lodash-es": "^4.17.21",
 		"markdownlint-cli": "^0.45.0",
 		"nano-spawn": "^2.0.0",
 		"node-style-text": "^2.1.2",
 		"npm-package-json-lint": "^9.0.0",
 		"npm-run-all2": "^8.0.4",
-		"open-editor": "^5.1.0",
+		"open-editor": "^6.0.0",
 		"outdent": "^0.8.0",
 		"pretty-ms": "^9.3.0",
 		"typescript": "^5.9.3",

scripts/create-rule.js

@@ -1,14 +1,12 @@
 #!/usr/bin/env node
 import fs from 'node:fs';
-import path from 'node:path';
-import {fileURLToPath} from 'node:url';
 import enquirer from 'enquirer';
-import {template} from 'lodash-es';
 import openEditor from 'open-editor';
 import spawn from 'nano-spawn';
+import styleText from 'node-style-text';
 
-const dirname = path.dirname(fileURLToPath(import.meta.url));
-const ROOT = path.join(dirname, '..');
+const PROJECT_ROOT = new URL('../', import.meta.url);
+const TEMPLATE_DIRECTORY = new URL('template/', import.meta.url);
 
 function checkFiles(ruleId) {
 	const files = [
@@ -20,20 +18,29 @@ function checkFiles(ruleId) {
 	];
 
 	for (const file of files) {
-		if (fs.existsSync(path.join(ROOT, file))) {
+		if (fs.existsSync(new URL(file, PROJECT_ROOT))) {
 			throw new Error(`“${file}” already exists.`);
 		}
 	}
 }
 
-function renderTemplate({source, target, data}) {
-	const templateFile = path.join(dirname, `template/${source}`);
-	const targetFile = path.join(ROOT, target);
-	const templateContent = fs.readFileSync(templateFile, 'utf8');
+async function renderTemplate({source, target}, data) {
+	const sourceUrl = new URL(source, TEMPLATE_DIRECTORY);
+	const targetUrl = new URL(target, PROJECT_ROOT);
 
-	const compiled = template(templateContent);
-	const content = compiled(data);
-	return fs.writeFileSync(targetFile, content);
+	if (source.endsWith('.template.txt')) {
+		await fs.promises.copyFile(sourceUrl, targetUrl);
+	} else if (source.endsWith('.template.js')) {
+		const {default: render} = await import(new URL(source, TEMPLATE_DIRECTORY));
+		const content = render(data);
+		await fs.promises.writeFile(targetUrl, content);
+	} else {
+		throw new Error(`Unknown template file '${source}'.`);
+	}
+
+	console.log(`File ${styleText.underline.blue(target)} created.`);
+
+	return target;
 }
 
 async function getData() {
@@ -101,36 +108,41 @@ const data = await getData();
 const {id} = data;
 
 checkFiles(id);
-renderTemplate({
-	source: 'documentation.md.jst',
-	target: `docs/rules/${id}.md`,
-	data,
-});
-renderTemplate({
-	source: 'rule.js.jst',
-	target: `rules/${id}.js`,
-	data,
-});
-renderTemplate({
-	source: 'test.js.jst',
-	target: `test/${id}.js`,
-	data,
+
+const files = await Promise.all(
+	[
+		{
+			source: 'documentation.md.template.txt',
+			target: `docs/rules/${id}.md`,
+		},
+		{
+			source: 'rule.js.template.js',
+			target: `rules/${id}.js`,
+		},
+		{
+			source: 'test.js.template.txt',
+			target: `test/${id}.js`,
+		},
+	].map(template => renderTemplate(template, data)),
+);
+
+const shouldOpenFiles = await enquirer.prompt({
+	type: 'confirm',
+	message: 'Open files in editor?',
+	initial: true,
 });
 
-const filesToOpen = [
-	`docs/rules/${id}.md`,
-	`rules/${id}.js`,
-	`test/${id}.js`,
-];
-try {
-	await openEditor(filesToOpen);
-} catch {
-	// https://github.com/sindresorhus/open-editor/issues/15
+if (shouldOpenFiles) {
 	try {
-		await spawn('code', [
-			'--new-window',
-			'.',
-			...filesToOpen,
-		], {cwd: ROOT});
-	} catch {}
+		await openEditor(files.map(file => new URL(file, PROJECT_ROOT)));
+	} catch {
+		// https://github.com/sindresorhus/open-editor/issues/15
+		try {
+			await spawn('code', [
+				'--new-window',
+				'.',
+				...files,
+			], {cwd: PROJECT_ROOT});
+		} catch {}
+	}
 }

scripts/template/documentation.md.jst renamed to scripts/template/documentation.md.template.txt

@@ -0,0 +1,105 @@
+import {outdent} from 'outdent';
+import indentString from 'indent-string';
+
+const indent = (string, count) => indentString(string, count, {indent: '\t'});
+
+const imports = outdent`
+	import {} from './ast/index.js';
+	import {} from './fix/index.js';
+	import {} from './utils/index.js';
+`;
+
+const typeImports = outdent`
+	/**
+	@import {TSESTree as ESTree} from '@typescript-eslint/types';
+	@import * as ESLint from 'eslint';
+	*/
+`;
+
+const createMessages = data =>
+	data.hasSuggestions
+		? outdent`
+			const MESSAGE_ID_ERROR = '${data.id}/error';
+			const MESSAGE_ID_SUGGESTION = '${data.id}/suggestion';
+			const messages = {
+				[MESSAGE_ID_ERROR]: 'Prefer \`{{replacement}}\` over \`{{value}}\`.',
+				[MESSAGE_ID_SUGGESTION]: 'Replace \`{{value}}\` with \`{{replacement}}\`.',
+			};
+		`
+		: outdent`
+			const MESSAGE_ID = '${data.id}';
+			const messages = {
+				[MESSAGE_ID]: 'Prefer \`{{replacement}}\` over \`{{value}}\`.',
+			};
+		`;
+
+const fix = outdent`
+	/** @param {ESLint.Rule.RuleFixer} fixer */
+	fix: fixer => fixer.replaceText(node, '\\'🦄\\''),
+`;
+
+const suggestion = outdent`
+	suggest: [
+		{
+			messageId: MESSAGE_ID_SUGGESTION,
+			data: {
+				value: 'unicorn',
+				replacement: '🦄',
+			},
+	${indent(fix, 2)}
+		},
+	],
+`;
+
+const createRuleCreateFunction = data => outdent`
+	/** @param {ESLint.Rule.RuleContext} context */
+	const create = context => {
+		context.on('Literal', node => {
+			if (node.value !== 'unicorn') {
+				return;
+			}
+
+			return {
+				node,
+				messageId: ${data.hasSuggestions ? 'MESSAGE_ID_ERROR' : 'MESSAGE_ID'},
+				data: {
+					value: 'unicorn',
+					replacement: '🦄',
+				},
+	${data.fixableType ? indent(fix, 3) : ''}
+	${data.hasSuggestions ? indent(suggestion, 3) : ''}
+			};
+		});
+	};
+`;
+
+const createConfig = data => outdent`
+	/** @type {ESLint.Rule.RuleModule} */
+	const config = {
+		create,
+		meta: {
+			type: '${data.type}',
+			docs: {
+				description: '${data.description}',
+				recommended: 'unopinionated',
+			},
+			${data.fixableType ? `fixable: '${data.fixableType}',` : ''}
+			${data.hasSuggestions ? 'hasSuggestions: true,' : ''}
+			messages,
+		},
+	};
+`;
+
+function renderRuleTemplate(data) {
+	return [
+		imports,
+		typeImports,
+		createMessages,
+		createRuleCreateFunction,
+		createConfig,
+		'export default config;',
+	].map(part => typeof part === 'function' ? part(data) : part).join('\n\n')
+	+ '\n';
+}
+
+export default renderRuleTemplate;