smh-eslint-rules/lib/functions/no-commented-jsx.js

EsLint Plugin to standard rules for javascript, typescript without limitation of the frameworks ( react, angular, node etc )

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const noCommentedJsx = {
    meta: {
        type: "problem",
        docs: {
            description: "Disallow commented-out JSX elements, with optional ignore pattern.",
        },
        schema: [
            {
                type: "object",
                properties: {
                    ignorePattern: {
                        type: "string",
                    },
                },
                additionalProperties: false,
            },
        ],
        messages: {
            commentedJsx: "Avoid commenting out JSX elements. Remove or handle them properly.",
        },
    },
    // Add defaultOptions
    defaultOptions: [{}], // Default options (empty object in this case)
    create(context) {
        // Access the options with proper typing
        const options = context.options[0] || {};
        const ignorePattern = options.ignorePattern ? new RegExp(options.ignorePattern) : null;
        return {
            JSXEmptyExpression(node) {
                const sourceCode = context.sourceCode;
                const comments = sourceCode.getCommentsInside(node);
                comments.forEach((comment) => {
                    const commentText = comment.value.trim();
                    // Check if the comment matches the ignore pattern
                    if (ignorePattern && ignorePattern.test(commentText)) {
                        return; // Skip reporting if the comment matches the pattern
                    }
                    // Match potential JSX tags inside the comment
                    const hasJsxTag = /<\w+[\s\S]*?>[\s\S]*?<\/\w+>|<\w+[\s\S]*?\/>/.test(commentText);
                    if (hasJsxTag) {
                        context.report({
                            node,
                            messageId: "commentedJsx",
                        });
                    }
                });
            },
        };
    },
};
exports.default = noCommentedJsx;