123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192 |
- "use strict";
- const astUtils = require("./utils/ast-utils");
- const { upperCaseFirst } = require("../shared/string-utils");
- const THRESHOLD_DEFAULT = 20;
- module.exports = {
- meta: {
- type: "suggestion",
- defaultOptions: [THRESHOLD_DEFAULT],
- docs: {
- description: "Enforce a maximum cyclomatic complexity allowed in a program",
- recommended: false,
- url: "https://eslint.org/docs/latest/rules/complexity"
- },
- schema: [
- {
- oneOf: [
- {
- type: "integer",
- minimum: 0
- },
- {
- type: "object",
- properties: {
- maximum: {
- type: "integer",
- minimum: 0
- },
- max: {
- type: "integer",
- minimum: 0
- },
- variant: {
- enum: ["classic", "modified"]
- }
- },
- additionalProperties: false
- }
- ]
- }
- ],
- messages: {
- complex: "{{name}} has a complexity of {{complexity}}. Maximum allowed is {{max}}."
- }
- },
- create(context) {
- const option = context.options[0];
- let threshold = THRESHOLD_DEFAULT;
- let VARIANT = "classic";
- if (typeof option === "object") {
- if (Object.hasOwn(option, "maximum") || Object.hasOwn(option, "max")) {
- threshold = option.maximum || option.max;
- }
- if (Object.hasOwn(option, "variant")) {
- VARIANT = option.variant;
- }
- } else if (typeof option === "number") {
- threshold = option;
- }
- const IS_MODIFIED_COMPLEXITY = VARIANT === "modified";
-
-
-
-
- const complexities = [];
-
- function increaseComplexity() {
- complexities[complexities.length - 1]++;
- }
-
-
-
- return {
- onCodePathStart() {
-
- complexities.push(1);
- },
-
- CatchClause: increaseComplexity,
- ConditionalExpression: increaseComplexity,
- LogicalExpression: increaseComplexity,
- ForStatement: increaseComplexity,
- ForInStatement: increaseComplexity,
- ForOfStatement: increaseComplexity,
- IfStatement: increaseComplexity,
- WhileStatement: increaseComplexity,
- DoWhileStatement: increaseComplexity,
- AssignmentPattern: increaseComplexity,
-
- "SwitchCase[test]": () => IS_MODIFIED_COMPLEXITY || increaseComplexity(),
- SwitchStatement: () => IS_MODIFIED_COMPLEXITY && increaseComplexity(),
-
- AssignmentExpression(node) {
- if (astUtils.isLogicalAssignmentOperator(node.operator)) {
- increaseComplexity();
- }
- },
- MemberExpression(node) {
- if (node.optional === true) {
- increaseComplexity();
- }
- },
- CallExpression(node) {
- if (node.optional === true) {
- increaseComplexity();
- }
- },
- onCodePathEnd(codePath, node) {
- const complexity = complexities.pop();
-
- if (
- codePath.origin !== "function" &&
- codePath.origin !== "class-field-initializer" &&
- codePath.origin !== "class-static-block"
- ) {
- return;
- }
- if (complexity > threshold) {
- let name;
- if (codePath.origin === "class-field-initializer") {
- name = "class field initializer";
- } else if (codePath.origin === "class-static-block") {
- name = "class static block";
- } else {
- name = astUtils.getFunctionNameWithKind(node);
- }
- context.report({
- node,
- messageId: "complex",
- data: {
- name: upperCaseFirst(name),
- complexity,
- max: threshold
- }
- });
- }
- }
- };
- }
- };
|