useMaxParams

JavaScript (and super languages)

摘要

¥Summary

规则生效日期：v2.2.0

¥Rule available since: v2.2.0
诊断类别：lint/nursery/useMaxParams

¥Diagnostic Category: lint/nursery/useMaxParams
此规则没有修复方案。

¥This rule doesn’t have a fix.
此规则的默认严重级别为 warning。

¥The default severity of this rule is warning.
来源：

¥Sources:
- 与 max-params 相同
  
  ¥Same as max-params
- 与 too_many_arguments 相同
  
  ¥Same as too_many_arguments
- 与 @typescript-eslint/max-params 相同
  
  ¥Same as @typescript-eslint/max-params

如何配置

¥How to configure

1
{
2
  "linter": {
3
    "rules": {
4
      "nursery": {
5
        "useMaxParams": "error"
6
      }
7
    }
8
  }
9
}

描述

¥Description

强制函数定义中参数的最大数量。

¥Enforce a maximum number of parameters in function definitions.

接受大量参数的函数可能难以阅读和编写，因为它需要记住每个参数是什么、它们的类型以及它们的出现顺序。

¥Functions that take numerous parameters can be difficult to read and write because it requires the memorization of what each parameter is, its type, and the order they should appear in.

示例

¥Examples

无效

¥Invalid

1
function foo(a, b, c, d, e, f, g, h) {
2
    // too many parameters
3
}

code-block.js:1:13 lint/nursery/useMaxParams ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ Function has 8 parameters, but only 4 are allowed.
  
  > 1 │ function foo(a, b, c, d, e, f, g, h) {
      │             ^^^^^^^^^^^^^^^^^^^^^^^^
    2 │     // too many parameters
    3 │ }
  
  ℹ Functions with many parameters are hard to read and maintain.
  
  ℹ Consider using an options object, splitting into smaller functions, or grouping related parameters.

1
const bar = (a, b, c, d, e, f, g, h) => {
2
    // too many parameters
3
}

code-block.js:1:13 lint/nursery/useMaxParams ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ Function has 8 parameters, but only 4 are allowed.
  
  > 1 │ const bar = (a, b, c, d, e, f, g, h) => {
      │             ^^^^^^^^^^^^^^^^^^^^^^^^
    2 │     // too many parameters
    3 │ }
  
  ℹ Functions with many parameters are hard to read and maintain.
  
  ℹ Consider using an options object, splitting into smaller functions, or grouping related parameters.

1
class Baz {
2
    method(a, b, c, d, e, f, g, h) {
3
        // too many parameters
4
    }
5
}

code-block.js:2:11 lint/nursery/useMaxParams ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ Function has 8 parameters, but only 4 are allowed.
  
    1 │ class Baz {
  > 2 │     method(a, b, c, d, e, f, g, h) {
      │           ^^^^^^^^^^^^^^^^^^^^^^^^
    3 │         // too many parameters
    4 │     }
  
  ℹ Functions with many parameters are hard to read and maintain.
  
  ℹ Consider using an options object, splitting into smaller functions, or grouping related parameters.

有效

¥Valid

1
function foo(a, b, c) {
2
    // within limit
3
}

1
const bar = (a, b, c) => {
2
    // within limit
3
}

1
class Baz {
2
    method(a, b, c) {
3
        // within limit
4
    }
5
}

选项

¥Options

max

允许的最大参数数量（默认值：4）。

¥The maximum number of parameters allowed (default: 4).

useMaxParams

摘要

如何配置

描述

示例

无效

有效

选项

max

相关链接