lib/rules/noForbiddenElements.ts - master - githubmirror/eslint-plugin

lib/rules/noForbiddenElements.ts
111 строк4 KB
saberzero1
refactor: streamline meta.docs.url for static analysis
10 июн 2026, 16:14
10 июн 2026, 16:1413385bc
import { TSESTree } from "@typescript-eslint/utils";
import { docsUrl, ruleCreator } from "../ruleCreator.js";

// We want to catch patterns like:
//
// const styleSheet = document.createElement('link');
// styleSheet.rel = 'stylesheet';
// styleSheet.href = this.app.vault.adapter.getResourcePath(`${this.manifest.dir}/styles.css`);
// document.head.appendChild(styleSheet);
//
// or
//
// const style = document.createElement('style');
// style.textContent = `Some CSS here`;
// document.head.appendChild(style);

/**
 * Mapping from element tag name to expected type.
 */
const FORBIDDEN_ELEMENT_TYPES = ["link", "style"];

function isForbiddenCreateElementCall(node: TSESTree.CallExpression): string | undefined {
    // we are looking for document.createElement(...)
    if (!(
        node.callee.type === TSESTree.AST_NODE_TYPES.MemberExpression &&
        node.callee.property.type === TSESTree.AST_NODE_TYPES.Identifier &&
        node.callee.property.name === "createElement" &&
        node.callee.object.type === TSESTree.AST_NODE_TYPES.Identifier &&
        node.callee.object.name === "document"
    )) {
        return undefined;
    }

    if (node.arguments.length === 0) {
        return undefined;
    }
    return isArgumentForbiddenElement(node.arguments[0]);
}

function isForbiddenCreateElCall(node: TSESTree.CallExpression): string | undefined {
    // we are looking for foo.createEl(...)

    if (!(
        node.callee.type === TSESTree.AST_NODE_TYPES.MemberExpression &&
        node.callee.property.type === TSESTree.AST_NODE_TYPES.Identifier &&
        node.callee.property.name === "createEl" &&
        (node.callee.object.type === TSESTree.AST_NODE_TYPES.Identifier || node.callee.object.type === TSESTree.AST_NODE_TYPES.MemberExpression)
    )) {
        return undefined;
    }

    if (node.arguments.length === 0) {
        return undefined;
    }
    return isArgumentForbiddenElement(node.arguments[0]);
}

function isArgumentForbiddenElement(arg: TSESTree.CallExpressionArgument): string | undefined {
    if (arg.type === TSESTree.AST_NODE_TYPES.Literal && typeof arg.value === "string") {
        const tagName = arg.value.toLowerCase();
        for (const forbiddenTagName of FORBIDDEN_ELEMENT_TYPES) {
            if (tagName === forbiddenTagName) {
                return tagName;
            }
        }
    }

    return undefined;
}


export default ruleCreator({
    meta: {
        type: "problem" as const,
        docs: {
            description:
                "Disallow attachment of forbidden elements to the DOM in Obsidian plugins.",
            url: docsUrl("no-forbidden-elements"),
        },
        schema: [],
        messages: {
            doNotAttachForbiddenElements: "Creating and attaching \"{{element}}\" elements is not allowed.",
            doNotAttachForbiddenStyleElements: "Creating and attaching \"{{element}}\" elements is not allowed. For loading CSS, use a \"styles.css\" file instead, which Obsidian loads for you.",
        },
    },
    defaultOptions: [],
    create(context) {
        return {
            CallExpression(node: TSESTree.CallExpression) {
                const element = isForbiddenCreateElementCall(node) ?? isForbiddenCreateElCall(node);
                if (element === "style" || element === "link") {
                    context.report({
                        node,
                        messageId: "doNotAttachForbiddenStyleElements",
                        data: {
                            element,
                        }
                    });
                } else if (element) {
                    context.report({
                        node,
                        messageId: "doNotAttachForbiddenElements",
                        data: {
                            element,
                        }
                    });
                }
            },
        };
    },
});