create-rule.mjs

#!/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 {execa} from 'execa';

const dirname = path.dirname(fileURLToPath(import.meta.url));
const ROOT = path.join(dirname, '..');

function checkFiles(ruleId) {
	const files = [
		`docs/rules/${ruleId}.md`,
		`rules/${ruleId}.js`,
		`test/${ruleId}.mjs`,
		`test/snapshots/${ruleId}.mjs.md`,
		`test/snapshots/${ruleId}.mjs.snap`,
	];

	for (const file of files) {
		if (fs.existsSync(path.join(ROOT, file))) {
			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');

	const compiled = template(templateContent);
	const content = compiled(data);
	return fs.writeFileSync(targetFile, content);
}

async function getData() {
	const questions = [
		{
			type: 'input',
			name: 'id',
			message: 'Rule name:',
			validate(value) {
				if (!value) {
					return 'Rule name is required.';
				}

				if (!/^[a-z-]+$/.test(value)) {
					return 'Invalid rule name.';
				}

				return true;
			},
		},
		{
			type: 'input',
			name: 'description',
			message: 'Rule description:',
			validate(value) {
				if (!value) {
					return 'Rule description is required.';
				}

				return true;
			},
		},
		{
			type: 'select',
			name: 'fixableType',
			message: 'Is it fixable?',
			choices: ['Code', 'Whitespace', 'No'],
			result: value => value === 'No' ? false : value.toLowerCase(),
		},
		{
			type: 'select',
			name: 'type',
			message: 'Type:',
			choices: [
				'problem',
				'suggestion',
				'layout',
			],
		},
		{
			type: 'select',
			name: 'hasSuggestions',
			message: 'Does it provides suggestions?',
			choices: ['Yes', 'No'],
			result: value => value === 'Yes',
		},
	];

	const data = await enquirer.prompt(questions);

	return data;
}

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.mjs.jst',
	target: `test/${id}.mjs`,
	data,
});

try {
	await execa('code', [
		'--new-window',
		'.',
		`docs/rules/${id}.md`,
		`rules/${id}.js`,
		`test/${id}.mjs`,
	], {cwd: ROOT});
} catch {}