useConsistentGraphqlDescriptions

GraphQL

摘要

¥Summary

规则生效日期：v2.3.6

¥Rule available since: v2.3.6
诊断类别：lint/nursery/useConsistentGraphqlDescriptions

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

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

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

¥Sources:
- 与 @graphql-eslint/description-style 相同
  
  ¥Same as @graphql-eslint/description-style

如何配置

¥How to configure

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

描述

¥Description

要求所有描述遵循相同的样式（块级或行内），以保持一致性并提高整个模式的可读性。

¥Require all descriptions to follow the same style (either block or inline) to maintain consistency and improve readability across the schema.

示例

¥Examples

样式：`block`

¥style: block

无效

¥Invalid

1
enum EnumValue {
2
  "this is a description"
3
  DEFAULT
4
}

code-block.graphql:2:3 lint/nursery/useConsistentGraphqlDescriptions ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Unexpected inline description style.
  
    1 │ enum EnumValue {
  > 2 │   “this is a description”
      │   ^^^^^^^^^^^^^^^^^^^^^^^
    3 │   DEFAULT
    4 │ }
  
  ℹ To stay consistent within the project, write the description block style.

有效

¥Valid

1
enum EnumValue {
2
  """
3
  this is a description
4
  """
5
  DEFAULT
6
}

选项

¥Options

`style`

此选项将指定描述样式。

¥This option will specify the description style.

"block"：要求代码块描述使用三引号 ("""...""")。

¥"block": Requires triple-quoted block descriptions ("""...""")
"inline"：要求行内描述使用单引号 ("...")。

¥"inline": Requires single-quoted inline descriptions ("...")

默认 "block"

¥Default "block"

1
{
2
  "linter": {
3
    "rules": {
4
      "nursery": {
5
        "useConsistentGraphqlDescriptions": {
6
          "options": {
7
            "style": "inline"
8
          }
9
        }
10
      }
11
    }
12
  }
13
}

1
enum EnumValue {
2
  """
3
  this is a description
4
  """
5
  DEFAULT
6
}

useConsistentGraphqlDescriptions

摘要

如何配置

描述

示例

样式：block

无效

有效

选项

style

相关链接

样式：`block`

`style`