Change default complexity (#337)

biomejs · Sep 19, 2023 · d7a799e · d7a799e
1 parent 9bc8a92
commit d7a799e
Show file tree

Hide file tree

Showing 8 changed files with 30 additions and 20 deletions.
diff --git a/crates/biome_js_analyze/src/analyzers/nursery/no_excessive_complexity.rs b/crates/biome_js_analyze/src/analyzers/nursery/no_excessive_complexity.rs
@@ -24,7 +24,7 @@ const MAX_FUNCTION_DEPTH: usize = 10;
 const MAX_SCORE: u8 = u8::MAX;
 
 declare_rule! {
-    /// Disallow functions that exceed a given complexity score.
+    /// Disallow functions that exceed a given Cognitive Complexity score.
     ///
     /// The more complexity a function contains, the harder it is to understand
     /// later on.
@@ -34,7 +34,10 @@ declare_rule! {
     /// side-effects when making changes.
     ///
     /// This rule calculates a complexity score for every function and disallows
-    /// those that exceed a configured complexity threshold (default: 10).
+    /// those that exceed a configured complexity threshold (default: 15).
+    ///
+    /// The complexity score is calculated based on the Cognitive Complexity
+    /// algorithm: http://redirect.sonarsource.com/doc/cognitive-complexity.html
     ///
     /// Source:
     ///
@@ -48,9 +51,11 @@ declare_rule! {
     /// function tooComplex() {
     ///     for (let x = 0; x < 10; x++) {
     ///         for (let y = 0; y < 10; y++) {
-    ///             if (x % 2 === 0) {
-    ///                 if (y % 2 === 0) {
-    ///                     console.log(x > y ? `${x} > ${y}` : `${y} > ${x}`);
+    ///             for (let z = 0; z < 10; z++) {
+    ///                 if (x % 2 === 0) {
+    ///                     if (y % 2 === 0) {
+    ///                         console.log(x > y ? `${x} > ${y}` : `${y} > ${x}`);
+    ///                     }
     ///                 }
     ///             }
     ///         }
@@ -71,7 +76,7 @@ declare_rule! {
     /// }
     /// ```
     ///
-    /// The allowed values range from 1 through 254. The default is 10.
+    /// The allowed values range from 1 through 254. The default is 15.
     ///
     pub(crate) NoExcessiveComplexity {
         version: "1.0.0",
@@ -379,7 +384,7 @@ pub struct ComplexityOptions {
 impl Default for ComplexityOptions {
     fn default() -> Self {
         Self {
-            max_allowed_complexity: 10,
+            max_allowed_complexity: 15,
         }
     }
 }

diff --git a/...es/biome_js_analyze/tests/specs/nursery/noExcessiveComplexity/complexEventHandler.ts.snap b/...es/biome_js_analyze/tests/specs/nursery/noExcessiveComplexity/complexEventHandler.ts.snap
@@ -113,7 +113,7 @@ complexEventHandler.ts:1:10 lint/nursery/noExcessiveComplexity ━━━━━
     2 │     const state = getState();
     3 │     const focusedCell = selectFocusedCellOrSurrogate(state);
 
-  i Please refactor this function to reduce its complexity score from 26 to the max allowed complexity 10.
+  i Please refactor this function to reduce its complexity score from 26 to the max allowed complexity 15.
 
 
 ```

diff --git a/crates/biome_service/src/configuration/linter/rules.rs b/crates/biome_service/src/configuration/linter/rules.rs
diff --git a/editors/vscode/configuration_schema.json b/editors/vscode/configuration_schema.json
diff --git a/packages/@biomejs/backend-jsonrpc/src/workspace.ts b/packages/@biomejs/backend-jsonrpc/src/workspace.ts
diff --git a/packages/@biomejs/biome/configuration_schema.json b/packages/@biomejs/biome/configuration_schema.json
diff --git a/website/src/content/docs/linter/rules/index.mdx b/website/src/content/docs/linter/rules/index.mdx
@@ -345,7 +345,7 @@ Disallow <code>void</code> type outside of generic or return types.
 ### [noDuplicateJsonKeys](/linter/rules/no-duplicate-json-keys)
 Disallow two keys with the same name inside a JSON object.
 ### [noExcessiveComplexity](/linter/rules/no-excessive-complexity)
-Disallow functions that exceed a given complexity score.
+Disallow functions that exceed a given Cognitive Complexity score.
 ### [noFallthroughSwitchClause](/linter/rules/no-fallthrough-switch-clause)
 Disallow fallthrough of <code>switch</code> clauses.
 ### [noGlobalIsFinite](/linter/rules/no-global-is-finite)

diff --git a/website/src/content/docs/linter/rules/no-excessive-complexity.md b/website/src/content/docs/linter/rules/no-excessive-complexity.md
@@ -7,7 +7,7 @@ title: noExcessiveComplexity (since v1.0.0)
 This rule is part of the [nursery](/linter/rules/#nursery) group.
 :::
 
-Disallow functions that exceed a given complexity score.
+Disallow functions that exceed a given Cognitive Complexity score.
 
 The more complexity a function contains, the harder it is to understand
 later on.
@@ -17,7 +17,10 @@ it easier to understand as well as by reducing chances of accidental
 side-effects when making changes.
 
 This rule calculates a complexity score for every function and disallows
-those that exceed a configured complexity threshold (default: 10).
+those that exceed a configured complexity threshold (default: 15).
+
+The complexity score is calculated based on the Cognitive Complexity
+algorithm: http://redirect.sonarsource.com/doc/cognitive-complexity.html
 
 Source:
 
@@ -31,9 +34,11 @@ Source:
 function tooComplex() {
     for (let x = 0; x < 10; x++) {
         for (let y = 0; y < 10; y++) {
-            if (x % 2 === 0) {
-                if (y % 2 === 0) {
-                    console.log(x > y ? `${x} > ${y}` : `${y} > ${x}`);
+            for (let z = 0; z < 10; z++) {
+                if (x % 2 === 0) {
+                    if (y % 2 === 0) {
+                        console.log(x > y ? `${x} > ${y}` : `${y} > ${x}`);
+                    }
                 }
             }
         }
@@ -50,7 +55,7 @@ function tooComplex() {
     <strong>2 │ </strong>    for (let x = 0; x &lt; 10; x++) {
     <strong>3 │ </strong>        for (let y = 0; y &lt; 10; y++) {
 
-<strong><span style="color: rgb(38, 148, 255);">  </span></strong><strong><span style="color: rgb(38, 148, 255);">ℹ</span></strong> <span style="color: rgb(38, 148, 255);">Please refactor this function to reduce its complexity score from 15 to the max allowed complexity 10.</span>
+<strong><span style="color: rgb(38, 148, 255);">  </span></strong><strong><span style="color: rgb(38, 148, 255);">ℹ</span></strong> <span style="color: rgb(38, 148, 255);">Please refactor this function to reduce its complexity score from 21 to the max allowed complexity 15.</span>
 
 </code></pre>
 
@@ -67,7 +72,7 @@ Allows to specify the maximum allowed complexity.
 }
 ```
 
-The allowed values range from 1 through 254. The default is 10.
+The allowed values range from 1 through 254. The default is 15.
 
 ## Related links