eslint-plugin-obsidianmd/dist/lib/rules/vault/iterate.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/vault/${name}.md`);
export default ruleCreator({
    name: "vault-iterate",
    meta: {
        docs: {
            description: "Avoid iterating all files to find a file by its path\n",
            url: "https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines#Avoid+iterating+all+files+to+find+a+file+by+its+path",
        },
        type: "problem",
        messages: {
            iterate: "Avoid iterating all files to find a file by its path\n",
        },
        schema: [],
        fixable: "code",
    },
    defaultOptions: [],
    create: (context) => {
        return {
            MemberExpression(node) {
                if (node.property.type === "Identifier" &&
                    node.property.name === "find" &&
                    node.object.type === "CallExpression" &&
                    node.object.callee.type === "MemberExpression" &&
                    node.object.callee.property.type === "Identifier" &&
                    node.object.callee.property.name === "getFiles" &&
                    node.object.callee.object.type === "Identifier" &&
                    node.object.callee.object.name === "vault") {
                    if (node.parent &&
                        node.parent.type === "CallExpression" &&
                        node.parent.arguments &&
                        node.parent.arguments.length > 0) {
                        let findArgument = node.parent.arguments[0];
                        if (findArgument.type === "ArrowFunctionExpression" &&
                            findArgument.body.type === "BinaryExpression" &&
                            (findArgument.body.operator === "===" ||
                                findArgument.body.operator === "==") &&
                            findArgument.body.left.type ===
                                "MemberExpression" &&
                            findArgument.body.left.object.type ===
                                "Identifier" && //
                            findArgument.body.left.object.parent.type ===
                                "MemberExpression" &&
                            findArgument.body.left.object.parent.property
                                .type === "Identifier" &&
                            findArgument.body.left.object.parent.property
                                .name === "path") {
                            context.report({
                                node,
                                messageId: "iterate",
                            });
                        }
                    }
                }
            },
        };
    },
});