blob: 2157bebe4a9add3553024a8612960aace5a24eb5 [file] [log] [blame]
Yang Guo4fd355c2019-09-19 10:59:03 +02001/**
2 * @fileoverview Enforce a maximum number of classes per file
3 * @author James Garbutt <https://github.com/43081j>
4 */
5"use strict";
6
7//------------------------------------------------------------------------------
8// Requirements
9//------------------------------------------------------------------------------
10
11
12//------------------------------------------------------------------------------
13// Rule Definition
14//------------------------------------------------------------------------------
15
Tim van der Lippe0ceb4652022-01-06 14:23:36 +010016/** @type {import('../shared/types').Rule} */
Yang Guo4fd355c2019-09-19 10:59:03 +020017module.exports = {
18 meta: {
19 type: "suggestion",
20
21 docs: {
22 description: "enforce a maximum number of classes per file",
Yang Guo4fd355c2019-09-19 10:59:03 +020023 recommended: false,
24 url: "https://eslint.org/docs/rules/max-classes-per-file"
25 },
26
27 schema: [
28 {
Tim van der Lippe0fb47802021-11-08 16:23:10 +000029 oneOf: [
30 {
31 type: "integer",
32 minimum: 1
33 },
34 {
35 type: "object",
36 properties: {
37 ignoreExpressions: {
38 type: "boolean"
39 },
40 max: {
41 type: "integer",
42 minimum: 1
43 }
44 },
45 additionalProperties: false
46 }
47 ]
Yang Guo4fd355c2019-09-19 10:59:03 +020048 }
49 ],
50
51 messages: {
52 maximumExceeded: "File has too many classes ({{ classCount }}). Maximum allowed is {{ max }}."
53 }
54 },
55 create(context) {
Tim van der Lippe0fb47802021-11-08 16:23:10 +000056 const [option = {}] = context.options;
57 const [ignoreExpressions, max] = typeof option === "number"
58 ? [false, option || 1]
59 : [option.ignoreExpressions, option.max || 1];
Yang Guo4fd355c2019-09-19 10:59:03 +020060
61 let classCount = 0;
62
63 return {
64 Program() {
65 classCount = 0;
66 },
67 "Program:exit"(node) {
Tim van der Lippe0fb47802021-11-08 16:23:10 +000068 if (classCount > max) {
Yang Guo4fd355c2019-09-19 10:59:03 +020069 context.report({
70 node,
71 messageId: "maximumExceeded",
72 data: {
73 classCount,
Tim van der Lippe0fb47802021-11-08 16:23:10 +000074 max
Yang Guo4fd355c2019-09-19 10:59:03 +020075 }
76 });
77 }
78 },
Tim van der Lippe0fb47802021-11-08 16:23:10 +000079 "ClassDeclaration"() {
Yang Guo4fd355c2019-09-19 10:59:03 +020080 classCount++;
Tim van der Lippe0fb47802021-11-08 16:23:10 +000081 },
82 "ClassExpression"() {
83 if (!ignoreExpressions) {
84 classCount++;
85 }
Yang Guo4fd355c2019-09-19 10:59:03 +020086 }
87 };
88 }
89};