twenty/tools/eslint-rules/rules/max-consts-per-file.ts

import { ESLintUtils, TSESTree } from '@typescript-eslint/utils';

// NOTE: The rule will be available in ESLint configs as "@nx/workspace-max-consts-per-file"
export const RULE_NAME = 'max-consts-per-file';

export const rule = ESLintUtils.RuleCreator(() => __filename)({
  name: RULE_NAME,
  meta: {
    type: 'problem',
    docs: {
      description:
        'Ensure there are at most a specified number of const declarations constant file',
      recommended: 'recommended',
    },
    fixable: 'code',
    schema: [
      {
        type: 'object',
        properties: {
          max: {
            type: 'integer',
            minimum: 0,
          },
        },
        additionalProperties: false,
      },
    ],
    messages: {
      tooManyConstants:
        'Only a maximum of ({{ max }}) const declarations are allowed in this file.',
    },
  },
  defaultOptions: [],
  create: (context) => {
    const [{ max }] = context.options;

    let constCount = 0;

    return {
      VariableDeclaration: (node: TSESTree.VariableDeclaration) => {
        constCount++;

        if (constCount > max) {
          context.report({
            node,
            messageId: 'tooManyConstants',
            data: {
              max,
            },
          });
        }
      },
    };
  },
});