@kougen/eslint-plugin-clean-code/dist/rules/no-variable-with-number-at-end.js

Custom eslint rules for clean code.

import { ESLintUtils } from '@typescript-eslint/utils';
import path from 'path';
/**
 * URL encode the rule name
 * @param name - The rule name
 * @returns The URL encoded rule name
 */
const encode = (name) => encodeURIComponent(name);
const createRule = ESLintUtils.RuleCreator(name => `https://github.com/eslint-plugin-clean-code/wiki/${encode(name)}`);
export default createRule({
    name: "no-variable-with-number-at-end",
    meta: {
        type: "problem",
        fixable: "code",
        docs: {
            description: "Disallow variable names ending with numbers",
        },
        messages: {
            noNumberEnding: "Variable '{{name}}' should not end with a number.",
        },
        schema: [
            {
                type: "object",
                properties: {
                    extensions: {
                        type: "array",
                        items: { type: "string" },
                        default: [".ts", ".js"],
                    },
                    allow: {
                        type: "array",
                        items: { type: "string" },
                        default: ["v4"],
                    },
                    allowRegex: {
                        type: "array",
                        items: { type: "string" },
                        default: ["S3$"],
                    }
                },
                additionalProperties: false
            },
        ],
    },
    defaultOptions: [{ extensions: [".ts", ".js"], allow: ["v4"], allowRegex: ["S3$"] }],
    create(context, [{ extensions, allow, allowRegex }]) {
        const filename = context.filename;
        const ext = path.extname(filename);
        if (!extensions.includes(ext)) {
            return {};
        }
        return {
            Identifier(node) {
                const variableName = node.name.toLowerCase();
                if (allow.includes(variableName)) {
                    return;
                }
                const allowRegexes = allowRegex.map(allowRegex => new RegExp(allowRegex, "i"));
                if (allowRegexes.some(allowRegex => allowRegex.test(variableName))) {
                    return;
                }
                if (/\d$/.test(variableName)) {
                    context.report({
                        node,
                        messageId: "noNumberEnding",
                        data: {
                            name: variableName,
                        },
                    });
                }
            },
        };
    },
});
//# sourceMappingURL=no-variable-with-number-at-end.js.map