githubmirror/eslint-plugin

lib/rules/hardcodedConfigPath.ts

38 строк930 B

Johannes Theiner

Update rule messages to be more verbose, readd fixer for settings headings

03 ноя 2025, 22:08

03 ноя 2025, 22:08eeb70a8

import { TSESTree, ESLintUtils } from "@typescript-eslint/utils";

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

export default ruleCreator({
	name: "hardcoded-config-path",
	meta: {
		docs: {
			description: "test",
			url: "https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines#Commands",
		},
		type: "problem" as const,
		messages: {
			configPath:
				"Obsidian's configuration folder is not necessarily `.obsidian`, it can be configured by the user. Use `Vault#configDir` to get the current value",
		},
		schema: [],
	},
	defaultOptions: [],
	create: (context) => {
		return {
			Literal(node: TSESTree.Literal) {
				if (
					typeof node.value === "string" &&
					node.value.match(/\.obsidian(?![a-zA-Z_-])/)
				) {
					context.report({
						node,
						messageId: "configPath",
					});
				}
			},
		};
	},
});