githubmirror/eslint-plugin

lib/rules/sampleNames.ts
61 строка1 KB
saberzero1
manifest.json
03 июл 2025, 14:04
03 июл 2025, 14:041053f94
import { TSESTree, ESLintUtils } from "@typescript-eslint/utils";

const ruleCreator = ESLintUtils.RuleCreator(
	(name) =>
		`https://github.com/obsidianmd/eslint-plugin/blob/master/docs/rules/${name}.md`,
);

const sampleNames = [
	"MyPlugin",
	"MyPluginSettings",
	"SampleSettingTab",
	"SampleModal",
	"mySetting",
];

export default ruleCreator({
	name: "sample-names",
	meta: {
		docs: {
			description: "Rename sample plugin class names",
			url: "https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines#Rename+placeholder+class+names",
		},
		type: "problem" as const,
		messages: {
			rename: "Rename the sample classes.",
		},
		schema: [],
	},
	defaultOptions: [],
	create(context) {
		return {
			TSInterfaceDeclaration(node: TSESTree.TSInterfaceDeclaration) {
				if (sampleNames.includes(node.id.name)) {
					context.report({
						node: node.id,
						messageId: "rename",
					});
				}
			},
			ClassDeclaration(node: TSESTree.ClassDeclaration) {
				if (node.id && sampleNames.includes(node.id.name)) {
					context.report({
						node: node.id,
						messageId: "rename",
					});
				}
			},
			PropertySignature(node: TSESTree.TSPropertySignature) {
				if (
					node.key.type === "Identifier" &&
					sampleNames.includes(node.key.name)
				) {
					context.report({
						node: node.key,
						messageId: "rename",
					});
				}
			},
		};
	},
});