@mindfiredigital/eslint-plugin-hub/lib/rules/general/plugin/vars-descriptive.js

eslint-plugin-hub is a powerful, flexible ESLint plugin that provides a curated set of rules to enhance code readability, maintainability, and prevent common errors. Whether you're working with vanilla JavaScript, TypeScript, React, or Angular, eslint-plu

const { isVerb } = require('../../../utils/check-verb');

module.exports = {
  rules: {
    'vars-descriptive': {
      meta: {
        type: 'suggestion',
        docs: {
          description:
            'Enforce variable names to start with a verb and be descriptive',
        },
        schema: [], // No options needed
        messages: {
          notDescriptive:
            "Variable name '{{name}}' should start with a verb and be descriptive.",
        },
      },
      create(context) {
        return {
          VariableDeclarator(node) {
            const variableName = node.id && node.id.name;

            // Ensure variableName is a string before proceeding
            if (typeof variableName !== 'string') {
              return;
            }

            // Check if the first word in the camelCase variable is a verb
            const firstWord = variableName.split(/(?=[A-Z])/)[0];
            if (!isVerb(firstWord)) {
              context.report({
                node: node.id,
                messageId: 'notDescriptive',
                data: { name: variableName },
              });
            }
          },
        };
      },
    },
  },
};