eslint-plugin-obsidianmd/dist/lib/rules/hardcodedConfigPath.js

Validates guidelines for Obsidian plugins

import { 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",
        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) {
                if (typeof node.value === "string" &&
                    node.value.match(/\.obsidian(?![a-zA-Z_-])/)) {
                    context.report({
                        node,
                        messageId: "configPath",
                    });
                }
            },
        };
    },
});